Options
All
  • Public
  • Public/Protected
  • All
Menu

Option values used with IFocusOnReadingPositionTargetOptions.target

Index

Enumeration Members

NEAREST_CHARACTER: "NEAREST_CHARACTER"

Focuses as close as possible to the reading position. If the reading position is within a text node, a temporary wrapper element is created around the nearest character to enable focus. This provides more precise focus positioning than NEAREST_ELEMENT.

NEAREST_ELEMENT: "NEAREST_ELEMENT"

Focuses on the closest element that matches the reading position. If the reading position is inside a Text node, the focus will be applied on the nearest ancestor Element or sibling Element.

NEAREST_SENTENCE: "NEAREST_SENTENCE"

Focuses on the sentence or the nearest element boundary as close as possible to the reading position. If the reading position is within a text node, a temporary wrapper element is created around the nearest sentence to enable focus. This provides more precise focus positioning than NEAREST_ELEMENT, especially useful for screen readers.

NOTE: This option relies on the Intl.Segmenter API, and for browsers that do not support it, we fall back to the NEAREST_WORD.

NEAREST_WORD: "NEAREST_WORD"

Focuses on the word as close as possible to the reading position. If the reading position is within a text node, a temporary wrapper element is created around the nearest word to enable focus. This provides more precise focus positioning than NEAREST_ELEMENT, especially useful for screen readers.

NONE: "NONE"

Disables focus at the reading position. Focus may still be applied to the page container or page body if those options are enabled.

Generated using TypeDoc