Skip to main content

Layout

DashboardActionBarItem​

@vendure/dashboardlayout.ts
v3.3.0

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

Signature
interface DashboardActionBarItem {
    pageId: string;
    component: React.FunctionComponent<{ context: PageContextValue }>;
    type?: 'button' | 'dropdown';
    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.

type​

property
'button' | 'dropdown'
default:
'button'

The type of action bar item to display. Defaults to button. The 'dropdown' type is used to display the action bar item as a dropdown menu item.

When using the dropdown type, use a suitable dropdown item component, such as:

import { DropdownMenuItem } from '@vendure/dashboard';

// ...

{
  component: () => <DropdownMenuItem>My Item</DropdownMenuItem>
}

requiresPermission​

property
string | string[]

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

PageBlockLocation​

@vendure/dashboardlayout.ts
v3.3.0

The location of a page block in the dashboard. The location can be found by turning on "developer mode" in the dashboard user menu (bottom left corner) and then clicking the < /> icon when hovering over a page block.

Signature
type PageBlockLocation = {
    pageId: string;
    position: PageBlockPosition;
    column: 'main' | 'side';
}

pageId​

property
string

position​

property
PageBlockPosition

column​

property
'main' | 'side'

DashboardPageBlockDefinition​

@vendure/dashboardlayout.ts
v3.3.0

This allows you to insert a custom component into a specific location on any page in the dashboard.

Signature
interface DashboardPageBlockDefinition {
    id: string;
    title?: React.ReactNode;
    location: PageBlockLocation;
    component: React.FunctionComponent<{ context: PageContextValue }>;
    requiresPermission?: string | string[];
}

id​

property
string

title​

property
React.ReactNode

location​

property
PageBlockLocation

component​

property
React.FunctionComponent<{ context: PageContextValue }>

requiresPermission​

property
string | string[]