Interface OrderedFocusOptions

Options of ordered focus movement methods from FocusControls.

interface OrderedFocusOptions {
    approveFocusCandidate?: ((element: FocusableElement) => boolean);
    isScrollPrevented?: boolean;
    sortFocusCandidates?: ((a: FocusableElement, b: FocusableElement) => number);
}

Hierarchy (view full)

Properties

approveFocusCandidate? isScrollPrevented? sortFocusCandidates?

Properties

OptionalapproveFocusCandidate

approveFocusCandidate?: ((element: FocusableElement) => boolean)

Returns true if an element is allowed to receive focus. By default, all candidates are approved.

See

OptionalisScrollPrevented

isScrollPrevented?: boolean

If true no scrolling will occur after element receives focus, otherwise the browser scrolls the document to bring the newly-focused element into view.

Default

false

OptionalsortFocusCandidates

sortFocusCandidates?: ((a: FocusableElement, b: FocusableElement) => number)

Sorts elements that are candidates to be focused. By default, elements are sorted in a document order.

See

Settings

Member Visibility

On This Page

Properties