Skip to main content

AdminUiPluginOptions

AdminUiPluginOptions

Configuration options for the AdminUiPlugin.

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

route

property
string

The route to the Admin UI.

Note: If you are using the compileUiExtensions function to compile a custom version of the Admin UI, then the route should match the baseHref option passed to that function. The default value of baseHref is /admin/, so it only needs to be changed if you set this route option to something other than "admin".

port

property
number

The port on which the server will listen. This port will be proxied by the AdminUiPlugin to the same port that the Vendure server is running on.

hostname

property
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
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.