🚨 Announcing Vendure v2 Beta

ActionBarItem

ActionBarItem

A button in the ActionBar area at the top of one of the list or detail views.

Signature

interface ActionBarItem {
  id: string;
  label: string;
  locationId: ActionBarLocationId;
  disabled?: Observable<boolean>;
  onClick?: (event: MouseEvent, context: OnClickContext) => void;
  routerLink?: RouterLinkDefinition;
  buttonColor?: 'primary' | 'success' | 'warning';
  buttonStyle?: 'solid' | 'outline' | 'link';
  icon?: string;
  requiresPermission?: string;
}

Members

id

property
type:
string

label

property
type:
string

locationId

property

disabled

property
type:
Observable<boolean>

onClick

property
type:
(event: MouseEvent, context: OnClickContext) => void
property
type:
RouterLinkDefinition

buttonColor

property
type:
'primary' | 'success' | 'warning'

buttonStyle

property
type:
'solid' | 'outline' | 'link'

icon

property
type:
string

requiresPermission

property
type:
string