Interface KeyboardHandlerProps

interface KeyboardHandlerProps {
    additionalKeyHandler?: ((event: KeyboardEvent) => void);
    containerRef: RefObject<any>;
    createNavigableElements: (() => Element[]);
    getFocusableElement?: ((navigableElement: Element) => Element);
    isActiveElement?: ((navigableElement: Element) => boolean);
    isEventFromContainer?: ((event: KeyboardEvent) => boolean);
    noEnterHandling?: boolean;
    noHorizontalArrowHandling?: boolean;
    noSpaceHandling?: boolean;
    noVerticalArrowHandling?: boolean;
    onlyTraverseSiblings?: boolean;
    updateTabIndex?: boolean;
    validSiblingTags?: string[];
}

Properties

additionalKeyHandler? containerRef createNavigableElements getFocusableElement? isActiveElement? isEventFromContainer? noEnterHandling? noHorizontalArrowHandling? noSpaceHandling? noVerticalArrowHandling? onlyTraverseSiblings? updateTabIndex? validSiblingTags?

Properties

OptionaladditionalKeyHandler

additionalKeyHandler?: ((event: KeyboardEvent) => void)

Additional key handling outside of the included arrow keys, enter, and space handling

containerRef

containerRef: RefObject<any>

Reference of the container to apply keyboard interaction

createNavigableElements

createNavigableElements: (() => Element[])

Callback returning an array of navigable elements to be traversable via vertical arrow keys. This array should not include non-navigable elements such as disabled elements.

OptionalgetFocusableElement

getFocusableElement?: ((navigableElement: Element) => Element)

Callback returning the focusable element of a given element from the navigable elements array

OptionalisActiveElement

isActiveElement?: ((navigableElement: Element) => boolean)

Callback to determine if a given element from the navigable elements array is the active element of the page

OptionalisEventFromContainer

isEventFromContainer?: ((event: KeyboardEvent) => boolean)

Callback to determine if a given event is from the container. By default the function conducts a basic check to see if the containerRef contains the event target

OptionalnoEnterHandling

noEnterHandling?: boolean

Flag indicating that the included enter key handling should be ignored

OptionalnoHorizontalArrowHandling

noHorizontalArrowHandling?: boolean

Flag indicating that the included horizontal arrow key handling should be ignored

OptionalnoSpaceHandling

noSpaceHandling?: boolean

Flag indicating that the included space key handling should be ignored

OptionalnoVerticalArrowHandling

noVerticalArrowHandling?: boolean

Flag indicating that the included vertical arrow key handling should be ignored

OptionalonlyTraverseSiblings

onlyTraverseSiblings?: boolean

Flag indicating that next focusable element of a horizontal movement will be this element's sibling

OptionalupdateTabIndex

updateTabIndex?: boolean

Flag indicating that the tabIndex of the currently focused element and next focused element should be updated, in the case of using a roving tabIndex

OptionalvalidSiblingTags

validSiblingTags?: string[]

Valid sibling tags that horizontal arrow handling will focus

Settings

Member Visibility

On This Page

Properties