Skip to content

Detect user's most preferred language within the given language list.

License

Notifications You must be signed in to change notification settings

jacekk/browser-lang

This branch is 20 commits ahead of, 4 commits behind wiziple/browser-lang:master.

Folders and files

NameName
Last commit message
Last commit date

Latest commit

6c1b773 · Jan 8, 2023

History

34 Commits
Oct 27, 2022
Oct 27, 2022
Jun 7, 2019
Oct 27, 2022
Jul 5, 2018
Oct 27, 2022
Oct 27, 2022
Jul 5, 2018
Oct 27, 2022
Oct 27, 2022
Jan 8, 2023
Jan 8, 2023

Repository files navigation

browser-lang

Detect user's most preferred language within the given language list.

Based on https://github.com/wiziple/browser-lang project.

Known Vulnerabilities

Why?

  • To determine an initial display language or default language router on your application with fallback options.

Inspiration

  • I made en and ko router to support i18n. How do I detect user's preferred language in browser?
  • My app only supports en and ko for now. What language should I display when zh users visit us?
  • I added fr router. But, how do I handle fr_FR and fr_CA users as well?

Installation

npm install @onlytabs/browser-lang --save
# or
yarn add @onlytabs/browser-lang

Options

  • languages: language code list that is available on your application.

  • fallback: default language when user's preferred language is not on the list.

Example

in javascript project

// const browserLang = require('browser-lang');
import browserLang from 'browser-lang';

const myLanguage = browserLang();
// return the preferred language in browser: e.g. "ko-KR" or "ko".

const myLanguage = browserLang({
  languages: ['ko', 'de', 'zh', 'zh_TW', 'en'],
  fallback: 'en',
});

// return "ko" if the preferred language in browser is set to "ko-KR" or "ko".
// return "en" as a fallback if the preferred language in browser is "fr".
// return 'zh' if the preferred language in browser is set to "zh_HK".

Browser support

  • Chrome
  • Firefox
  • Safari
  • IE
  • Edge
  • Opera

About

Detect user's most preferred language within the given language list.

Resources

License

Stars

Watchers

Forks

Packages

No packages published

Languages

  • JavaScript 100.0%