AdminUiExtension

AdminUiExtension

@vendure/ui-devkittypes.ts

Defines extensions to the Admin UI application by specifying additional Angular NgModules which are compiled into the application.

See Extending the Admin UI for detailed instructions.

Signature

interface AdminUiExtension extends Partial<TranslationExtension>,
        Partial<StaticAssetExtension>,
        Partial<GlobalStylesExtension> {
    id?: string;
    extensionPath: string;
    ngModules?: Array<AdminUiExtensionSharedModule | AdminUiExtensionLazyModule>;
    providers?: string[];
    routes?: UiExtensionRouteDefinition[];
    pathAlias?: string;
    exclude?: string[];
}

• Extends: Partial<TranslationExtension>, Partial<StaticAssetExtension>, Partial<GlobalStylesExtension>

id

property

string

An optional ID for the extension module. Only used internally for generating import paths to your module. If not specified, a unique hash will be used as the id.

extensionPath

property

string

The path to the directory containing the extension module(s). The entire contents of this directory will be copied into the Admin UI app, including all TypeScript source files, html templates, scss style sheets etc.

ngModules

property

Array<AdminUiExtensionSharedModule | AdminUiExtensionLazyModule>

One or more Angular modules which extend the default Admin UI.

providers

property

string[]

Defines the paths to a file that exports an array of shared providers such as nav menu items, custom form inputs, custom detail components, action bar items, custom history entry components.

routes

property

UiExtensionRouteDefinition[]

Defines routes that will be lazy-loaded at the /extensions/ route. The filePath should point to a file relative to the extensionPath which exports an array of Angular route definitions.

pathAlias

property

string

An optional alias for the module so it can be referenced by other UI extension modules.

By default, Angular modules declared in an AdminUiExtension do not have access to code outside the directory defined by the extensionPath. A scenario in which that can be useful though is in a monorepo codebase where a common NgModule is shared across different plugins, each defined in its own package. An example can be found below - note that the main tsconfig.json also maps the target module but using a path relative to the project's root folder. The UI module is not part of the main TypeScript build task as explained in Extending the Admin UI but having paths properly configured helps with usual IDE code editing features such as code completion and quick navigation, as well as linting.

Example

packages/common-ui-module/src/ui/ui-shared.module.ts

import { NgModule } from '@angular/core';
import { SharedModule } from '@vendure/admin-ui/core';
import { CommonUiComponent } from './components/common-ui/common-ui.component';

export { CommonUiComponent };

@NgModule({
 imports: [SharedModule],
 exports: [CommonUiComponent],
 declarations: [CommonUiComponent],
})
export class CommonSharedUiModule {}

packages/common-ui-module/src/index.ts

import path from 'path';

import { AdminUiExtension } from '@vendure/ui-devkit/compiler';

export const uiExtensions: AdminUiExtension = {
  pathAlias: '@common-ui-module',     // this is the important part
  extensionPath: path.join(__dirname, 'ui'),
  ngModules: [
    {
      type: 'shared' as const,
      ngModuleFileName: 'ui-shared.module.ts',
      ngModuleName: 'CommonSharedUiModule',
    },
  ],
};

tsconfig.json

{
  "compilerOptions": {
    "baseUrl": ".",
    "paths": {
      "@common-ui-module/*": ["packages/common-ui-module/src/ui/*"]
    }
  }
}

packages/sample-plugin/src/ui/ui-extension.module.ts

import { NgModule } from '@angular/core';
import { SharedModule } from '@vendure/admin-ui/core';
// the import below works both in the context of the custom Admin UI app as well as the main project
// '@common-ui-module' is the value of "pathAlias" and 'ui-shared.module' is the file we want to reference inside "extensionPath"
import { CommonSharedUiModule, CommonUiComponent } from '@common-ui-module/ui-shared.module';

@NgModule({
  imports: [
    SharedModule,
    CommonSharedUiModule,
    RouterModule.forChild([
      {
        path: '',
        pathMatch: 'full',
        component: CommonUiComponent,
      },
    ]),
  ],
})
export class SampleUiExtensionModule {}

exclude

property

string[]

Optional array specifying filenames or glob patterns that should be skipped when copying the directory defined by extensionPath.

Example

exclude: ['**/*.spec.ts']

TranslationExtension

@vendure/ui-devkittypes.ts

Defines extensions to the Admin UI translations. Can be used as a stand-alone extension definition which only adds translations without adding new UI functionality, or as part of a full AdminUiExtension.

Signature

interface TranslationExtension {
    translations: { [languageCode in LanguageCode]?: string };
}

translations

property

{ [languageCode in LanguageCode]?: string }

Optional object defining any translation files for the Admin UI. The value should be an object with the key as a 2-character ISO 639-1 language code, and the value being a glob for any relevant translation files in JSON format.

Example

translations: {
  en: path.join(__dirname, 'translations/*.en.json'),
  de: path.join(__dirname, 'translations/*.de.json'),
}

StaticAssetExtension

@vendure/ui-devkittypes.ts

Defines extensions which copy static assets to the custom Admin UI application source asset directory.

Signature

interface StaticAssetExtension {
    staticAssets: StaticAssetDefinition[];
}

staticAssets

property

StaticAssetDefinition[]

Optional array of paths to static assets which will be copied over to the Admin UI app's /static directory.

GlobalStylesExtension

@vendure/ui-devkittypes.ts

Defines extensions which add global styles to the custom Admin UI application.

Signature

interface GlobalStylesExtension {
    globalStyles: string[] | string;
}

globalStyles

property

string[] | string

Specifies a path (or array of paths) to global style files (css or Sass) which will be incorporated into the Admin UI app global stylesheet.

SassVariableOverridesExtension

@vendure/ui-devkittypes.ts

Defines an extension which allows overriding Clarity Design System's Sass variables used in styles on the Admin UI.

Signature

interface SassVariableOverridesExtension {
    sassVariableOverrides: string;
}

sassVariableOverrides

property

string

Specifies a path to a Sass style file containing variable declarations, which will take precedence over default values defined in Clarity.

UiExtensionRouteDefinition

@vendure/ui-devkittypes.ts

Defines a route which will be added to the Admin UI application.

Signature

interface UiExtensionRouteDefinition {
    route: string;
    filePath: string;
    prefix?: string;
}

route

property

string

The name of the route. This will be used as the path in the URL.

filePath

property

string

The path to the file which exports an array of Angular route definitions.

prefix

property

v2.2.0

string

All extensions will be mounted under the /extensions/ route. This option allows you to specify a custom prefix rather than /extensions/. For example, setting this to custom would cause the extension to be mounted at /custom/<route> instead.

A common use case for this is to mount the extension at the root of the Admin UI, by setting this to an empty string. This is useful when the extension is intended to replace the default Admin UI, rather than extend it.

StaticAssetDefinition

@vendure/ui-devkittypes.ts

A static asset can be provided as a path to the asset, or as an object containing a path and a new name, which will cause the compiler to copy and then rename the asset.

Signature

type StaticAssetDefinition = string | { path: string; rename: string }

AdminUiExtensionSharedModule

@vendure/ui-devkittypes.ts

Configuration defining a single NgModule with which to extend the Admin UI.

Signature

interface AdminUiExtensionSharedModule {
    type: 'shared';
    ngModuleFileName: string;
    ngModuleName: string;
}

type

property

'shared'

Shared modules are directly imported into the main AppModule of the Admin UI and should be used to declare custom form components and define custom navigation items.

ngModuleFileName

property

string

The name of the file containing the extension module class.

ngModuleName

property

string

The name of the extension module class.

AdminUiExtensionLazyModule

@vendure/ui-devkittypes.ts

Configuration defining a single NgModule with which to extend the Admin UI.

Signature

interface AdminUiExtensionLazyModule {
    type: 'lazy';
    route: string;
    ngModuleFileName: string;
    ngModuleName: string;
}

type

property

'lazy'

Lazy modules are lazy-loaded at the /extensions/ route and should be used for modules which define new views for the Admin UI.

route

property

string

The route specifies the route at which the module will be lazy-loaded. E.g. a value of 'foo' will cause the module to lazy-load when the /extensions/foo route is activated.

ngModuleFileName

property

string

The name of the file containing the extension module class.

ngModuleName

property

string

The name of the extension module class.