Skip to main content

NavMenuItem

@vendure/admin-uinav-builder-types.ts

A NavMenuItem is a menu item in the main (left-hand side) nav bar.

Signature
interface NavMenuItem {
    id: string;
    label: string;
    routerLink: RouterLinkDefinition;
    onClick?: (event: MouseEvent) => void;
    icon?: string;
    requiresPermission?: string | ((userPermissions: string[]) => boolean);
    statusBadge?: Observable<NavMenuBadge>;
}

id​

property
string

label​

property
string
property
RouterLinkDefinition

onClick​

property
(event: MouseEvent) => void

icon​

property
string

requiresPermission​

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

statusBadge​

property
Observable<NavMenuBadge>