Trails Packages
    Preparing search index...

    Function useNestedRovingMenu

    • Like useRovingMenu, but suitable for nested menus.

      Only a single level of nested is supported at this time (i.e. horizontal in vertical, or the other way around).

      Parameters

      • props: NestedRovingMenuProps

        Properties supported when creating a new nested menu via useNestedRovingMenu.

        • 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.

        • value: string

          The value of the menu within its parent menu.

        • Optionalwrap?: boolean

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

          Default: true.

      Returns NestedRovingMenuResult

    Settings

    Member Visibility