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

language detector used in browser environment for i18next
https://github.com/i18next/i18next-browser-languageDetector

detection i18next language plugin

Last synced: about 1 month ago
JSON representation

language detector used in browser environment for i18next

• Host: GitHub
• URL: https://github.com/i18next/i18next-browser-languageDetector
• Owner: i18next
• License: mit
• Created: 2015-10-28T08:33:58.000Z (over 8 years ago)
• Default Branch: master
• Last Pushed: 2024-05-12T11:51:19.000Z (2 months ago)
• Last Synced: 2024-05-22T04:42:46.373Z (about 2 months ago)
• Topics: detection, i18next, language, plugin
• Language: JavaScript
• Size: 1.04 MB
• Stars: 825
• Watchers: 9
• Forks: 88
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Lists

• awesome-stars - i18next/i18next-browser-languageDetector - language detector used in browser environment for i18next (JavaScript)
• awesome-stars - i18next-browser-languageDetector
• awesome-stars - i18next-browser-languageDetector - language detector used in browser environment for i18next (JavaScript)
• awesome-stars - i18next-browser-languageDetector - language detector used in browser environment for i18next (JavaScript)

README

        
# Introduction

[![npm version](https://img.shields.io/npm/v/i18next-browser-languagedetector.svg?style=flat-square)](https://www.npmjs.com/package/i18next-browser-languagedetector)

This is an i18next language detection plugin used 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  lng.replace('-', '_')

}

```

Options can be passed in:

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

```js

import i18next from 'i18next';

import LanguageDetector from 'i18next-browser-languagedetector';

i18next.use(LanguageDetector).init({

  detection: options,

});

```

on construction:

```js

import LanguageDetector from 'i18next-browser-languagedetector';

const languageDetector = new LanguageDetector(null, options);

```

via calling init:

```js

import LanguageDetector from 'i18next-browser-languagedetector';

const languageDetector = new LanguageDetector();

languageDetector.init(options);

```

## Adding own detection functionality

### interface

```js

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

```js

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](#detector-options).

---

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](https://locize.com/img/ads/github_locize.png)

With using [locize](http://locize.com/?utm_source=react_i18next_readme&utm_medium=github) you directly support the future of i18next and react-i18next.

---