Skip to main content

DashboardActionBarItem

DashboardActionBarItem​

@vendure/dashboardextension-api-types.ts
v3.3.0

Status: Developer Preview

Allows you to define custom action bar items for any page in the dashboard.

Signature
interface DashboardActionBarItem {
    pageId: string;
    component: React.FunctionComponent<{ context: PageContextValue }>;
    requiresPermission?: string | string[];
}

pageId​

property
string

The ID of the page where the action bar item should be displayed.

component​

property
React.FunctionComponent<{ context: PageContextValue }>

A React component that will be rendered in the action bar.

requiresPermission​

property
string | string[]

Any permissions that are required to display this action bar item.