# navigation (/themes/sdk/reference/navigation) ```ts import { … } from '@poltura/theme-sdk/navigation'; ``` ## [Hooks](/themes/sdk/reference/navigation/hooks) [#hooks] | Name | What it is | | --- | --- | | [`useMenu`](/themes/sdk/reference/navigation/hooks#usemenu) | A store menu with the links its categories and pages stand for already filled in. | | [`useNavData`](/themes/sdk/reference/navigation/hooks#usenavdata) | The store's category tree and site pages, for menus a theme builds itself. | | [`useMegaMenu`](/themes/sdk/reference/navigation/hooks#usemegamenu) | One menu item's dropdown or mega panel: its open state and the props that give it the menu keyboard model. | | [`useNavProducts`](/themes/sdk/reference/navigation/hooks#usenavproducts) | The products a navigation panel shows: a category's most popular ones or a hand-picked list. | ## [Parts](/themes/sdk/reference/navigation/parts) [#parts] | Name | What it is | | --- | --- | | [`NavMenu`](/themes/sdk/reference/navigation/parts#navmenu) | One menu item with a panel, where the theme draws the trigger and the panel and the part wires them. | | [`MenuColumns`](/themes/sdk/reference/navigation/parts#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`](/themes/sdk/reference/navigation/parts#breadcrumbs) | A breadcrumb trail with the current page marked for assistive technology; nothing when it has no steps. | | [`NavProducts`](/themes/sdk/reference/navigation/parts#navproducts) | A heading over product rows with a thumbnail and title each, for a menu panel; nothing while there is nothing to show. | ## [Defaults](/themes/sdk/reference/navigation/defaults-1) [#defaults] | Name | What it is | | --- | --- | | [`MainNav`](/themes/sdk/reference/navigation/defaults-1#mainnav) | The header's menu bar: the top-level links with their dropdowns or panels and the menu keyboard model. | | [`MobileNav`](/themes/sdk/reference/navigation/defaults-2#mobilenav) | The main menu as a stacked list whose items fold open to their children, for a mobile drawer. | | [`MegaMenu`](/themes/sdk/reference/navigation/defaults-3#megamenu) | The all-categories button with a two-pane panel: the top-level categories, and the subcategories of the one pointed at. | | [`CategoryNav`](/themes/sdk/reference/navigation/defaults-4#categorynav) | A bar of the top-level categories, each with its subcategories in a dropdown and the current one marked. | ## [Functions](/themes/sdk/reference/navigation/functions) [#functions] | Name | What it is | | --- | --- | | [`findCategory`](/themes/sdk/reference/navigation/functions#findcategory) | Finds a category of the navigation tree by its id or by the path of its handles. | ## [Constants](/themes/sdk/reference/navigation/constants) [#constants] | Name | What it is | | --- | --- | | [`MENU_MAX_CHILDREN`](/themes/sdk/reference/navigation/constants#menu_max_children) | The most links a menu item holds under it. | ## [Types](/themes/sdk/reference/navigation/types-1) [#types] | Name | What it is | | --- | --- | | [`BreadcrumbItem`](/themes/sdk/reference/navigation/types-1#breadcrumbitem) | One step of a breadcrumb trail. | | [`MegaMenuPanelProps`](/themes/sdk/reference/navigation/types-1#megamenupanelprops) | Props a mega menu spreads on its panel. | | [`MegaMenuRootProps`](/themes/sdk/reference/navigation/types-1#megamenurootprops) | Props a mega menu spreads on its root element. | | [`MegaMenuState`](/themes/sdk/reference/navigation/types-1#megamenustate) | One mega menu item's panel: whether it is open, the actions and the props that wire its keyboard model. | | [`MegaMenuTriggerProps`](/themes/sdk/reference/navigation/types-1#megamenutriggerprops) | Props a mega menu spreads on the link or button that opens its panel. | | [`MenuColumn`](/themes/sdk/reference/navigation/types-1#menucolumn) | A titled column of links, such as one column of the footer. | | [`MenuHandle`](/themes/sdk/reference/navigation/types-1#menuhandle) | A store menu: the main menu, the quick links or the legal links of the footer. | | [`MenuLink`](/themes/sdk/reference/navigation/types-1#menulink) | One link of a store menu, with the links under it. | | [`NavCategory`](/themes/sdk/reference/navigation/types-1#navcategory) | A category in the navigation tree, with its subcategories. | | [`NavData`](/themes/sdk/reference/navigation/types-1#navdata) | Everything navigation draws from: the category tree and the site's pages. | | [`NavPage`](/themes/sdk/reference/navigation/types-1#navpage) | A page of the store's site, such as About us, that menus can link to. | | [`SubmenuStyle`](/themes/sdk/reference/navigation/types-1#submenustyle) | How a menu link's children open: a dropdown list under it, or a wide panel across the header. | | [`MegaMenuOptions`](/themes/sdk/reference/navigation/types-1#megamenuoptions) | Options of [`useMegaMenu`](/themes/sdk/reference/navigation/hooks#usemegamenu). | | [`MainNavProps`](/themes/sdk/reference/navigation/types-1#mainnavprops) | Props of [`MainNav`](/themes/sdk/reference/navigation/defaults-1#mainnav). | | [`MobileNavProps`](/themes/sdk/reference/navigation/types-1#mobilenavprops) | Props of [`MobileNav`](/themes/sdk/reference/navigation/defaults-2#mobilenav). | | [`NavMenuTrigger`](/themes/sdk/reference/navigation/types-1#navmenutrigger) | What [`NavMenu`](/themes/sdk/reference/navigation/parts#navmenu) hands to its trigger renderer. | | [`NavMenuPanel`](/themes/sdk/reference/navigation/types-1#navmenupanel) | What [`NavMenu`](/themes/sdk/reference/navigation/parts#navmenu) hands to its panel renderer. | | [`NavMenuProps`](/themes/sdk/reference/navigation/types-1#navmenuprops) | Props of [`NavMenu`](/themes/sdk/reference/navigation/parts#navmenu). | | [`MegaMenuProps`](/themes/sdk/reference/navigation/types-2#megamenuprops) | Props of [`MegaMenu`](/themes/sdk/reference/navigation/defaults-3#megamenu). | | [`CategoryNavProps`](/themes/sdk/reference/navigation/types-2#categorynavprops) | Props of [`CategoryNav`](/themes/sdk/reference/navigation/defaults-4#categorynav). | | [`MenuColumnsClasses`](/themes/sdk/reference/navigation/types-2#menucolumnsclasses) | Class names for the pieces of [`MenuColumns`](/themes/sdk/reference/navigation/parts#menucolumns). | | [`MenuColumnsProps`](/themes/sdk/reference/navigation/types-2#menucolumnsprops) | Props of [`MenuColumns`](/themes/sdk/reference/navigation/parts#menucolumns). | | [`BreadcrumbsProps`](/themes/sdk/reference/navigation/types-2#breadcrumbsprops) | Props of [`Breadcrumbs`](/themes/sdk/reference/navigation/parts#breadcrumbs). | | [`NavProductsBy`](/themes/sdk/reference/navigation/types-2#navproductsby) | Which products a navigation panel shows. | | [`NavProductsClasses`](/themes/sdk/reference/navigation/types-2#navproductsclasses) | Class names for the pieces of [`NavProducts`](/themes/sdk/reference/navigation/parts#navproducts). | | [`NavProductsProps`](/themes/sdk/reference/navigation/types-2#navproductsprops) | Props of [`NavProducts`](/themes/sdk/reference/navigation/parts#navproducts). |