React Hookers - v6.3.0
    Preparing search index...

    Interface OrderedFocusOptions

    Options for ordered focus movement methods from FocusControls.

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

    Hierarchy (View Summary)

    Index

    Properties

    approveFocusCandidate? isScrollPrevented? sortFocusCandidates?

    Properties

    approveFocusCandidate?: (element: FocusableElement) => boolean

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

    isScrollPrevented?: boolean

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

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

    Sorts candidate elements. By default, elements are sorted in document order.

    Settings

    Member Visibility

    On This Page

    Properties