mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-11 23:00:20 +08:00
48 lines
1.7 KiB
Markdown
48 lines
1.7 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 { LocaleProvider } from 'antd';
|
|
import enUS from 'antd/lib/locale-provider/en_US';
|
|
|
|
...
|
|
|
|
return <LocaleProvider locale={enUS}><App /></LocaleProvider>;
|
|
```
|
|
|
|
We provide some locale like English, Chinese, Russian, German, French and etc, all locale packages can be found in [here](https://github.com/ant-design/ant-design/blob/master/components/locale-provider/).
|
|
|
|
Note: if you need to use antd's UMD dist file, please import `antd/dist/antd-with-locales.js`:
|
|
|
|
```jsx
|
|
const { LocaleProvider, locales } = window.antd;
|
|
|
|
...
|
|
|
|
return <LocaleProvider locale={locales.en_US}><App /></LocaleProvider>;
|
|
```
|
|
|
|
### Add a new language
|
|
|
|
If you can't find your language, you are welcome to create a locale package based on [en_US](https://github.com/ant-design/ant-design/blob/master/components/locale-provider/en_US.tsx) 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 | - |
|