Skip to main content

Navigation

DashboardNavSectionDefinition​

@vendure/dashboardnavigation.ts
v3.4.0

Defines a custom navigation section in the dashboard sidebar.

Individual items can then be added to the section by defining routes in the routes property of your Dashboard extension.

Signature
interface DashboardNavSectionDefinition {
    id: string;
    title: string;
    icon?: LucideIcon;
    order?: number;
}

id​

property
string

A unique identifier for the navigation section.

title​

property
string

The display title for the navigation section.

icon​

property
LucideIcon

Optional icon to display next to the section title. The icons should be imported from 'lucide-react'.

Example

import { PlusIcon } from 'lucide-react';

order​

property
number

Optional order number to control the position of this section in the sidebar.

@vendure/dashboardnav-menu-extensions.ts
v3.4.0

The base configuration for navigation items and sections of the main app nav bar.

Signature
interface NavMenuBaseItem {
    id: string;
    title: string;
    icon?: LucideIcon;
    order?: number;
    placement?: NavMenuSectionPlacement;
    requiresPermission?: string | string[];
}

id​

property
string

title​

property
string

icon​

property
LucideIcon

order​

property
number

placement​

property
NavMenuSectionPlacement

requiresPermission​

property
string | string[]

This can be used to restrict the menu item to the given permission or permissions.

@vendure/dashboardnav-menu-extensions.ts
v3.4.0

Defines an items in the navigation menu.

Signature
interface NavMenuItem extends NavMenuBaseItem {
    url: string;
}

url​

property
string

The url of the route which this nav item links to.