Colibrio Reader Framework API - Cloud license
    Preparing search index...

    Interface IFocusOnReadingPositionOptions

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

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

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

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

    interface IFocusOnReadingPositionOptions {
        focusNearContentLocation?: boolean;
        focusOnPageBodyElement?: boolean;
        focusOnPageContainer?: boolean;
        focusTargetOptions?: IFocusOnReadingPositionTargetOptions;
    }

    Properties

    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.

    2

    since 5.0.0. Please use focusTargetOptions.target instead.

    false
    focusOnPageBodyElement?: boolean

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

    1

    false
    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.

    0

    false
    focusTargetOptions?: IFocusOnReadingPositionTargetOptions

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

    3

    IFocusOnReadingPositionTargetOptions
    Properties