dashboard-plugin-options.mdx 972 B

1234567891011121314151617181920212223242526272829303132333435363738
  1. ---
  2. title: "DashboardPluginOptions"
  3. generated: true
  4. ---
  5. <GenerationInfo sourceFile="packages/dashboard/plugin/dashboard.plugin.ts" sourceLine="29" packageName="@vendure/dashboard" />
  6. Configuration options for the [DashboardPlugin](/reference/core-plugins/dashboard-plugin/#dashboardplugin).
  7. ```ts title="Signature"
  8. interface DashboardPluginOptions {
  9. route: string;
  10. appDir: string;
  11. viteDevServerPort?: number;
  12. }
  13. ```
  14. <div className="members-wrapper">
  15. ### route
  16. <MemberInfo kind="property" type={`string`} default={`'dashboard'`} />
  17. The route to the Dashboard UI.
  18. ### appDir
  19. <MemberInfo kind="property" type={`string`} />
  20. The path to the dashboard UI app dist directory.
  21. ### viteDevServerPort
  22. <MemberInfo kind="property" type={`number`} default={`5173`} />
  23. The port on which to check for a running Vite dev server.
  24. If a Vite dev server is detected on this port, requests will be proxied to it
  25. instead of serving static files from appDir.
  26. </div>