Status: Developer Preview
Defines a dashboard widget that can be added to the dashboard.
stringA unique identifier for the widget.
stringThe display name of the widget.
React.ComponentType<DashboardBaseWidgetProps>The React component that renders the widget.
{ w: number; h: number; x?: number; y?: number }The default size and position of the widget.
{ w: number; h: number }The minimum size constraints for the widget.
{ w: number; h: number }The maximum size constraints for the widget.
string[]If set, the widget will only be displayed if the current user has at least one of the specified permissions in the active channel.
If not set, the widget will be visible to all users.
Record<string, unknown>v3.8.0Default configuration values for the widget. The effective config seen by the widget is this object merged with any per-instance overrides that the user has persisted. Widgets read and write their config via the useWidgetConfig hook.
booleanv3.8.0falseIf set to true, the widget can be added to the Insights page multiple times.
Each instance keeps its own independent layout and useWidgetConfig state,
and the "Add widget" picker offers the widget even when an instance is already
on the page. When false (the default), the widget can appear at most once and
removing it simply hides it until re-added.
Architecture reviews, custom plugin work, migrations, ongoing support. Get a hand from the team that builds Vendure.