NavMenuSection

Package: @vendure/admin-ui File: nav-builder-types.ts

A NavMenuSection is a grouping of links in the main (left-hand side) nav bar.

Signature

interface NavMenuSection {
  id: string;
  label: string;
  items: NavMenuItem[];
  icon?: string;
  displayMode?: 'regular' | 'settings';
  requiresPermission?: string | ((userPermissions: string[]) => boolean);
  collapsible?: boolean;
  collapsedByDefault?: boolean;
}

Members

id

property

type:

string

label

property

type:

string

items

property

type:

NavMenuItem[]

icon

property

type:

string

displayMode

property

type:

'regular' | 'settings'

requiresPermission

property

type:

string | ((userPermissions: string[]) => boolean)

Control the display of this item based on the user permissions.

collapsible

property

type:

boolean

collapsedByDefault

property

type:

boolean

Contents