AdminUiPluginOptions

AdminUiPluginOptions

AdminUiPluginOptions

Configuration options for the AdminUiPlugin.

Signature

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

Members

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.

apiHost

property
type:
string | 'auto'
default:
'auto'
The hostname of the Vendure server which the admin ui will be making API calls to. If set to “auto”, the admin ui app will determine the hostname from the current location (i.e. window.location.hostname).

apiPort

property
type:
number | 'auto'
default:
'auto'
The port of the Vendure server which the admin ui will be making API calls to. If set to “auto”, the admin ui app will determine the port from the current location (i.e. window.location.port).

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.