i18next-browser-languagedetector

WebJar for i18next-browser-languagedetector

License

License

MIT
GroupId

GroupId

org.webjars.npm
ArtifactId

ArtifactId

i18next-browser-languagedetector
Last Version

Last Version

3.0.1
Release Date

Release Date

Type

Type

jar
Description

Description

i18next-browser-languagedetector
WebJar for i18next-browser-languagedetector
Project URL

Project URL

http://webjars.org
Source Code Management

Source Code Management

https://github.com/i18next/i18next-browser-languageDetector

Download i18next-browser-languagedetector

How to add to project

<!-- https://jarcasting.com/artifacts/org.webjars.npm/i18next-browser-languagedetector/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>i18next-browser-languagedetector</artifactId>
    <version>3.0.1</version>
</dependency>
// https://jarcasting.com/artifacts/org.webjars.npm/i18next-browser-languagedetector/
implementation 'org.webjars.npm:i18next-browser-languagedetector:3.0.1'
// https://jarcasting.com/artifacts/org.webjars.npm/i18next-browser-languagedetector/
implementation ("org.webjars.npm:i18next-browser-languagedetector:3.0.1")
'org.webjars.npm:i18next-browser-languagedetector:jar:3.0.1'
<dependency org="org.webjars.npm" name="i18next-browser-languagedetector" rev="3.0.1">
  <artifact name="i18next-browser-languagedetector" type="jar" />
</dependency>
@Grapes(
@Grab(group='org.webjars.npm', module='i18next-browser-languagedetector', version='3.0.1')
)
libraryDependencies += "org.webjars.npm" % "i18next-browser-languagedetector" % "3.0.1"
[org.webjars.npm/i18next-browser-languagedetector "3.0.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

Introduction

npm version Bower David

This is a i18next language detection plugin use to detect user language in the browser with support for:

  • cookie (set cookie i18next=LANGUAGE)
  • sessionStorage (set key i18nextLng=LANGUAGE)
  • localStorage (set key i18nextLng=LANGUAGE)
  • navigator (set browser language)
  • querystring (append ?lng=LANGUAGE to URL)
  • htmlTag (add html language tag <html lang="LANGUAGE" ...)
  • path (http://my.site.com/LANGUAGE/...)
  • subdomain (http://LANGUAGE.site.com/...)

Getting started

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

# npm package
$ npm install i18next-browser-languagedetector

# bower
$ bower install i18next-browser-languagedetector
  • If you don't use a module loader it will be added to window.i18nextBrowserLanguageDetector

Wiring up:

import i18next from 'i18next';
import LanguageDetector from 'i18next-browser-languagedetector';

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

As with all modules you can either pass the constructor function (class) to the i18next.use or a concrete instance.

Detector Options

{
  // order and from where user language should be detected
  order: ['querystring', 'cookie', 'localStorage', 'sessionStorage', 'navigator', 'htmlTag', 'path', 'subdomain'],

  // keys or params to lookup language from
  lookupQuerystring: 'lng',
  lookupCookie: 'i18next',
  lookupLocalStorage: 'i18nextLng',
  lookupSessionStorage: 'i18nextLng',
  lookupFromPathIndex: 0,
  lookupFromSubdomainIndex: 0,

  // cache user language on
  caches: ['localStorage', 'cookie'],
  excludeCacheFor: ['cimode'], // languages to not persist (cookie, localStorage)

  // optional expire and domain for set cookie
  cookieMinutes: 10,
  cookieDomain: 'myDomain',

  // optional htmlTag with lang attribute, the default is:
  htmlTag: document.documentElement,

  // optional set cookie options, reference:[MDN Set-Cookie docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie)
  cookieOptions: { path: '/', sameSite: 'strict' }
}

Options can be passed in:

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

import i18next from 'i18next';
import LanguageDetector from 'i18next-browser-languagedetector';

i18next.use(LanguageDetector).init({
  detection: options,
});

on construction:

import LanguageDetector from 'i18next-browser-languagedetector';
const languageDetector = new LanguageDetector(null, options);

via calling init:

import LanguageDetector from 'i18next-browser-languagedetector';
const languageDetector = new LanguageDetector();
languageDetector.init(options);

Adding own detection functionality

interface

export default {
  name: 'myDetectorsName',

  lookup(options) {
    // options -> are passed in options
    return 'en';
  },

  cacheUserLanguage(lng, options) {
    // options -> are passed in options
    // lng -> current language, will be called after init and on changeLanguage
    // store it
  },
};

adding it

import LanguageDetector from 'i18next-browser-languagedetector';
const languageDetector = new LanguageDetector();
languageDetector.addDetector(myDetector);

i18next.use(languageDetector).init({
  detection: options,
});

Don't forget: You have to add the name of your detector (myDetectorsName in this case) to the order array in your options object. Without that, your detector won't be used. See the Detector Options section for more.


Gold Sponsors


localization as a service - locize.com

Needing a translation management? Want to edit your translations with an InContext Editor? Use the orginal provided to you by the maintainers of i18next!

locize

With using locize you directly support the future of i18next and react-i18next.


org.webjars.npm

i18next

Organization for i18next.com and anything i18next related.

Versions

Version
3.0.1
2.0.0