New: Headless Commerce with Remix! read more

NavMenuItem

NavMenuItem

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>;
}

Members

id

property
type:
string

label

property
type:
string
property
type:
RouterLinkDefinition

onClick

property
type:
(event: MouseEvent) => void

icon

property
type:
string

requiresPermission

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

statusBadge

property
type:
Observable<NavMenuBadge>