Skip to main content

NavMenuSection

@vendure/admin-uinav-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;
}

id​

property
string

label​

property
string

items​

property
NavMenuItem[]

icon​

property
string

displayMode​

property
'regular' | 'settings'

requiresPermission​

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

Control the display of this item based on the user permissions. Note: if you attempt to pass a PermissionDefinition object, you will get a compilation error. Instead, pass the plain string version. For example, if the permission is defined as:

export const MyPermission = new PermissionDefinition('ProductReview');

then the generated permission strings will be:

  • CreateProductReview
  • ReadProductReview
  • UpdateProductReview
  • DeleteProductReview

collapsible​

property
boolean

collapsedByDefault​

property
boolean