i18next-browser-languagedetector

What is i18next-browser-languagedetector?

The i18next-browser-languagedetector is an npm package designed to automatically detect the user's language in a web browser environment. It integrates seamlessly with the i18next ecosystem, a popular internationalization framework for web applications. This package helps in providing a more personalized user experience by loading and applying language preferences based on various detection functionalities.

What are i18next-browser-languagedetector's main functionalities?

Language detection from query string

Detects the user's language preference from the query string of the URL. This is useful for applications that adjust the language based on URL parameters.

i18next.use(LanguageDetector).init({
  detection: {
    order: ['querystring', 'cookie', 'localStorage', 'navigator', 'htmlTag'],
    lookupQuerystring: 'lng'
  }
});

Language detection from cookies

Detects the user's language preference from cookies. This method is beneficial for persisting language settings across sessions.

i18next.use(LanguageDetector).init({
  detection: {
    order: ['cookie', 'localStorage', 'navigator', 'htmlTag'],
    lookupCookie: 'i18next'
  }
});

Language detection from browser settings

Automatically detects and sets the language based on the user's browser or system settings. This is the most straightforward approach for initial language detection.

i18next.use(LanguageDetector).init({
  detection: {
    order: ['navigator'],
  }
});

Other packages similar to i18next-browser-languagedetector

detect-browser-language

This package is similar to i18next-browser-languagedetector in that it detects the user's browser language. However, it is more simplistic and only focuses on detecting the browser's language without the integration capabilities with i18next or other internationalization frameworks.

README

Introduction

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

• cookie
• localStorage
• navigator
• querystring

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 LngDetector from 'i18next-browser-languagedetector';

i18next
  .use(LngDetector)
  .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', 'navigator'],

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

  // cache user language on
  caches: ['localStorage', 'cookie']

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

Options can be passed in:

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

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

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

on construction:

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

via calling init:

  import LngDetector from 'i18next-browser-languagedetector';
  const lngDetector = new LngDetector();
  lngDetector.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 LngDetector from 'i18next-browser-languagedetector';
  const lngDetector = new LngDetector();
  lngDetector.addDetector(myDetector);

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