Skip to main content

Navigation

DashboardNavSectionDefinition​

@vendure/dashboardnavigation.ts
v3.4.0

Defines a custom navigation section in the dashboard sidebar.

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.