@lexical/react/dist/useLexicalRovingTabIndexRef.d.ts

This package provides Lexical components and hooks for React applications.

/**
 * Copyright (c) Meta Platforms, Inc. and affiliates.
 *
 * This source code is licensed under the MIT license found in the
 * LICENSE file in the root directory of this source tree.
 *
 */
import { type RovingTabIndexOptions } from '@lexical/a11y';
import { type RefCallback } from 'react';
export type { RovingOrientation, RovingTabIndexOptions } from '@lexical/a11y';
/**
 * Returns a `RefCallback` that registers the attached DOM element as a
 * roving-tabindex container with {@link RovingTabIndexExtension}, and
 * releases it when the element detaches.
 *
 * ```tsx
 * const rovingRef = useLexicalRovingTabIndexRef();
 * return <div ref={rovingRef} role="toolbar">…</div>;
 * ```
 *
 * Multiple elements can use this hook simultaneously — each gets its
 * own independent roving group.
 *
 * Requires `RovingTabIndexExtension` in the editor's extension tree.
 */
export declare function useLexicalRovingTabIndexRef(options?: RovingTabIndexOptions): RefCallback<HTMLElement>;