Developers
Start building
Themes/Theme SDK/Modules/navigation/Types: MegaMenuProps to NavProductsProps

Types: MegaMenuProps to NavProductsProps

The types of @poltura/theme-sdk/navigation, MegaMenuProps to NavProductsProps.

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

MegaMenuProps

Props of MegaMenu.

labelstring

The button's text; defaults to the store's wording for all categories.

openOn'hover' | 'click'

Whether the panel opens on hover or on click; defaults to hover.

classNamestring

Classes added to the menu.

CategoryNavProps

Props of CategoryNav.

openOn'hover' | 'click'

Whether a category's subcategories open on hover or on click; defaults to hover.

classNamestring

Classes added to the bar.

Class names for the pieces of MenuColumns.

columnstring

Each column.

headingstring

Each column's heading.

liststring

Each column's list.

linkstring

Each link.

Props of MenuColumns.

columnsrequiredreadonly MenuColumn[]

The columns, in order.

classNamestring

Classes added to the grid.

classesMenuColumnsClasses

Classes added to the pieces.

Props of Breadcrumbs.

itemsrequiredreadonly BreadcrumbItem[]

The steps from the top down; the last one without a link is the current page.

separator'chevron' | 'slash'

The mark between the steps; defaults to a chevron.

classNamestring

Classes added to the trail.

Which products a navigation panel shows.

type NavProductsBy = {
    readonly categoryId: string;
    readonly limit?: number;
} | {
    readonly handles: readonly string[];
}

Class names for the pieces of NavProducts.

rootstring

The panel.

headingstring

The heading.

rowstring

Each product row.

thumbFramestring | null

The frame around a thumbnail; null draws the thumbnail bare.

thumbstring

The thumbnail.

titlestring

Each product's title.

Props of NavProducts.

byrequiredNavProductsBy

Which products to show.

headingstring

A heading over the rows; none by default.

classesNavProductsClasses

Classes added to the pieces.

Last updated