expo-localization v14.8.4

expo-localization

expo-localization enables you to interface with the native device locale.

Installation

Now, you need to install the package from npm registry.

npm install expo-localization or yarn add expo-localization

iOS (Cocoapods)

If you're using Cocoapods, add the dependency to your Podfile:

pod 'EXLocalization', path: '../node_modules/expo-localization/ios'

and if not already included

pod 'EXCore', path: '../node_modules/expo-core/ios'

and run pod install.

Android

1. Append the following lines to android/settings.gradle:

   include ':expo-localization'
   project(':expo-localization').projectDir = new File(rootProject.projectDir, '../node_modules/expo-localization/android')

   and if not already included

   include ':expo-core'
   project(':expo-core').projectDir = new File(rootProject.projectDir, '../node_modules/expo-core/android')

2. Insert the following lines inside the dependencies block in android/app/build.gradle:

   api project(':expo-localization')

   and if not already included

   api project(':expo-core')

Some Unimodules are not included in the default ExpoKit suite, these modules will needed to be added manually. If your Android build cannot find the Native Modules, you can add them like this:

./android/app/src/main/java/host/exp/exponent/MainActivity.java

@Override
public List<Package> expoPackages() {
  // Here you can add your own packages.
  return Arrays.<Package>asList(
    new LocalizationPackage() // Include this.
  );
}

Usage

import React from 'react';
import { Text } from 'react-native';
import { Localization } from 'expo-localization';

import i18n from 'i18n-js';

const en = {
  foo: 'Foo',
  bar: 'Bar {{someValue}}',
};

const fr = {
  foo: 'como telle fous',
  bar: 'chatouiller {{someValue}}',
};

i18n.fallbacks = true;
i18n.translations = { fr, en };
i18n.locale = Localization.locale;

export default class LitView extends React.Component {
  componentWillMount() {
    this._subscription = Localization.addListener(({ locale }) => {
      i18n.locale = locale;
    });
  }

  componentWillUnmount() {
    if (!!this._subscription) {
      this._subscription.remove();
    }
  }

  render() {
    return (
      <Text>
        {i18n.t('foo')} {i18n.t('bar', { someValue: Date.now() })}
      </Text>
    );
  }
}

API

Constants

This API is mostly synchronous and driven by constants.

Localization.locale: string

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

Localization.locales: Array<string>

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

Localization.country: ?string

Country code for your device.

Localization.isoCurrencyCodes: ?Array<string>

A list of all the supported ISO codes.

Localization.timezone: string

The current time zone in display format. ex: America/Los_Angeles

Localization.isRTL: boolean

This will return true if the current language is Right-to-Left.

Methods

Callbacks are Android only, changing the native locale on iOS will cause all the apps to reset.

Localization.addListener(listener: Listener): ?Subscription

Observe when a language is added or moved in the Android settings.

Localization.removeAllListeners(): void

Clear all language observers.

Localization.removeSubscription(subscription: Subscription): void

Stop observing when the native languages are edited.