Have ideas to improve npm?Join in the discussion! »

    browser-lang
    DefinitelyTyped icon, indicating that this package has TypeScript declarations provided by the separate @types/browser-lang package

    0.1.0 • Public • Published

    browser-lang

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

    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 browser-lang --save

    or

    yarn add 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

    License

    MIT © Daewoong Moon

    Install

    npm i browser-lang

    DownloadsWeekly Downloads

    9,634

    Version

    0.1.0

    License

    MIT

    Unpacked Size

    158 kB

    Total Files

    6

    Last publish

    Collaborators

    • avatar