Skip to main content

DashboardExtension

DashboardExtension

Status: Developer Preview

This is used to define the routes, widgets, etc. that will be displayed in the dashboard.

Signature
interface DashboardExtension {
routes?: DashboardRouteDefinition[];
navSections?: DashboardNavSectionDefinition[];
pageBlocks?: DashboardPageBlockDefinition[];
actionBarItems?: DashboardActionBarItem[];
alerts?: DashboardAlertDefinition[];
widgets?: DashboardWidgetDefinition[];
customFormComponents?: DashboardCustomFormComponents;
dataTables?: DashboardDataTableExtensionDefinition[];
detailForms?: DashboardDetailFormExtensionDefinition[];
login?: DashboardLoginExtensions;
}

routes

Allows you to define custom routes such as list or detail views.

Allows you to define custom nav sections for the dashboard.

pageBlocks

Allows you to define custom page blocks for any page in the dashboard.

actionBarItems

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

alerts

Allows you to define custom alerts that can be displayed in the dashboard.

widgets

Allows you to define custom routes for the dashboard, which will render the given components and optionally also add a nav menu item.

customFormComponents

Unified registration for custom form custom field components.

dataTables

Allows you to customize aspects of existing data tables in the dashboard.

detailForms

Allows you to customize the detail form for any page in the dashboard.

login

Allows you to customize the login page with custom components.