Skip to main content

AdminUiConfig

AdminUiConfig​

@vendure/commonshared-types.ts

This interface describes JSON config file (vendure-ui-config.json) used by the Admin UI. The values are loaded at run-time by the Admin UI app, and allow core configuration to be managed without the need to re-build the application.

Signature
interface AdminUiConfig {
    apiHost: string | 'auto';
    apiPort: number | 'auto';
    adminApiPath: string;
    tokenMethod: 'cookie' | 'bearer';
    authTokenHeaderKey: string;
    channelTokenKey: string;
    defaultLanguage: LanguageCode;
    defaultLocale?: string;
    availableLanguages: LanguageCode[];
    availableLocales: string[];
    loginUrl?: string;
    brand?: string;
    hideVendureBranding?: boolean;
    hideVersion?: boolean;
    loginImageUrl?: string;
    cancellationReasons?: string[];
}

apiHost​

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

adminApiPath​

property
string
default:
'admin-api'

The path to the GraphQL Admin API.

tokenMethod​

property
'cookie' | 'bearer'
default:
'cookie'

Whether to use cookies or bearer tokens to track sessions. Should match the setting of in the server's tokenMethod config option.

authTokenHeaderKey​

property
string
default:
'vendure-auth-token'

The header used when using the 'bearer' auth method. Should match the setting of the server's authOptions.authTokenHeaderKey config option.

channelTokenKey​

property
string
default:
'vendure-token'

The name of the header which contains the channel token. Should match the setting of the server's apiOptions.channelTokenKey config option.

defaultLanguage​

property
LanguageCode
default:
LanguageCode.en

The default language for the Admin UI. Must be one of the items specified in the availableLanguages property.

defaultLocale​

property
v2.2.0
string

The default locale for the Admin UI. The locale affects the formatting of currencies & dates. Must be one of the items specified in the availableLocales property.

If not set, the browser default locale will be used.

availableLanguages​

property
LanguageCode[]

An array of languages for which translations exist for the Admin UI.

availableLocales​

property
v2.2.0
string[]

An array of locales to be used on Admin UI.

loginUrl​

property
string

If you are using an external AuthenticationStrategy for the Admin API, you can configure a custom URL for the login page with this option. On logging out or redirecting an unauthenticated user, the Admin UI app will redirect the user to this URL rather than the default username/password screen.

brand​

property
string

The custom brand name.

hideVendureBranding​

property
boolean
default:
false

Option to hide vendure branding.

hideVersion​

property
boolean
default:
false

Option to hide version.

loginImageUrl​

property
v1.9.0
string

A url of a custom image to be used on the login screen, to override the images provided by Vendure's login image server.

cancellationReasons​

property
v1.5.0
string[]
default:
['order.cancel-reason-customer-request', 'order.cancel-reason-not-available']

Allows you to provide default reasons for a refund or cancellation. This will be used in the refund/cancel dialog. The values can be literal strings (e.g. "Not in stock") or translation tokens (see Adding Admin UI Translations).