From 15261e8ffab39230eb858195c1998228bc3b8f97 Mon Sep 17 00:00:00 2001 From: Alexander Zaytsev Date: Thu, 9 Jul 2015 11:29:49 +0700 Subject: [PATCH] Update readme for 0.0.6 --- README.md | 29 +++++++++++++++++++++++++++-- 1 file changed, 27 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index f4dfe39..26b25a1 100644 --- a/README.md +++ b/README.md @@ -21,6 +21,9 @@ var Demo = React.createClass({ } }); +// Enable fallbacks if you want `en-US` and `en-GB` to fallback to `en` +I18n.fallbacks = true; + I18n.translations = { en: { greeting: 'Hi!' @@ -33,7 +36,25 @@ I18n.translations = { This will render `Hi!` for devices with the English locale, and `Bonjour!` for devices with the French locale. -For more info about I18n.js methods (`localize`, `pluralize`, etc) and settings see [its documentation](https://github.com/fnando/i18n-js#setting-up). +### Fallbacks +When fallbacks are enabled (which is generally recommended), `i18n.js` will try to look up translations in the following order (for a device with `en_US` locale): +- en-US +- en + +**Note**: iOS locales use underscored (`en_US`) but `i18n.js` locales are dasherized (`en-US`). This conversion is done automatically for you. +```js +I18n.fallbacks = true; + +I18n.translations = { + 'en': { + greeting: 'Hi!' + }, + 'en-GB': { + greeting: 'Hi from the UK!' + } +} +``` +For a device with a `en_GB` locale this will return `Hi from the UK!'`, for a device with a `en_US` locale it will return `Hi!`. ### Device's locale You can get the device's locale with the `RNI18n` native module: @@ -41,6 +62,10 @@ You can get the device's locale with the `RNI18n` native module: ```js var deviceLocale = require('react-native').NativeModules.RNI18n.locale ``` +Returns `en_US`. + +### I18n.js documentation +For more info about I18n.js methods (`localize`, `pluralize`, etc) and settings see [its documentation](https://github.com/fnando/i18n-js#setting-up). ## Licence -MIT \ No newline at end of file +MIT