IFocusOnReadingPositionOptions | Colibrio Reader Framework API

Options related to ReaderView.focusOnReadingPosition() deciding which elements should receive focus.

When multiple properties are set, focus is applied in the following order:

Page container iframe (focusOnPageContainer)
Page body element (focusOnPageBodyElement)
Reading position element (focusTargetOptions.target)

At least one property must be set for any focus action to be performed.

Hierarchy

IFocusOnReadingPositionOptions

Index

Properties

Optional focusNearContentLocation

focusNearContentLocation?: boolean

If the element or the nearest element matching the content location should be focused.

Setting this option to true is equivalent to setting focusTargetOptions.target to NEAREST_ELEMENT. If focusTargetOptions.target is set to anything other than NONE, then this option is ignored.

nativeparamindex: 2
deprecated: since 5.0.0. Please use focusTargetOptions.target instead.
default: false

Optional focusOnPageBodyElement

focusOnPageBodyElement?: boolean

If the body element of the page content should be focused.

nativeparamindex: 1
default: false

Optional focusOnPageContainer

focusOnPageContainer?: boolean

If focus should be applied to the page container iframe, before applying focus on elements within the iframe. This is necessary on some platforms in order for accessibility technologies to detect focus() changes inside iframes. If the page container isn't an iframe, this option has no effect.

nativeparamindex: 0
default: false

Optional focusTargetOptions

focusTargetOptions?: IFocusOnReadingPositionTargetOptions

This option determines how to select a focus target when focusing on the reading position

nativeparamindex: 3
default: IFocusOnReadingPositionTargetOptions