Localizable
Mixin

Mixin that provides localization functionality to a class.

// Get localized string
grid.L('foo');
grid.L('L{foo}');

Useful functions

Function	Description
L	Returns the localized string for the given key
optionalL	Returns localized string or the raw value if not found

Configs

Configs are options you supply in a configuration object when creating an instance of this class

localeClass : Base

ADVANCED

A class translations of which are used for translating this entity. This is often used when translations of an item are defined on its container class. For example:

// Toolbar class that has some predefined items
class MyToolbar extends Toolbar {

    static $name = 'MyToolbar';

    static configurable = {
        // this specifies default configs for the items
        defaults : {
            // will tell items to use the toolbar locale
            localeClass : this
        },

        items : {
            // The toolbar has 2 buttons and translation for their texts will be searched in
            // the toolbar locales
            agree :{ text : 'Agree' },
            disagree :{ text : 'Disagree' }
        }
    };

   ...
}

So if one makes a locale for the MyToolbar class that will include Agree and Disagree string translations:

    ...
    MyToolbar : {
        Agree    : 'Yes, I agree',
        Disagree : 'No, I do not agree'
    }

They will be used for the toolbar buttons and the button captions will say Yes, I agree and No, I do not agree.

localizable : Booleantrue

ADVANCED

Set to false to disable localization of this object.
localizableProperties : String[]

ADVANCED
List of properties which values should be translated automatically upon a locale applying. In case there is a need to localize not typical value (not a String value or a field with re-defined setter/getter), you could use 'localeKey' meta configuration. Example:
```
 static configurable = {
      localizableProperties : ['width'],

      width : {
          value   : '54em', // default value here
          $config : {
              localeKey : 'L{editorWidth}' // name of the property that will be used in localization file
          }
      }
  };
```

Properties

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

isLocalizable : Booleantrue

READONLY

static

ADVANCED

Identifies an object as an instance of Localizable class, or subclass thereof.

isLocalizable : Booleantrue

READONLY

ADVANCED

Identifies an object as an instance of Localizable class, or subclass thereof.
localeHelper : LocaleHelper

READONLY

ADVANCED

Get the global LocaleHelper
localeManager : LocaleManager

READONLY

ADVANCED

Get the global LocaleManager

Functions

Functions are methods available for calling on the class

L( text, templateData )

: String

static

ADVANCED

Get localized string, returns value of text if no localized string found.

If throwOnMissingLocale is true then calls to L() will throw Localization is not found for 'text' in 'ClassName' exception when no localization is found.

// Simple localization
const someText = SomeClass.L('L{text}');

// With template data
const someText = SomeClass.L('L{template}', { count : 5 }); // Number in object
const someText = SomeClass.L('L{template}', { name : 'John' }); // String in object
const someText = SomeClass.L('L{template}', 'John'); // Strings parameter

localize( text, templateData )

: String

internal

static

Get localized string, returns null if no localized string found.

// Simple localization
const someText = SomeClass.localize('L{text}');

// With template data
const someText = SomeClass.localize('L{template}', { count : 5 }); // Number in object
const someText = SomeClass.localize('L{template}', { name : 'John' }); // String in object
const someText = SomeClass.localize('L{template}', 'John'); // Strings parameter

optionalL( text, templateData )

: String

static

ADVANCED

Localization function to get an optional translation. The difference compared to L() is that it won't throw an error when the translation is missing even if configured with throwOnMissingLocale

// Simple localization
const someText = someClass.optionalL('L{text}');

// With template data
const someText = SomeClass.optionalL('L{template}', { count : 5 }); // Number in object
const someText = SomeClass.optionalL('L{template}', { name : 'John' }); // String in object
const someText = SomeClass.optionalL('L{template}', 'John'); // Strings parameter

L( text, templateData )

: String

ADVANCED

Localization function on the class instance that mixes Localizable.

// Simple localization
const someText = someClass.L('L{text}');

// With template data
const someText = someClass.L('L{template}', { count : 5 }); // Number in object
const someText = someClass.L('L{template}', { name : 'John' }); // String in object
const someText = someClass.L('L{template}', 'John'); // Strings parameter

optionalL( text, templateData, preventThrowfalse )

: String

internal

Localization function to get an optional translation. The difference compared to L() is that it won't throw an error when the translation is missing even if configured with throwOnMissingLocale.

button.text = grid.optionalL('L{text}');

// With template data
const someText = someClass.optionalL('L{template}', { count : 5 }); // Number in object
const someText = someClass.optionalL('L{template}', { name : 'John' }); // String in object
const someText = someClass.optionalL('L{template}', 'John'); // Strings parameter

updateLocalization( )

ADVANCED

Method that is triggered when applying a locale to the instance (happens on the instance construction steps and when switching to another locale).

The method can be overridden to dynamically translate the instance when locale is switched. When overriding the method please make sure you call super.updateLocalization().

Source path

Core/localization/Localizable.js

Inheritance tree1

Localizable

Localizable
Mixin

Useful functions

See also

Configs

Properties

Functions

Source path

Inheritance tree1

Contents

Localizable Mixin

Useful functions

See also

Configs

Properties

Functions

Source path

Inheritance tree1

Contents

Localizable
Mixin