Trails Packages
    Preparing search index...

    Function useRovingMenu

    • The roving menu is a render-less component for lists that support keyboard navigation. It implements the basics for an accessible, keyboard navigable menu using the "roving tab index" pattern.

      Items can be navigated using arrow keys and home/end keys.

      Parameters

      • props: RovingMenuProps = {}

        Properties supported when creating a new menu via useRovingMenu.

        • Optionalactive?: boolean

          Whether the menu is active. Only active menus are focusable by the user through keyboard navigation.

          Default: true

        • Optionalorientation?: "vertical" | "horizontal"

          Configures the orientation of the menu (default: horizontal).

          Horizontal menus can be navigated using left/right, vertical menus use up/down.

        • Optionalwrap?: boolean

          Wrap around when pressing an arrow key at the start or the end of the menu.

          Default: true.

      Returns RovingMenuResult

    Settings

    Member Visibility