terra-i18n
Version:
The terra-i18n package provides on-demand internationalization of React components.
47 lines (28 loc) • 2 kB
Markdown
# Terra I18n
[](https://www.npmjs.org/package/terra-i18n)
[](https://travis-ci.com/cerner/terra-core)
The terra-i18n package provides on-demand internationalization of React components.
- [Getting Started](#getting-started)
- [Documentation](#documentation)
- [LICENSE](#license)
## Getting Started
This component is not intended for direct usage by developers. It is recommended to use the `terra-base` component instead which acts as an abstraction around terra-i18n and react-intl's Intl Provider component. See [`terra-base documentation`](https://engineering.cerner.com/terra-core/components/terra-base/base/base) to get started.
However, terra-i18n can be installed with [npmjs](https://www.npmjs.com):
- `npm install terra-i18n`
<!-- AUTO-GENERATED-CONTENT:START Peer Dependencies -->
## Peer Dependencies
This component requires the following peer dependencies be installed in your app for the component to properly function.
| Peer Dependency | Version |
|-|-|
| react | ^16.8.5 |
| react-dom | ^16.8.5 |
| react-intl | ^2.8.0 |
<!-- AUTO-GENERATED-CONTENT:END -->
## Documentation
Documentation for this component is spilt into multiple files.
See the [documentation](https://engineering.cerner.com/terra-ui/components/cerner-terra-core-docs/i-18-n/about).
## LICENSE
Copyright 2017 - 2019 Cerner Innovation, Inc.
Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.