Skip to main content

DashboardPluginOptions

DashboardPluginOptions​

@vendure/dashboarddashboard.plugin.ts

Configuration options for the DashboardPlugin.

Signature
interface DashboardPluginOptions {
    route: string;
    appDir: string;
}

route​

property
string
default:
'dashboard'

The route to the Dashboard UI.

appDir​

property
string

The path to the dashboard UI app dist directory. By default, the built-in dashboard UI will be served. This can be overridden with a custom build of the dashboard.