LocaleManager

Configs

throwOnMissingLocale: Boolean= falseAlso a property

Specifies if Localizable.L() function should throw error if no localization is found at runtime.

Properties

locale: Locales

Get/set currently used locale. Setter calls applyLocale.

locales: Localesreadonly

Get/set currently registered locales. Alias for LocaleHelper.locales.

throwOnMissingLocale: Boolean= falseAlso a config

Specifies if Localizable.L() function should throw error if no localization is found at runtime.

Functions

applyLocale

Applies a locale by string name or publishes new locale configuration with publishLocale and applies it. If locale is specified by string name, like 'En', it must be published before applying it.

Parameter	Type	Description
`nameOrConfig`	String \| Locale	String name of locale (for example `En` or `SvSE`) or locale object
`config`	Locale \| Boolean	Locale object. Pass `true` to reapply locale which is passed as first method parameter.

Returns: Locale | Promise -

locale object or Promise which resolves with locale object after it was loaded

Events

locale

Fires when a locale is applied

// Adding a listener using the "on" method
localeManager.on('locale', ({ source, locale, locale.oldLocaleName, locale.oldLocaleCode }) => {

});

Parameter	Type	Description
`source`	LocaleManager	The Locale manager instance.
`locale`	Locale	Locale configuration
`locale.oldLocaleName`	String	The name (eg, `'En") of the previous locale which was replaced.
`locale.oldLocaleCode`	String	The code (eg, `'en-US") of the previous locale which was replaced.

Event handlers

onLocale

Called when a locale is applied

new LocaleManager({
    onLocale({ source, locale }) {

    }
});

Parameter	Type	Description
`source`	LocaleManager	The Locale manager instance.
`locale`	Locale	Locale configuration
`locale.oldLocaleName`	String	The name (eg, `'En") of the previous locale which was replaced.
`locale.oldLocaleCode`	String	The code (eg, `'en-US") of the previous locale which was replaced.