2.0 KiB
| category | type | cols | title |
|---|---|---|---|
| Components | Other | 1 | LocaleProvider |
LocaleProvider provides a uniform localization support for built-in text of components.
Usage
LocaleProvider makes use of context, a feature of React, to accomplish global effectiveness by wrapping the app only once.
import { LocaleProvider } from 'antd';
import fr_FR from 'antd/lib/locale-provider/fr_FR';
import moment from 'moment';
import 'moment/locale/fr';
moment.locale('fr');
...
return <LocaleProvider locale={fr_FR}><App /></LocaleProvider>;
We provide some locales like English, Chinese, Russian, German, French etc. All locale packages can be found in here.
Note: if you need to use antd's UMD dist file, please use antd/dist/antd-with-locales.js and corresponding moment locale:
const { LocaleProvider, locales } = window.antd;
...
return <LocaleProvider locale={locales.fr_FR}><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 and send us a pull request.
Other localization needs
This component aims to provide localization of the built-in text. If you want to support other documents, we recommend using react-intl, refer to Intl demo 1 and Intl demo 2.
API
| Property | Description | Type | Default |
|---|---|---|---|
| locale | language package setting, you can find the packages in antd/lib/locale-provider | object | - |
FAQ
Locale problem is still existed even LocaleProvider is used?
Please make sure you set moment locale by moment.locale('zh-cn'), or you don't have two moment of different version.