Navigation Edit

This feature is still experimental. “Experimental” means this is an early implementation subject to drastic and breaking changes.

Render a navigation list with optional groupings and hierarchy.

Usage Usage

import {
    __experimentalNavigation as Navigation,
    __experimentalNavigationGroup as NavigationGroup,
    __experimentalNavigationItem as NavigationItem,
    __experimentalNavigationMenu as NavigationMenu,
} from '@wordpress/components';

const MyNavigation = () => (
    <Navigation>
        <NavigationMenu title="Home">
            <NavigationGroup title="Group 1">
                <NavigationItem item="item-1" title="Item 1" />
                <NavigationItem item="item-2" title="Item 2" />
            </NavigationGroup>
            <NavigationGroup title="Group 2">
                <NavigationItem
                    item="item-3"
                    navigateToMenu="category"
                    title="Category"
                />
            </NavigationGroup>
        </NavigationMenu>

        <NavigationMenu
            backButtonLabel="Home"
            menu="category"
            parentMenu="root"
            title="Category"
        >
            <NavigationItem badge="1" item="child-1" title="Child 1" />
            <NavigationItem item="child-2" title="Child 2" />
        </NavigationMenu>
    </Navigation>
);

Top ↑

Navigation supports the following props.

Top ↑

activeItem activeItem

  • Type: string
  • Required: No

The active item slug.

Top ↑

activeMenu activeMenu

  • Type: string
  • Required: No
  • Default: “root”

The active menu slug.

Top ↑

className className

  • Type: string
  • Required: No

Optional className for the Navigation component.

Top ↑

onActivateMenu onActivateMenu

  • Type: function
  • Required: No

Sync the active menu between the external state and the Navigation’s internal state.

Top ↑

NavigationMenu supports the following props.

Top ↑

backButtonLabel backButtonLabel

  • Type: string
  • Required: No
  • Default: parent menu’s title or “Back”

The back button label used in nested menus. If not provided, the label will be inferred from the parent menu’s title.
If for some reason the parent menu’s title is not available then it will default to “Back”.

Top ↑

onBackButtonClick onBackButtonClick

  • Type: function
  • Required: No

A callback to handle clicking on the back button. If this prop is provided then the back button will be shown.

Top ↑

className className

  • Type: string
  • Required: No

Optional className for the NavigationMenu component.

Top ↑

hasSearch hasSearch

  • Type: boolean
  • Required: No

Enable the search feature on the menu title.

Top ↑

  • Type: string
  • Required: No
  • Default: “root”

The unique identifier of the menu. The root menu can omit this, and it will default to “root”; all other menus need to specify it.

Top ↑

onSearch onSearch

  • Type: function
  • Required: No

When hasSearch is active, this function handles the search input’s onChange event, making it controlled from the outside. It requires setting the search prop as well.

Top ↑

isSearchDebouncing isSearchDebouncing

  • Type: boolean
  • Required: No

Indicates whether the search is debouncing or not. In case of true the “No results found.” text is omitted. Used to prevent showing “No results found.” text between debounced searches.

Top ↑

parentMenu parentMenu

  • Type: string
  • Required: No

The parent menu slug; used by nested menus to indicate their parent menu.

Top ↑

  • Type: string
  • Required: No

When hasSearch is active and onSearch is provided, this controls the value of the search input. Required when the onSearch prop is provided.

Top ↑

isEmpty isEmpty

  • Type: boolean
  • Required: No

Indicates whether the menu is empty or not. Used together with the hideIfTargetMenuEmpty prop of Navigation Item.

Top ↑

title title

  • Type: string
  • Required: No

The menu title. It’s also the field used by the menu search function.

Top ↑

NavigationGroup supports the following props.

Top ↑

className className

  • Type: string
  • Required: No

Optional className for the NavigationGroup component.

Top ↑

title title

  • Type: string
  • Required: No

The group title.

Top ↑

NavigationItem supports the following props.

Top ↑

badge badge

  • Type: string|Number
  • Required: No

The item badge content.

Top ↑

className className

  • Type: string
  • Required: No

Optional className for the NavigationItem component.

Top ↑

href href

  • Type: string
  • Required: No

If provided, renders a instead of button.

Top ↑

item item

  • Type: string
  • Required: No

The unique identifier of the item.

Top ↑

  • Type: string
  • Required: No

The child menu slug. If provided, clicking on the item will navigate to the target menu.

Top ↑

hideIfTargetMenuEmpty hideIfTargetMenuEmpty

  • Type: boolean
  • Required: No

Indicates whether this item should be hidden if the menu specified in navigateToMenu is marked as empty in the isEmpty prop. Used together with the isEmpty prop of Navigation Menu.

Top ↑

onClick onClick

  • Type: function
  • Required: No

A callback to handle clicking on a menu item.

Top ↑

isText isText

  • Type: boolean
  • Required: No
  • Default: false

If set to true then the menu item will only act as a text-only item rather than a button.

Top ↑

title title

  • Type: string
  • Required: No

The item title.