React Native module to expose per-app language preferences API on iOS and Android.
npm install react-native-localization-settingsreact-native-localization-settings is a native module to expose per-app language preferences API on iOS and Android.
| Platform | Supported |
|----------|:---------:|
| iOS | ✅ |
| Android* | ✅ |
_*per-app language settings was introduced in API level 33 (Android 13). On the older versions, the library uses
SharedPreferences to store the language._
To get started with react-native-localization-settings, you'll need to install it using npm:
``sh`
npm install react-native-localization-settings
or with yarn:
`sh`
yarn add react-native-localization-settings
To get started, define the languages your app will support. If you're using Expo, you can leverage the Expo config plugin to generate the necessary native configurations.
Simply add the config plugin to your app.json file and specify the list of supported languages:
`json`
{
"expo": {
// ...
"plugins": [
[
"react-native-localization-settings",
{
"languages": ["en", "pl"]
}
]
]
}
}
and run npx expo prebuild.
If your app isn’t using Expo, you’ll need to add the configuration manually.
iOS configuration
Open your project in XCode, in Project Navigator select project, go to Info tab, andLocalizations
under section add languages you want to support.
Next, you need to create a Localization.strings file.
Select newly created file and on the right side of the screen, under Localizations selection press Localize. Confirm
the popup.
Lastly, you need to select all elements in the section form previous step.
Android configuration
Create new file in android/app/src/main/res/xml directory named locales_config.xml. and define supported languages:
`xml`
Then, open android/app/src/main/AndroidManifest.xml and add following line to the Application tag:
`xml`
android:localeConfig="@xml/locales_config"
>
Function to get current language.
Returns Language in IETF BCP 47 format (like 'en-US')
`ts`
getLanguage(); // 'en-US'
Function to set the current language.
It accepts a string with language code in IETF BCP 47 format (like 'en-US') or ISO 639-1 format (like 'en').
`ts`
setLanguage("en-US");
This library is fully compatible with i18next.
To use it with i18next, create a language detector by using createLanguageDetector with the specified options:`ts
import { createLanguageDetector } from 'react-native-localization-settings';
const languageDetector = createLanguageDetector({});
i18next
.use(languageDetector)
.use(initReactI18next)
.init({
// ...
});
`
`ts`
type LanguageDetectorOptions = {
cacheCurrentLanguage?: boolean; // default: false - sets current detected language
async?: boolean; // default: false - uses getLanguageAsync (set to true on old architecture)
};
Then, if you want to create custom in-app language selector, you should be able to change the language (along with the
settings per-app language) using standard i18next function:
`ts``
i18next.changeLanguage('pl-PL');
Users who speak multiple languages often set their device language to one language, such as English, but they may want
to use other languages for certain apps, like Polish, Dutch, or French. To help apps provide a better experience for
these users, this package adds the ability to set language preferences for individual apps in the device's settings.
---
Made with ❤️ by Jakub Grzywacz