Expo

Get Started
API Reference

Localization

expo-localization allows you to Localize your app, customizing the experience for specific regions, languages, or cultures. It also provides access to the locale data on the native device. Using the popular library i18n-js with expo-localization will enable you to create a very accessible experience for users.

Platform Compatibility

Android DeviceAndroid EmulatoriOS DeviceiOS SimulatorWeb

Installation

expo install expo-localization

If you're installing this in a bare React Native app, you should also follow these additional installation instructions.

Let's make our app support English and Japanese.
  • Install the i18n package i18n-js
    yarn add i18n-js
    
  • Configure the languages for your app.
    import * as Localization from 'expo-localization';
    import i18n from 'i18n-js';
    // Set the key-value pairs for the different languages you want to support.
    i18n.translations = {
      en: { welcome: 'Hello' },
      ja: { welcome: 'こんにちは' },
    };
    // Set the locale once at the beginning of your app.
    i18n.locale = Localization.locale;
    

  • You may want to refrain from localizing text for certain things, like names. In this case you can define them once in your default language and reuse them with i18n.fallbacks = true;.
  • When a user changes the device's language, your app will reset. This means you can set the language once, and don't need to update any of your React components to account for the language changes.
  • On iOS, you can add "CFBundleAllowMixedLocalizations": true to your ios.infoPlist property in your app.json so that your app supports the retrieval of localized strings from frameworks.
    • This will allow you to translate app metadata, including the homescreen display name! Read here for details.

import * as React from 'react';
import { Text } from 'react-native';
import * as Localization from 'expo-localization';
import i18n from 'i18n-js';

// Set the key-value pairs for the different languages you want to support.
i18n.translations = {
  en: { welcome: 'Hello', name: 'Charlie' },
  ja: { welcome: 'こんにちは' },
};
// Set the locale once at the beginning of your app.
i18n.locale = Localization.locale;
// When a value is missing from a language it'll fallback to another language with the key present.
i18n.fallbacks = true;

function App() {
  return (
    <Text>
      {i18n.t('welcome')} {i18n.t('name')}
    </Text>
  );
}

import * as Localization from 'expo-localization';

This API is mostly synchronous and driven by constants. On iOS the constants will always be correct, on Android you should check if the locale has updated using AppState and Localization.getLocalizationAsync(). Initially the constants will be correct on both platforms, but on Android a user can change the language and return, more on this later.

Native device language, returned in standard format. Ex: en, en-US, es-US.

List of all the native languages provided by the user settings. These are returned in the order the user defines in their native settings.

Available on iOS and Web. Region code for your device which came from Region setting in Language & Region. Ex: US, NZ.

A list of all the supported language ISO codes.

The current timezone in display format. ex: America/Los_Angeles
On Web timezone is calculated with Intl.DateTimeFormat().resolvedOptions().timeZone. For a better estimation you could use the moment-timezone package but it will add significant bloat to your website's bundle size.

Returns if the system's language is written from Right-to-Left. This can be used to build features like bidirectional icons.

Android only, on iOS changing the locale settings will cause all the apps to reset.
type NativeEvent = {
  locale: string,
  locales: Array<string>,
  timezone: string,
  isoCurrencyCodes: ?Array<string>,
  region: ?string,
  isRTL: boolean,
};
Example
// When the app returns from the background on Android...

const { locale } = await Localization.getLocalizationAsync();