[![npm](https://img.shields.io/npm/v/get-user-locale.svg)](https://www.npmjs.com/package/get-user-locale) ![downloads](https://img.shields.io/npm/dt/get-user-locale.svg) [![CI](https://github.com/wojtekmaj/get-user-locale/actions/workflows/ci.yml/badge.svg)](https://github.com/wojtekmaj/get-user-locale/actions) # Get-User-Locale A function that returns user's locale as an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag), based on all available sources. ## tl;dr - Install by executing `npm install get-user-locale` or `yarn add get-user-locale`. - Import by adding `import getUserLocale from 'get-user-locale'`. - Do stuff with it! ```ts const userLocale = getUserLocale(); ``` ## User guide ### `getUserLocale()` A function that returns user's preferred locale as an [IETF language tag](https://en.wikipedia.org/wiki/IETF_language_tag), based on all available sources. #### Sample usage ```ts import getUserLocale from 'get-user-locale'; getUserLocale(); // 'de-DE' ``` or ```ts import { getUserLocale } from 'get-user-locale'; getUserLocale(); // 'de-DE' ``` ##### Options `getUserLocale()` may be called with an optional `options` argument. `options` object may contain the following properties: | Property | Description | Default value | | ------------------- | ----------------------------------- | ------------- | | `fallbackLocale` | A locale to use as a fallback. | `en-US` | | `useFallbackLocale` | Whether to use the fallback locale. | `true` | ### `getUserLocales()` A function that returns an array of user's preferred locales as an [IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag), based on all available sources. #### Sample usage ```ts import { getUserLocales } from 'get-user-locale'; getUserLocales(); // ['de-DE', 'de', 'en-US', 'en'] ``` ##### Options `getUserLocales()` may be called with an optional `options` argument. `options` object may contain the following properties: | Property | Description | Default value | | ------------------- | ----------------------------------- | ------------- | | `fallbackLocale` | A locale to use as a fallback. | `en-US` | | `useFallbackLocale` | Whether to use the fallback locale. | `true` | ## Technical details There are a few ways of determining user's locale: - `window.navigator.languages` - `window.navigator.language` `…languages` is an array of strings, `…language` is a string. Some browsers return mixed-case [IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag) (e.g. `de-DE`), while others return lowercase ones (e.g. `de-de`). Finally, non-browser environments will not return anything, so you need a fallback. Get-User-Locale does the following: - Combines all of them into one sane set of locales - in that particular order, - Dedupes them, - Fixes invalid, lowercased [IETF language tags](https://en.wikipedia.org/wiki/IETF_language_tag) (so that the part after `-` is always uppercased), - Adds a fallback to `en-US`, so if all else fails, you will get a result that won't crash your app. ## License The MIT License. ## Author

Wojciech Maj

	Stars	Issues	Version	Updated	Created
browser-locale	105	2	1.0.3	7 years ago	10 years ago
detect-browser-language	37	3	0.0.2	5 years ago	7 years ago
get-user-locale			2.3.2	5 days ago	6 years ago
locale2	65	1	2.3.1	6 years ago	9 years ago

browser-locale vs detect-browser-language vs get-user-locale vs locale2

Downloads in past1 Month3 Months6 Months1 Year2 Years5 YearsAll time

Stats

Popular Searches

Sick of boring JavaScript newsletters?

Downloads in past