superset/superset-frontend/temporary_superset_ui/superset-ui/packages/superset-ui-translation
Krist Wongsuphasawat 4e0d2c1dae v0.5.0
2021-11-26 11:44:33 +08:00
..
src Merge pull request #16 from apache-superset/kristw--wran 2021-11-26 11:44:32 +08:00
test Merge pull request #16 from apache-superset/kristw--wran 2021-11-26 11:44:32 +08:00
package.json v0.5.0 2021-11-26 11:44:33 +08:00
README.md add badges 2021-11-26 11:44:32 +08:00

@superset-ui/translation

Version David (path)

i18n locales and translation for Superset

SupersetTranslation

Example usage

import { configure, t, tn } from '@superset-ui/translation';

configure({
  languagePack: {...},
});

console.log(t('text to be translated'));
console.log(tn('singular text', 'plural text', value));

API

configure({ [languagePack] })

  • Initialize the translator
  • Initialize with the default language if no languagePack is specified.

t(text[, args])

  • Translate text.
  • If args is provided, substitute args into the sprintf placeholders specified within text translation.

For example

t('Hello %(name)s', user);

See sprintf-js for more details on how to define placeholders.

tn(singular, plural, num, [, args])

  • Translate and choose between singular and plural based on num.
  • If args is provided, substitute args into the sprintf placeholders specified within singular or plural translations.

For example

tn('%d duck', '%d ducks', 2, 2);

Development

@data-ui/build-config is used to manage the build configuration for this package including babel builds, jest testing, eslint, and prettier.