@hypothesis/frontend-shared/lib/hooks/use-tab-key-navigation.d.ts

Shared components, styles and utilities for Hypothesis projects

import type { RefObject } from 'preact';
export type UseTabKeyNavigationOptions = {
    /**
     * Don't respond to any keyboard events if not enabled. This allows selective
     * enabling by components using this hook, as hook use itself cannot be
     * conditional.
     */
    enabled?: boolean;
    /**
     * CSS selector which specifies which elements should be in the tab sequence
     */
    selector?: string;
};
export declare function useTabKeyNavigation(containerRef: RefObject<HTMLElement | undefined>, { enabled, selector, }?: UseTabKeyNavigationOptions): void;