| title | isDefaultIndex | generated |
|---|---|---|
AdminUiPluginOptions |
false |
true |
import MemberInfo from '@site/src/components/MemberInfo'; import GenerationInfo from '@site/src/components/GenerationInfo'; import MemberDescription from '@site/src/components/MemberDescription';
Configuration options for the AdminUiPlugin.
interface AdminUiPluginOptions {
route: string;
port: number;
hostname?: string;
app?: AdminUiAppConfig | AdminUiAppDevModeConfig;
adminUiConfig?: Partial<AdminUiConfig>;
}<MemberInfo kind="property" type={string} />
The route to the Admin UI.
Note: If you are using the {@link 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".
<MemberInfo kind="property" type={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.
<MemberInfo kind="property" type={string} default="'localhost'" />
The hostname of the server serving the static admin ui files.
<MemberInfo kind="property" type={<a href='/reference/typescript-api/common/admin-ui/admin-ui-app-config#adminuiappconfig'>AdminUiAppConfig</a> | <a href='/reference/typescript-api/common/admin-ui/admin-ui-app-dev-mode-config#adminuiappdevmodeconfig'>AdminUiAppDevModeConfig</a>} />
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.
<MemberInfo kind="property" type={Partial<<a href='/reference/typescript-api/common/admin-ui/admin-ui-config#adminuiconfig'>AdminUiConfig</a>>} />
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.