mirror of
https://github.com/ant-design/ant-design.git
synced 2024-11-30 06:09:34 +08:00
36 lines
1.3 KiB
Markdown
36 lines
1.3 KiB
Markdown
|
---
|
||
|
|
category: Components
|
||
|
|
type: Other
|
||
|
|
cols: 1
|
||
|
|
title: LocaleProvider
|
||
|
|
---
|
||
|
|
|
||
|
|
`LocaleProvider` provides a uniform localization support for built-in text of components.
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
`LocaleProvider` takes use of [context](https://facebook.github.io/react/docs/context.html), a feature of React, to accomplish global effectiveness by wrapping the app only once.
|
||
|
|
|
||
|
|
|
||
|
|
```jsx
|
||
|
|
import enUS from 'antd/lib/locale-provider/en_US';
|
||
|
|
|
||
|
|
...
|
||
|
|
|
||
|
|
return <LocaleProvider locale={enUS}><App /></LocaleProvider>;
|
||
|
|
```
|
||
|
|
|
||
|
|
### Add a language
|
||
|
|
|
||
|
|
We supply an English locale package. Other language users can create a locale package based on [en_US](https://github.com/ant-design/ant-design/blob/26b1f37392a278285aec6c573b99c6feea09e218/components/locale-provider/en_US.js) and send us a pull request.
|
||
|
|
|
||
|
|
### Other localization needs
|
||
|
|
|
||
|
|
This component aims for localization of the built-in text, if you want to support other documents, we recommend using [react-intl](https://github.com/yahoo/react-intl), refer to [Intl demo 1](http://github.com/ant-design/intl-example) and [Intl demo 2](http://yiminghe.me/learning-react/examples/react-intl.html?locale=en-US).
|
||
|
|
|
||
|
|
## API
|
||
|
|
|
||
|
|
Property | Description | Type | Default
|
||
|
|
-----|-----|-----|------
|
||
|
|
locale | language package setting, you can find the packages in this path: `antd/lib/locale-provider/` | Object | -
|