Skip to main content

DashboardPluginOptions

DashboardPluginOptions​

@vendure/dashboarddashboard.plugin.ts

Configuration options for the DashboardPlugin.

Signature
interface DashboardPluginOptions {
    route: string;
    appDir: string;
    viteDevServerPort?: number;
}

route​

property
string
default:
'dashboard'

The route to the Dashboard UI.

appDir​

property
string

The path to the dashboard UI app dist directory.

viteDevServerPort​

property
number
default:
5173

The port on which to check for a running Vite dev server. If a Vite dev server is detected on this port, requests will be proxied to it instead of serving static files from appDir.