i18next-icu

Introduction

This is a i18next backend to chain multiple other backends and caches. So you can define an additional caching backend or fallback backends.

Getting started

Source can be loaded via npm or downloaded from this repo.

# npm package
$ npm install i18next-icu

Wiring up:

import i18next from 'i18next';
import Backend from 'i18next-icu';

i18next
  .use(Backend)
  .init(i18nextOptions);

• As with all modules you can either pass the constructor function (class) to the i18next.use or a concrete instance.
• If you don't use a module loader it will be added to window.i18nextICU

Backend Options

{
  // array of existing i18next backends from https://www.i18next.com/plugins-and-utils.html#backends
  backends: [],

  // array of options in order of backends above
  backendOptions: []
}

Options can be passed in:

preferred - by setting options.backend in i18next.init:

import i18next from 'i18next';
import Backend from 'i18next-icu';

i18next
  .use(Backend)
  .init({
    backend: options
  });

on construction:

  import Backend from 'i18next-icu';
  const Backend = new Backend(null, options);

via calling init:

  import Backend from 'i18next-icu';
  const Backend = new Backend();
  Backend.init(options);

more complete sample

import i18next from 'i18next';
import Backend from 'i18next-icu';
import Locize from 'i18next-locize-backend'; // load from service
import XHR from 'i18next-xhr-backend'; // have a own xhr fallback

i18next
  .use(Backend)
  .init({
    backend: {
      backends: [
        Locize,  // primary
        XHR      // fallback
      ],
      backendOptions: [{
        projectId: 'myLocizeProjectId'
      }, {
        loadPath: '/locales/{{lng}}/{{ns}}.json' // xhr load path for my own fallback
      }]
    }
  });