Home

Awesome

npm downloads CI

Get-User-Locale

A function that returns user's locale as an IETF language tag, based on all available sources.

tl;dr

User guide

getUserLocale()

A function that returns user's preferred locale as an IETF language tag, based on all available sources.

Sample usage

import getUserLocale from 'get-user-locale';

getUserLocale(); // 'de-DE'

or

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:

PropertyDescriptionDefault value
fallbackLocaleA locale to use as a fallback.en-US
useFallbackLocaleWhether to use the fallback locale.true

getUserLocales()

A function that returns an array of user's preferred locales as an IETF language tags, based on all available sources.

Sample usage

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:

PropertyDescriptionDefault value
fallbackLocaleA locale to use as a fallback.en-US
useFallbackLocaleWhether to use the fallback locale.true

Technical details

There are a few ways of determining user's locale:

…languages is an array of strings, …language is a string. Some browsers return mixed-case IETF language tags (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:

License

The MIT License.

Author

<table> <tr> <td > <img src="https://avatars.githubusercontent.com/u/5426427?v=4&s=128" width="64" height="64" alt="Wojciech Maj"> </td> <td> <a href="https://github.com/wojtekmaj">Wojciech Maj</a> </td> </tr> </table>