i18next documentation

i18next documentation

Powered by GitBook
Have an account? Sign in

Creating own Plugins

Edit on GitHub
Contents

Creating own Plugins

i18next comes with a lot of modules to enhance the features available. There are modules to:

  • load resources, eg. via xhr or from filesystem (node.js)

  • cache resources on client, eg. localStorage

  • detect user language by querystring, navigator, cookie, ...

  • post processors to further manipulate values, eg. to add sprintf support

The plugins need to support following APIs:

HINT: You can provide a singleton or a prototype constructor (prefered for supporting multiple instances of i18next).

backend

Backend plugins are used to load data for i18next.

{
  type: 'backend',
  init: function(services, backendOptions, i18nextOptions) {
    /* use services and options */
  },
  read: function(language, namespace, callback) {
    /* return resources */
    return {
      key: 'value'
    };
  },
​
  // optional
  readMulti: function(languages, namespaces, callback) {
    /* return multiple resources - usefull eg. for bundling loading in one xhr request */
    return {
      en: {
        translations: {
          key: 'value'
        }
      },
      de: {
        translations: {
          key: 'value'
        }
      }
    }
  },
​
  // only used in backends acting as cache layer
  save: function(language, namespace, data) {
    // store the translations
  }
​
  create: function(languages, namespace, key, fallbackValue) { 
    /* save the missing translation */
  }
}

languageDetector

Language Detector plugins are used to detect language in user land.

{
  type: 'languageDetector',
  init: function(services, detectorOptions, i18nextOptions) {
    /* use services and options */
  },
  detect: function() { 
    /* return detected language */
    return 'de';
  },
  cacheUserLanguage: function(lng) {
    /* cache language */
  }
}

post processor

Post Processors are used to extend or manipulate the translated values before returning them in t function.

(Post Processors do not need to be prototype functions)

{
  type: 'postProcessor',
  name: 'nameOfProcessor',
  process: function(value, key, options, translator) {
    /* return manipulated value */
    return value;
  }
}

logger

Override the built in console logger.

(loggers do not need to be prototype functions)

{
  type: 'logger',
​
  log: function(args) {},
  warn: function(args) {},
  error: function(args) {}
}