Skip to content

Latest commit

 

History

History
191 lines (135 loc) · 4.78 KB

API.md

File metadata and controls

191 lines (135 loc) · 4.78 KB

API

$.li18n.currentLocale = locale

Set the current locale String.

Default is 'en'.

$.li18n.currentLocale = 'de';
$.li18n.translations = translations

Set the translations Object.

Default is {}.

$.li18n.translations = {en: {greeing: 'Hello %{{name}}'}};
$.li18n.fallbackLocale = locale

Set the fallback locale String.

Default is null.

$.li18n.fallbackLocale = 'en';
$.li18n.translate(key, interpolationOptions)

Translates the given key using interpolation options.

Arguments:

  • key - translation lookup key (String).
  • interpolationOptions - options for translations with interpolation (Object).

Returns:

  • translation (String) if found.
  • error message (String) if translation not found and $.li18n.onTranslationMissing is set to 'message'.
  • value from $.li18n.onTranslationMissing if translation not found and $.li18n.onTranslationMissing is set to a function.
  • throws an error if translation is not found and $.li18n.onTranslationMissing is not set.
$.li18n.translate('greeting', {name: 'Alice'});
// => 'Hello Alice!'
$.li18n.onTranslationMissing = handler

Set the handler name String to be called when a translation has not been found.

Possible values:

  • 'message'
  • 'error'

Default is null.

In case of a cumbersome value 'error' is assumed. With the 'error' a missing translation will throw an error. With the 'message' a missing translation will return an error string.

$.li18n.translations = {en: {}};
$.li18n.translate('spam');
// => Error: 'Missing translation for key "spam" and locale "en"'
$.li18n.onTranslationMissing = 'message';
// => 'Missing translation for key "spam" and locale "en"'
$.li18n.onTranslationMissing = function(key, currentLocale)

Set the handler function to be called when a translation has not been found.

Callback arguments:

  • key - translation lookup key.
  • currentLocale - is the current locale.
$.li18n.translations = {en: {}};
$.li18n.onTranslationMissing = function(key, currentLocale) {
  if (currentLocale === 'de') {
    return 'Übersetzung für Schlüssel "' + key + '" fehlt';
  } else {
    return 'Missing translation for key "' + key + '" is missing';
  }
};

$.li18n.currentLocale = 'en'
$.li18n.translate('spam');
// => 'Missing translation for key "spam" is missing'

$.li18n.currentLocale = 'de'
$.li18n.translate('spam');
// => 'Übersetzung für Schlüssel "spam" fehlt'
$.li18n._localize = function(object, format, currentLocale, localizationKey, options)

Set the localize function. This function will be called to do the actual localization, when the function $.li18n.localize is called.

Default is null.

Callback arguments:

  • object - is the object to be localized. By default only Date objects are supported.
  • format - is the localization format for the given object.
  • currentLocale - is the current locale.
  • localizationKey - is the key under which the format for localization has been looked up. All localization keys are stored in the l10n key in the translations object. By default only Date objects have localization keys. A key of a Date object is date.
  • options - are the options provided to the function $.li18n.localize.
$.li18n.translations = {en: {l10n: {date: 'LL'}}};
$.li18n._localize = function(object, format, currentLocale) {
  return moment(object).lang(currentLocale).format(format);
};
$.li18n.localize(new Date('1971.01.0.1'));
// => 'January 1 1971'
$.li18n.localize(object, options)

Localize the given object using options. When this function is called, the format localization format is looked up and the function $.li18n._localize is called with the object and the looked up format is called.

Arguments:

  • object - is the object to be localized.
  • options - are the options provided to the function $.li18n.localize.
$.li18n.translations = {en: {l10n: {date: 'LL'}}};
$.li18n._localize = function(object, format, currentLocale) {
  return moment(object).lang(currentLocale).format(format);
};
$.li18n.localize(new Date('1971.01.0.1'));
// => 'January 1 1971'
$.li18n.reset()

Reset the library to defaults.

$.li18n.translations = {de: {}};
$.li18n.currentLocale = 'de';
$.li18n.fallbackLocale = 'fr';
$.li18n.onTranslationMissing = 'message';
$.li18n._localize = function() {};

$.li18n.reset();

$.li18n.translations // => {}
$.li18n.currentLocale // => 'en'
$.li18n.fallbackLocale // => null
$.li18n.onTranslationMissing // => null
$.li18n._localize // => null
$.li18n.version

Return current library version string.

$.li18n.version // => 'X.Y.Z'