This is a i18next cache layer to be used in the browser. It will load and cache resources from localStorage and can be used in combination with the chained backend.
Switch branches/tags
Nothing to show
Clone or download
Latest commit 3253bbb Aug 1, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
src fixes store call Apr 8, 2018
.babelrc initial version Apr 4, 2018
.editorconfig initial version Apr 4, 2018
.eslintignore initial version Apr 4, 2018
.eslintrc initial version Apr 4, 2018
.gitignore initial version Apr 4, 2018
.npmignore initial version Apr 4, 2018
CHANGELOG.md fixes store call Apr 8, 2018
LICENSE initial version Apr 4, 2018
README.md Update README.md Aug 1, 2018
i18nextLocalStorageBackend.js fixes store call Apr 8, 2018
i18nextLocalStorageBackend.min.js fixes store call Apr 8, 2018
index.js initial version Apr 4, 2018
package.json fixes store call Apr 8, 2018
rollup.config.js initial version Apr 4, 2018

README.md

Introduction

This is a i18next cache layer to be used in the browser. It will load and cache resources from localStorage and can be used in combination with the chained backend.

Getting started

Source can be loaded via npmor downloaded from this repo.

  • If you don't use a module loader it will be added to window.i18nextLocalStorageBackend
# npm package
$ npm install i18next-localstorage-backend

Wiring up with the chained backend:

import i18next from 'i18next';
import Backend from 'i18next-chained-backend';
import LocalStorageBackend from 'i18next-localstorage-backend'; // primary use cache
import XHR from 'i18next-xhr-backend'; // fallback xhr load

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

Cache Backend Options

{
  // prefix for stored languages
  prefix: 'i18next_res_',

  // expiration
  expirationTime: 7*24*60*60*1000,

  // language versions
  versions: {}
};
  • Contrary to cookies behavior, the cache will respect updates to expirationTime. If you set 7 days and later update to 10 days, the cache will persist for 10 days

  • Passing in a versions object (ex.: versions: { en: 'v1.2', fr: 'v1.1' }) will give you control over the cache based on translations version. This setting works along expirationTime, so a cached translation will still expire even though the version did not change. You can still set expirationTime far into the future to avoid this


Gold Sponsors