Class TranslationsAsI18n`Experimental`

A I18nProvider that uses Translations to manage translations.

The configuration is done using TranslationsConfig.

subject to change or removal. The I18n system may be modified in the future without prior notice.

Since

0.17.0

Implements

I18nProvider

Index

Constructors

Methods

addResource get isEnabled

Constructors

constructor

new TranslationsAsI18n(): TranslationsAsI18n
Experimental
Returns TranslationsAsI18n

Methods

addResource

addResource(
    basename?: null | string,
    language?: null | string,
    callback?: null | Function,
): void
Experimental
Load the translation file for the given basename and language.

This is mainly used by the maxGraph built-in provider to bind to Translations.add.
Parameters
- Optionalbasename: null | string
  The basename for which the file should be loaded.
- Optionallanguage: null | string
  The language for which the file should be loaded. Default is null.
- Optionalcallback: null | Function
  Optional callback for asynchronous loading. Default is null.
Returns void
Implementation of I18nProvider.addResource
- Defined in i18n/Translations.ts:405

get

get(
    key?: null | string,
    params?: null | any[],
    defaultValue?: null | string,
): null | string
Experimental
Returns the value for the specified resource key.
Parameters
- Optionalkey: null | string
  String that represents the key of the resource to be returned.
- Optionalparams: null | any[]
  Array of the values for the placeholders to be replaced with in the resulting string. The form of the placeholder is specific to each implementation.
- OptionaldefaultValue: null | string
  Optional string that specifies the default return value.
Returns null | string
Implementation of I18nProvider.get
- Defined in i18n/Translations.ts:397

isEnabled

isEnabled(): boolean
Experimental
Returns whether internationalization is enabled.

Returns boolean
Implementation of I18nProvider.isEnabled
- Defined in i18n/Translations.ts:393