terra-i18n
Advanced tools
Comparing version 2.4.0 to 2.5.0
@@ -7,2 +7,7 @@ Changelog | ||
2.5.0 - (April 15, 2018) | ||
------------------ | ||
### Changed | ||
* Minor version bump | ||
2.4.0 - (April 5, 2018) | ||
@@ -9,0 +14,0 @@ ------------------ |
# Terra I18n | ||
The terra-i18n package provides internationalization for React components by loading translations and locale data on demand and providing the translated messages the the component. It does this by utilizing the [`react-intl`](https://github.com/yahoo/react-intl) dependency to provide the formatted translation messages to the supplied React children. To enable this behavior, terra-i18n provides the `i18nLoader` and `I18nProvider` components. | ||
The terra-i18n package provides internationalization for React components by loading translations and locale data on demand and providing the translated messages to the component. It does this by utilizing the [`react-intl`](https://github.com/yahoo/react-intl) dependency to provide the formatted translation messages to the supplied React children. To enable this behavior, terra-i18n provides the `i18nLoader` and `I18nProvider` components. | ||
@@ -9,3 +9,3 @@ ### i18nLoader | ||
Note: the `i18nLoader` state object for the callback must containing the following keys to work properly: | ||
Note: the `i18nLoader` state object for the callback must contain the following keys to work properly: | ||
- `areTranslationsLoaded` - boolean | ||
@@ -17,3 +17,3 @@ - `locale` - string | ||
The `I18nProvider` component configures the react-intl's `IntlProvider` and supplies it with the translation-needing components such that the i18n context is accessible. Usually, one `I18nProvider` will wrap an application's root component such that the entire application is within the same configured i18n context, however it is possible to render nested `I1n8nProvider` components to provide different, or modified i18n context. | ||
The `I18nProvider` component configures the react-intl's `IntlProvider` and supplies it with the translation-needing components such that the i18n context is accessible. Usually, one `I18nProvider` will wrap an application's root component such that the entire application is within the same configured i18n context, however it is possible to render nested `I18nProvider` components to provide different, or modified i18n context. | ||
@@ -40,3 +40,3 @@ ### Supported Locales | ||
It is possible to add and load non-supported locales with `terra-i18n`, however one must ensure the locales are supported by `react-intl`, otherwise no locale-date will exist and loading the intl data will result in an error. Once confirmed that the locale is supported by `react-intl`, one is responsible for including the appropriate translations messages for each terra component used in your application, otherwise the translations will fail and `react-intl` will display the message name as the fallback. | ||
It is possible to add and load non-supported locales with `terra-i18n`, however one must ensure the locales are supported by `react-intl`, otherwise no locale-data will exist and loading the intl data will result in an error. Once confirmed that the locale is supported by `react-intl`, one is responsible for including the appropriate translations messages for each terra component used in your application, otherwise the translations will fail and `react-intl` will display the message name as the fallback. | ||
@@ -43,0 +43,0 @@ ### Locale Fallback |
{ | ||
"name": "terra-i18n", | ||
"main": "lib/I18n.js", | ||
"version": "2.4.0", | ||
"version": "2.5.0", | ||
"description": "The terra-i18n package provides on-demand internationalization of React components.", | ||
@@ -6,0 +6,0 @@ "repository": { |
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
Sorry, the diff of this file is not supported yet
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
License Policy Violation
LicenseThis package is not allowed per your license policy. Review the package's license to ensure compliance.
Found 1 instance in 1 package
405401
99