Home Explore Help
Sign In
cturan
/
vendure
mirror of https://github.com/vendure-ecommerce/vendure
1
0
Fork 0
Files Issues 0 Wiki
Tree: 21ef048901
Branches Tags
vendure
/
packages
/
admin-ui
Michael Bromley 21ef048901 fix(admin-ui): Fix rich text editor when used in custom field list 3 years ago
..
e2e 38e94590dc refactor(admin-ui): Move admin-ui into packages dir 6 years ago
scripts 46d1e2d3a3 feat(ui-devkit): Support Clarity Sass variable overrides (#1684) 3 years ago
src 21ef048901 fix(admin-ui): Fix rich text editor when used in custom field list 3 years ago
.gitignore fe72c41e7c feat(admin-ui): Improved ui extension development API & architecture 5 years ago
.npmignore 1622b146d7 refactor(admin-ui): Split admin ui into library of sub-packages 5 years ago
README.md 46d1e2d3a3 feat(ui-devkit): Support Clarity Sass variable overrides (#1684) 3 years ago
angular.json a30d6399df fix(admin-ui): Remove deprecated showCircularDependencies option 4 years ago
i18n-coverage.json b43aa8113f feat(admin-ui): Implement deletion of ProductOptions via variant manager 3 years ago
package.json 09f848235f feat(admin-ui): Add basic table support to rich text editor 3 years ago
tsconfig.json 83e2056215 fix(admin-ui): Lib es2019 so ts understands array.flat (#1728) 3 years ago
tsconfig.lib.json 83e2056215 fix(admin-ui): Lib es2019 so ts understands array.flat (#1728) 3 years ago
tsconfig.lib.prod.json 5b8281d5e5 chore(admin-ui): Update to Angular v11 4 years ago
tslint.json bc35c2517b feat(admin-ui): Update Angular to v9 5 years ago

README.md

Vendure Admin UI

This is the administration interface for Vendure.

It is an Angular application built with the Angular CLI.

The UI is powered by the Clarity Design System.

Structure

Library

The Admin UI is structured as an Angular library conforming to the ng-packagr format. This library is what is published to npm as @vendure/admin-ui. The library consists of a set of modules which are accessible from consuming applications as sub-packages:

  • @vendure/admin-ui/core
  • @vendure/admin-ui/catalog
  • @vendure/admin-ui/orders

etc. These library packages are located at ./src/lib

When built with yarn build, the output will be located in the ./package sub directory. This is also the root of the published npm package.

Application

In addition to the library, there is also a full application located at ./src/app. This application is used both during development of the Admin UI, and also as the "default" Admin UI without any UI extensions, as provided as the default by the admin-ui-plugin.

Localization

Localization of UI strings is handled by ngx-translate. The translation strings should use the ICU MessageFormat.

Translation keys are automatically extracted by running:

yarn extract-translations

This scan the source files for any translation keys, and add them to each of the translation files located in ./src/lib/static/i18n-messages/.

A report is generated for each language detailing what percentage of the translation tokens are translated into that language:

Extracting translation tokens for "src\lib\static\i18n-messages\de.json"
de: 592 of 650 tokens translated (91%)

This report data is also saved to the i18n-coverage.json file.

To add support for a new language, create a new empty json file ({}) in the i18n-messages directory named <languageCode>.json, where languageCode is one of the supported codes as given in the LanguageCode enum type, then run yarn extract-translations