Class I18n

Handles localization. Responsible for loading localization assets and returning translations for a certain key. Can also handle plural forms. To override its default behavior define a different implementation for I18n#getText and I18n#getPluralText.

Hierarchy (View Summary)

Constructors

constructor

Accessors

assets locale

Methods

addData destroy findAvailableLocale fire getPluralText getText hasEvent off on once removeData

Constructors

constructor

Accessors

assets

  • get assets(): number[] | Asset[]

  • Gets the array of asset ids that contain localization data in the expected format.

    Returns number[] | Asset[]

  • set assets(value: number[] | Asset[]): void

  • Sets the array of asset ids or assets that contain localization data in the expected format. I18n will automatically load translations from these assets as the assets are loaded and it will also automatically unload translations if the assets get removed or unloaded at runtime.

    Parameters

    • value: number[] | Asset[]

    Returns void

locale

Methods

addData

  • addData(data: object): void

  • Adds localization data. If the locale and key for a translation already exists it will be overwritten.

    Parameters

    • data: object

      The localization data. See example for the expected format of the data.

    Returns void

    Example

    this.app.i18n.addData({
        header: {
            version: 1
        },
        data: [{
            info: {
                locale: 'en-US'
            },
            messages: {
                "key": "translation",
                // The number of plural forms depends on the locale. See the manual for more information.
                "plural_key": ["one item", "more than one items"]
            }
        }, {
            info: {
                locale: 'fr-FR'
            },
            messages: {
                // ...
            }
        }]
    });

destroy

findAvailableLocale

  • findAvailableLocale(desiredLocale: string): string

  • Returns the first available locale based on the desired locale specified. First tries to find the desired locale in the loaded translations and then tries to find an alternative locale based on the language.

    Parameters

    • desiredLocale: string

      The desired locale e.g. en-US.

    Returns string

    The locale found or if no locale is available returns the default en-US locale.

    Example

    const locale = this.app.i18n.getText('en-US');

fire

  • fire(
        name: string,
        arg1?: any,
        arg2?: any,
        arg3?: any,
        arg4?: any,
        arg5?: any,
        arg6?: any,
        arg7?: any,
        arg8?: any,
    ): EventHandler

  • Fire an event, all additional arguments are passed on to the event listener.

    Parameters

    • name: string

      Name of event to fire.

    • Optionalarg1: any

      First argument that is passed to the event handler.

    • Optionalarg2: any

      Second argument that is passed to the event handler.

    • Optionalarg3: any

      Third argument that is passed to the event handler.

    • Optionalarg4: any

      Fourth argument that is passed to the event handler.

    • Optionalarg5: any

      Fifth argument that is passed to the event handler.

    • Optionalarg6: any

      Sixth argument that is passed to the event handler.

    • Optionalarg7: any

      Seventh argument that is passed to the event handler.

    • Optionalarg8: any

      Eighth argument that is passed to the event handler.

    Returns EventHandler

    Self for chaining.

    Example

    obj.fire('test', 'This is the message');

getPluralText

  • getPluralText(key: string, n: number, locale?: string): string

  • Returns the pluralized translation for the specified key, number n and locale. If the locale is not specified it will use the current locale.

    Parameters

    • key: string

      The localization key.

    • n: number

      The number used to determine which plural form to use. E.g. For the phrase "5 Apples" n equals 5.

    • Optionallocale: string

      The desired locale.

    Returns string

    The translated text. If no translations are found at all for the locale then it will return the en-US translation. If no translation exists for that key then it will return the localization key.

    Example

    // manually replace {number} in the resulting translation with our number
    const localized = this.app.i18n.getPluralText('{number} apples', number).replace("{number}", number);

getText

  • getText(key: string, locale?: string): string

  • Returns the translation for the specified key and locale. If the locale is not specified it will use the current locale.

    Parameters

    • key: string

      The localization key.

    • Optionallocale: string

      The desired locale.

    Returns string

    The translated text. If no translations are found at all for the locale then it will return the en-US translation. If no translation exists for that key then it will return the localization key.

    Example

    const localized = this.app.i18n.getText('localization-key');
    const localizedFrench = this.app.i18n.getText('localization-key', 'fr-FR');

hasEvent

  • hasEvent(name: string): boolean

  • Test if there are any handlers bound to an event name.

    Parameters

    • name: string

      The name of the event to test.

    Returns boolean

    True if the object has handlers bound to the specified event name.

    Example

    obj.on('test', function () { }); // bind an event to 'test'
    obj.hasEvent('test'); // returns true
    obj.hasEvent('hello'); // returns false

off

  • off(name?: string, callback?: HandleEventCallback, scope?: object): EventHandler

  • Detach an event handler from an event. If callback is not provided then all callbacks are unbound from the event, if scope is not provided then all events with the callback will be unbound.

    Parameters

    • Optionalname: string

      Name of the event to unbind.

    • Optionalcallback: HandleEventCallback

      Function to be unbound.

    • Optionalscope: object

      Scope that was used as the this when the event is fired.

    Returns EventHandler

    Self for chaining.

    Example

    const handler = function () {
    };
    obj.on('test', handler);

    obj.off(); // Removes all events
    obj.off('test'); // Removes all events called 'test'
    obj.off('test', handler); // Removes all handler functions, called 'test'
    obj.off('test', handler, this); // Removes all handler functions, called 'test' with scope this

on

  • on(name: string, callback: HandleEventCallback, scope?: object): EventHandle

  • Attach an event handler to an event.

    Parameters

    • name: string

      Name of the event to bind the callback to.

    • callback: HandleEventCallback

      Function that is called when event is fired. Note the callback is limited to 8 arguments.

    • Optionalscope: object = ...

      Object to use as 'this' when the event is fired, defaults to current this.

    Returns EventHandle

    Can be used for removing event in the future.

    Example

    obj.on('test', function (a, b) {
        console.log(a + b);
    });
    obj.fire('test', 1, 2); // prints 3 to the console

    Example

    const evt = obj.on('test', function (a, b) {
        console.log(a + b);
    });
    // some time later
    evt.off();

once

  • once(name: string, callback: HandleEventCallback, scope?: object): EventHandle

  • Attach an event handler to an event. This handler will be removed after being fired once.

    Parameters

    • name: string

      Name of the event to bind the callback to.

    • callback: HandleEventCallback

      Function that is called when event is fired. Note the callback is limited to 8 arguments.

    • Optionalscope: object = ...

      Object to use as 'this' when the event is fired, defaults to current this.

    Returns EventHandle

    • can be used for removing event in the future.

    Example

    obj.once('test', function (a, b) {
        console.log(a + b);
    });
    obj.fire('test', 1, 2); // prints 3 to the console
    obj.fire('test', 1, 2); // not going to get handled

removeData

Settings

Member Visibility

On This Page

Constructors
Accessors
Methods