LocaleHelper

Thin class which provides locale management methods. Class doesn't import other API classes and can be used separately for publishing locales before importing product classes.

Locale should be published with publishLocale method before it is available for localizing of Bryntum API classes and widgets.

Example:

LocaleHelper.publishLocale({
    localeName : 'En',
    localeDesc : 'English (US)',
    localeCode : 'en-US',
    ... (localization key:value pairs)
});

or for asynchronous loading from remote path on applying locale

LocaleHelper.publishLocale({
    localeName : 'En',
    localeDesc : 'English (US)',
    localeCode : 'en-US',
    localePath : 'https://my-server/localization/en.js'
});

No results

Properties

Properties are getters/setters or publicly accessible variables on this class

locale : Locales

READONLY

static

Get current locale config specified by localeName. If no current locale specified, returns default En locale or first published locale or empty locale object if no published locales found.
localeName : String

static

Get/set current locale name. Defaults to "En"
locales : Locales

READONLY

static
Get/set currently published locales. Returns an object with locales.

Example:
```
const englishLocale = LocaleHelper.locales.En;
```
englishLocale contains Locale object.

Functions

Functions are methods available for calling on the class

mergeLocales( ...locales )
: Object

static

Merges all properties of provided locale objects into new locale object. Locales are merged in order they provided and locales which go later replace same properties of previous locales.

normalizeLocale( nameOrConfig, config )

: Locale

internal

static

Normalizes locale object to Locale type.

Supported configs:

LocaleHelper.normalizeLocale({
    localeName : 'En',
    localeDesc : 'English (US)',
    localeCode : 'en-US',
    ... (localization key:value pairs)
});

and for backward compatibility

LocaleHelper.normalizeLocale('En', {
    name : 'En',
    desc : 'English (US)',
    code : 'en-US',
    locale : {
        ... (localization key:value pairs)
    }
});

publishLocale( nameOrConfig, config )

: Locale

static

Publishes a locale to make it available for applying. Published locales are available in locales.

Recommended usage:

LocaleHelper.publishLocale({
    localeName : 'En',
    localeDesc : 'English (US)',
    localeCode : 'en-US',
    ... (localization key:value pairs)
});

for backward compatibility (prior to 5.3.0 version):

LocaleHelper.publishLocale('En', {
    name : 'En',
    desc : 'English (US)',
    code : 'en-US',
    locale : {
        ... (localization key:value pairs)
    }
});

Publishing a locale will automatically merge it's localization keys with existing locale matching by locale name, replacing existing one with new. To replace existing locale entirely pass true to optional config parameter.

Example:

LocaleHelper.publishLocale({
    localeName : 'En',
    localeDesc : 'English (US)',
    localeCode : 'en-US',
    ... (localization key:value pairs)
}, true);

trimLocale( locale, toTrim )

static

Removes all properties from locale that are present in the provided toTrim.

Type definitions

LocaleKeys
Object which contains key: value localization pairs. Key value may have String, Function, LocaleKeys or Object type.

Example:
```
{
    title   : 'Title',
    count   : number => `Count is ${number}`,
    MyClass : {
       foo : 'bar'
    }
}
```
Properties
- key : String/Function/LocaleKeys/Object
  
  localization key
Locale : LocaleKeys
Locale configuration object which contains locale properties alongside with localization pairs.

Example:
```
 {
    localeName : 'En',
    localeDesc : 'English (US)',
    localeCode : 'en-US',
    ... (localization key:value pairs)
}
```
Properties
- localeName : String
  
  Locale name. For example: "En"
- localeDesc : String
  
  Locale description to be shown in locale picker list. For example: "English (US)"
- localeCode : String
  
  Locale code. Two letter locale code or two letter locale and two letter country code. For example: 'en' or 'en_US'
- localePath : String
  
  Locale path for asynchronous loading using AjaxHelper get request
Locales
Object which contains locales. Each object key represents published locale by its localeName.

Example:
```
// This returns English locale.
const englishLocale = LocaleHelper.locales.En;
```
Properties
- key : Locale
  
  localization object

Source path

Core/localization/LocaleHelper.js

Inheritance tree1

LocaleHelper

LocaleHelper

Properties

Functions

Type definitions

Properties

Properties

Properties

Source path

Inheritance tree1

Contents