Gathering detailed insights and metrics for @byhuz/i18next-browser-languagedetector
Installations
npm install @byhuz/i18next-browser-languagedetectorDeveloper Guide
BETA
Typescript
Yes
Module System
CommonJS
Node Version
12.16.1
NPM Version
6.14.4
Score
73
Supply Chain
98.9
Quality
80.1
Maintenance
100
Vulnerability
100
License
Releases
Unable to fetch releases
Contributors
27
Unable to fetch Contributors
Languages
2
JavaScript
TypeScript
JavaScript (94.61%)
TypeScript (5.39%)
Love this project? Help keep it running — sponsor us today! 🚀
Developer
i18next
Download Statistics
Total Downloads
5,148
Last Day
2
Last Week
8
Last Month
23
Last Year
345
GitHub Statistics
MIT License
887 Stars
250 Commits
89 Forks
9 Watchers
93 Branches
27 Contributors
Updated on Feb 11, 2025
Bundle Size
6.27 kB
Minified
2.21 kB
Minified + Gzipped
Maintainers
5
Package Meta Information
Latest Version
4.2.2
Package Id
@byhuz/i18next-browser-languagedetector@4.2.2
Unpacked Size
50.59 kB
Size
9.84 kB
File Count
8
NPM Version
6.14.4
Node Version
12.16.1
Total Downloads
Cumulative downloads
Total Downloads
5,148
Last Day
100%
2
Compared to previous day
Last Week
0%
8
Compared to previous week
Last Month
27.8%
23
Compared to previous month
Last Year
-60.2%
345
Compared to previous year
Daily Downloads
Weekly Downloads
Monthly Downloads
Yearly Downloads
Dependencies
1
Dev Dependencies
26
@babel/core@babel/plugin-transform-runtime@babel/preset-envbabel-eslintbabel-polyfillbabelifybrowserifybrowserify-istanbulchaicoverallscpy-clidtslinteslinteslint-config-airbnbexpect.jsi18nextmkdirpmocharimrafrolluprollup-plugin-babelrollup-plugin-node-resolverollup-plugin-tersertslinttypescriptyargs
Introduction
This is a i18next language detection plugin use to detect user language in the browser with support for:
- cookie (set cookie i18next=LANGUAGE)
- localStorage (set key i18nextLng=LANGUAGE)
- navigator (set browser language)
- querystring (append
?lng=LANGUAGEto 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:
1import i18next from 'i18next'; 2import LanguageDetector from 'i18next-browser-languagedetector'; 3 4i18next 5 .use(LanguageDetector) 6 .init(i18nextOptions);
As with all modules you can either pass the constructor function (class) to the i18next.use or a concrete instance.
Detector Options
1{ 2 // order and from where user language should be detected 3 order: ['querystring', 'cookie', 'localStorage', 'navigator', 'htmlTag', 'path', 'subdomain'], 4 5 // keys or params to lookup language from 6 lookupQuerystring: 'lng', 7 lookupCookie: 'i18next', 8 lookupLocalStorage: 'i18nextLng', 9 lookupFromPathIndex: 0, 10 lookupFromSubdomainIndex: 0, 11 12 // cache user language on 13 caches: ['localStorage', 'cookie'], 14 excludeCacheFor: ['cimode'], // languages to not persist (cookie, localStorage) 15 16 // optional expire and domain for set cookie 17 cookieMinutes: 10, 18 cookieDomain: 'myDomain', 19 20 // optional htmlTag with lang attribute, the default is: 21 htmlTag: document.documentElement, 22 23 // only detect languages that are in the whitelist 24 checkWhitelist: true, 25 26 // fallback to a similar whitelist language 27 // Example 1: Browser language is 'es' 28 // if 'es' is not found in whitelist, first fallback to any whitelist language that starts with 'es-', then fallback to fallbackLng ('es' -> 'es-*' -> fallbackLng) 29 // Example 2: Browser language is 'es-MX' 30 // if 'es-MX' is not found in whitelist, first fallback to 'es', then fallback to 'es-*', then fallback to fallbackLng ('es-MX' -> 'es' -> 'es-*' -> fallbackLng) 31 checkForSimilarInWhitelist: false, 32 33 // optional set cookie options, reference:[MDN Set-Cookie docs](https://developer.mozilla.org/en-US/docs/Web/HTTP/Headers/Set-Cookie) 34 cookieOptions: {path:'/'} 35}
Options can be passed in:
preferred - by setting options.detection in i18next.init:
1import i18next from 'i18next'; 2import LanguageDetector from 'i18next-browser-languagedetector'; 3 4i18next 5 .use(LanguageDetector) 6 .init({ 7 detection: options 8 });
on construction:
1 import LanguageDetector from 'i18next-browser-languagedetector'; 2 const languageDetector = new LanguageDetector(null, options);
via calling init:
1 import LanguageDetector from 'i18next-browser-languagedetector'; 2 const languageDetector = new LanguageDetector(); 3 lngDetector.init(options);
Adding own detection functionality
interface
1export default { 2 name: 'myDetectorsName', 3 4 lookup(options) { 5 // options -> are passed in options 6 return 'en'; 7 }, 8 9 cacheUserLanguage(lng, options) { 10 // options -> are passed in options 11 // lng -> current language, will be called after init and on changeLanguage 12 13 // store it 14 } 15};
adding it
1 import LanguageDetector from 'i18next-browser-languagedetector'; 2 const languageDetector = new LanguageDetector(); 3 languageDetector.addDetector(myDetector); 4 5 i18next 6 .use(languageDetector) 7 .init({ 8 detection: options 9 });
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
No vulnerabilities found.
Reason
no binaries found in the repo
Reason
license file detected
Details
- Info: project has a license file: LICENSE:0
- Info: FSF or OSI recognized license: MIT License: LICENSE:0
Reason
4 commit(s) and 1 issue activity found in the last 90 days -- score normalized to 4
Reason
Found 6/23 approved changesets -- score normalized to 2
Reason
9 existing vulnerabilities detected
Details
- Warn: Project is vulnerable to: GHSA-67hx-6x53-jw92
- Warn: Project is vulnerable to: GHSA-3xgq-45jj-v275
- Warn: Project is vulnerable to: GHSA-952p-6rrq-rcjv
- Warn: Project is vulnerable to: GHSA-mwcw-c2x4-8c55
- Warn: Project is vulnerable to: GHSA-p8p7-x288-28g6
- Warn: Project is vulnerable to: GHSA-gcx4-mw62-g8wm
- Warn: Project is vulnerable to: GHSA-c2qf-rxjj-qqgw
- Warn: Project is vulnerable to: GHSA-f5x3-32g6-xq36
- Warn: Project is vulnerable to: GHSA-72xf-g2v4-qvf3
Reason
no effort to earn an OpenSSF best practices badge detected
Reason
project is not fuzzed
Details
- Warn: no fuzzer integrations found
Reason
branch protection not enabled on development/release branches
Details
- Warn: branch protection not enabled for branch 'master'
Reason
security policy file not detected
Details
- Warn: no security policy file detected
- Warn: no security file to analyze
- Warn: no security file to analyze
- Warn: no security file to analyze
Reason
SAST tool is not run on all commits -- score normalized to 0
Details
- Warn: 0 commits out of 13 are checked with a SAST tool
Score
2.7
/10
Last Scanned on 2025-02-03
The Open Source Security Foundation is a cross-industry collaboration to improve the security of open source software (OSS). The Scorecard provides security health metrics for open source projects.
Learn More