AdminUiPluginOptions

AdminUiPluginOptions

AdminUiPluginOptions

Configuration options for the AdminUiPlugin.

Signature

interface AdminUiPluginOptions {
  route: string;
  port: number;
  hostname?: string;
  app?: AdminUiAppConfig | AdminUiAppDevModeConfig;
  adminUiConfig?: Partial<AdminUiConfig>;
}

Members

route

property
type:
string
The route to the admin ui.

port

property
type:
number
The port on which the server will listen. If not

hostname

property
type:
string
default:
'localhost'
The hostname of the server serving the static admin ui files.

app

By default, the AdminUiPlugin comes bundles with a pre-built version of the Admin UI. This option can be used to override this default build with a different version, e.g. one pre-compiled with one or more ui extensions.

adminUiConfig

property
type:
Partial<AdminUiConfig>
Allows the contents of the vendure-ui-config.json file to be set, e.g. for specifying the Vendure GraphQL API host, available UI languages, etc.