Themes/Theme SDK/Modules/navigation

navigation

Store menus, the category and page tree, mega menu panels and breadcrumb trails.

On this page

import { … } from '@poltura/theme-sdk/navigation';

Hooks

Name	What it is
`useMenu`	A store menu with the links its categories and pages stand for already filled in.
`useNavData`	The store's category tree and site pages, for menus a theme builds itself.
`useMegaMenu`	One menu item's dropdown or mega panel: its open state and the props that give it the menu keyboard model.
`useNavProducts`	The products a navigation panel shows: a category's most popular ones or a hand-picked list.

Parts

Name	What it is
`NavMenu`	One menu item with a panel, where the theme draws the trigger and the panel and the part wires them.
`MenuColumns`	Titled columns of links in a grid of up to three, such as the footer's; a link's children follow it in the same list.
`Breadcrumbs`	A breadcrumb trail with the current page marked for assistive technology; nothing when it has no steps.
`NavProducts`	A heading over product rows with a thumbnail and title each, for a menu panel; nothing while there is nothing to show.

Defaults

Name	What it is
`MainNav`	The header's menu bar: the top-level links with their dropdowns or panels and the menu keyboard model.
`MobileNav`	The main menu as a stacked list whose items fold open to their children, for a mobile drawer.
`MegaMenu`	The all-categories button with a two-pane panel: the top-level categories, and the subcategories of the one pointed at.
`CategoryNav`	A bar of the top-level categories, each with its subcategories in a dropdown and the current one marked.

Functions

Name	What it is
`findCategory`	Finds a category of the navigation tree by its id or by the path of its handles.

Constants

Name	What it is
`MENU_MAX_CHILDREN`	The most links a menu item holds under it.

Types

Name	What it is
`BreadcrumbItem`	One step of a breadcrumb trail.
`MegaMenuPanelProps`	Props a mega menu spreads on its panel.
`MegaMenuRootProps`	Props a mega menu spreads on its root element.
`MegaMenuState`	One mega menu item's panel: whether it is open, the actions and the props that wire its keyboard model.
`MegaMenuTriggerProps`	Props a mega menu spreads on the link or button that opens its panel.
`MenuColumn`	A titled column of links, such as one column of the footer.
`MenuHandle`	A store menu: the main menu, the quick links or the legal links of the footer.
`MenuLink`	One link of a store menu, with the links under it.
`NavCategory`	A category in the navigation tree, with its subcategories.
`NavData`	Everything navigation draws from: the category tree and the site's pages.
`NavPage`	A page of the store's site, such as About us, that menus can link to.
`SubmenuStyle`	How a menu link's children open: a dropdown list under it, or a wide panel across the header.
`MegaMenuOptions`	Options of `useMegaMenu`.
`MainNavProps`	Props of `MainNav`.
`MobileNavProps`	Props of `MobileNav`.
`NavMenuTrigger`	What `NavMenu` hands to its trigger renderer.
`NavMenuPanel`	What `NavMenu` hands to its panel renderer.
`NavMenuProps`	Props of `NavMenu`.
`MegaMenuProps`	Props of `MegaMenu`.
`CategoryNavProps`	Props of `CategoryNav`.
`MenuColumnsClasses`	Class names for the pieces of `MenuColumns`.
`MenuColumnsProps`	Props of `MenuColumns`.
`BreadcrumbsProps`	Props of `Breadcrumbs`.
`NavProductsBy`	Which products a navigation panel shows.
`NavProductsClasses`	Class names for the pieces of `NavProducts`.
`NavProductsProps`	Props of `NavProducts`.

Last updated Oct 29, 2026