Skip to main content

@lexical/react/useLexicalRovingTabIndex

Functions

useLexicalRovingTabIndex()

useLexicalRovingTabIndex(containerRef, options?): void

Defined in: packages/lexical-react/src/useLexicalRovingTabIndex.ts:26

React wrapper around registerRovingTabIndex from @lexical/a11y.

Implements the WAI-ARIA roving-tabindex pattern on containerRef. One item carries tabindex="0" at a time; the rest are -1. Arrow keys move focus inside the group; Home / End jump to the ends.

See registerRovingTabIndex JSDoc for the lazy-item-query semantics.

Parameters

containerRef

RefObject<HTMLElement | null>

options?

RovingTabIndexOptions = {}

Returns

void

References

RovingOrientation

Re-exports RovingOrientation


RovingTabIndexOptions

Re-exports RovingTabIndexOptions