AdminUiOptions

AdminUiOptions

AdminUiOptions

Configuration options for the AdminUiPlugin.

Signature

interface AdminUiOptions {
  hostname?: string;
  port: number;
  apiHost?: string | 'auto';
  apiPort?: number | 'auto';
  extensions?: AdminUiExtension[];
  watch?: boolean;
}

Members

hostname

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

port

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

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

extensions

property
An optional array of objects which configure extension Angular modules to be compiled into and made available by the AdminUi application.

watch

property
type:
boolean
default:
false
Set to true in order to run the Admin UI in development mode (using the Angular CLI ng serve command). When in watch mode, any changes to UI extension files will be watched and trigger a rebuild of the Admin UI with live reloading.