i18next documentation

i18next documentation

Powered by GitBook
Have an account? Sign in

Objects and Arrays

Last updated 8 months ago
Edit on GitHub
Contents

Objects and arrays

Objects

You can return objects or arrays to be used by third party modules localization:

keys

{
    "tree": {
        "res": "added {{something}}"
    },
    "array": ['a', 'b', 'c']
}

sample

i18next.t('tree', { returnObjects: true, something: 'gold' });
// -> { res: 'added gold' }
​
i18next.t('array', { returnObjects: true });
// -> ['a', 'b', 'c']

The returned value supports interpolation, plurals, nesting, ...

returnObjects can be set to true on init.

Arrays

You can access array values or join them.

keys

{
      "arrayJoin": [
        "line1",
        "line2",
        "line3"
      ],
      "arrayJoinWithInterpolation": [
        "you",
        "can",
        "{{myVar}}"
      ],
      "arrayOfObjects": [
        { "name": "tom" },
        { "name": "steve" }
      ]
}

sample

i18next.t('arrayJoin', { joinArrays: '+' });
// -> "line1+line2+line3"
​
i18next.t('arrayJoinWithInterpolation', { myVar: 'interpolate', joinArrays: ' ' });
// -> "you can interpolate"
​
i18next.t('arrayOfObjects.0.name');
// -> "tom"

The returned value supports interpolation, plurals, nesting, ...

joinArrays can be set to a value on init.

Translation Function - Previous
Context
Next - Principles
Translation Resolution
Contents