UI Internationalization
The @qualtrics/ui-i18n
package contains translations for the Qualtrics Design System UI component libraries.Usage
Install the package as a dependencynpm install --save @qualtrics/ui-i18n
There are various ways to import depending on the use case.
- The default includes all the languages that have been translated for the module.
```javascript
import '@qualtrics/ui-i18n';
```
- A single translation.
```javascript
import '@qualtrics/ui-i18n/dist/lang/DE.js';
```
Translation Generator
A generic translation generator has been included with this package and can be consumed by any other project to generate translations in the same way.A config file is required to use the generator.
Usage
node node_modules/@qualtrics/ui-i18n/generate --config ./path/to/i18n.config.js
Command Line Arguments
--config
: Default: i18n.config.js. Specifies the location of the config file.
Configuration
outputPath
: The location to output the generated translations.teamId
: The identifier for your team when consuming translations. See theTranslations
repo's README for more info.appId
: A unique string identifier for the application that is accessing this endpoint. See theTranslations
repo's README for more info.data
: The namespaces to consume. See theTranslations
repo's README for more info.
Example Config
i18n.config.js
module.exports = {
outputPath: 'lang',
teamId: 'cfe',
appId: 'ui-i18n',
data: ['QualtricsDesignSystemUI'],
};