Product
Introducing License Enforcement in Socket
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
preferred-locale
Advanced tools
Get the users' most preferred locale/language from your app's available translations with zero dependencies
🎌 Get the users' most preferred locale/language from your app's available translations with zero dependencies
This library is fully typed with TSDoc examples. View the online documentation here: https://wopian.github.io/preferred-locale/
import { preferredLocale } from 'preferred-locale'
// Note: All examples assume the browser's reported locales are:
// [ 'en-GB', 'en', 'ja-JP', 'en-US', 'ja' ]
const supportedLocales = ['en-US', 'ja-JP']
const fallbackLocale = 'ja-JP'
const locale = preferredLocale(supportedLocales, fallbackLocale)
console.log(locale) // 'en-US', converts 'en-GB' and 'en' to 'en-US' as neither are translated, placing it before 'ja-JP' in preference order
preferredLocale(['en-us', 'fr-fr'], ['en-us'], {
regionLowerCase: true
}) // 'en-us', converts 'en-GB' to 'en-us' as 'en-gb' is not translated
preferredLocale(['de', 'fr'], ['fr'], {
languageOnly: true
}) // 'fr', converts 'en-GB' to 'en' (etc). No matching locales so returns 'fr' fallback
preferredLocale(['en-US', 'en-GB'], ['en-US']) // 'en-GB', as it is translated and first in user's preference order
Package | Package Size | Node | Chrome | Firefox | Safari | Edge |
---|---|---|---|---|---|---|
preferred-locale | ~600 bytes | 14+ | 69+ | 68+ | 12+ | 18+ |
preferred-locale@2
is a rewrite of preferred-locale@1
, written in TypeScript as a native ESM module. If your environment does not support ESM modules, you can continue to use preferred-locale@1
as the resultant code is identical.
Many web applications that automatically detect the browser language and serve the relevent translation are fundamentally broken.
A browser that signals the user prefers the following locales (index 0
being most preferred) should never return content in Japanese (ja-JP
) if the application has translations for Japanese and American English (en-US
):
[ 'en-GB', 'en', 'ja-JP', 'en-US', 'ja' ]
Instead, many applications (e.g Epic Games' store, help and documentation) will instead serve their users content in Japanese as they do not provide translations for British English, only American English and only check for exact matches.
preferred-locale
fixes this by traversing the supported node/browser languages in order of priority:
en-GB
is translated).en-AU
becomes en-US
),en
), the canonical region is looked up and tested against (e.g en
becomes en-US
)A step-by-step demonstration of how preferred-locale@1
works with your own browser locales is available at eehz9.csb.app.
Application has translations for en-US
and ja-JP
Raw browser locales [ 'en-GB', 'en', 'ja-JP', 'en-US', 'ja' ]
Unify the browser locales [ 'en-GB', 'en-US', 'ja-JP', 'en-US', 'ja-JP' ]
Deduplicate the locales [ 'en-GB', 'en-US', 'ja-JP' ]
Remove locales not translated [ 'en-US', 'ja-JP' ]
User gets content in en-US
See CONTRIBUTING
See Github Releases
All code released under MIT
FAQs
Get the users' most preferred locale/language from your app's available translations with zero dependencies
The npm package preferred-locale receives a total of 232 weekly downloads. As such, preferred-locale popularity was classified as not popular.
We found that preferred-locale demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Product
Ensure open-source compliance with Socket’s License Enforcement Beta. Set up your License Policy and secure your software!
Product
We're launching a new set of license analysis and compliance features for analyzing, managing, and complying with licenses across a range of supported languages and ecosystems.
Product
We're excited to introduce Socket Optimize, a powerful CLI command to secure open source dependencies with tested, optimized package overrides.