2018-11-26 12:06:42 +08:00
---
category: Components
type: Other
cols: 1
title: ConfigProvider
2020-05-31 11:48:34 +08:00
cover: https://gw.alipayobjects.com/zos/alicdn/kegYxl1wj/ConfigProvider.svg
2018-11-26 12:06:42 +08:00
---
`ConfigProvider` provides a uniform configuration support for components.
## Usage
2019-11-21 07:39:57 +08:00
This component provides a configuration to all React components underneath itself via the [context API ](https://facebook.github.io/react/docs/context.html ). In the render tree all components will have access to the provided config.
2018-11-26 12:06:42 +08:00
```jsx
import { ConfigProvider } from 'antd';
// ...
return (
< ConfigProvider { . . . yourConfig } >
< App / >
< / ConfigProvider >
);
```
2019-01-09 20:15:37 +08:00
### Content Security Policy
2019-11-21 07:39:57 +08:00
Some components use dynamic style to support wave effect. You can config `csp` prop if Content Security Policy (CSP) is enabled:
2019-01-09 20:15:37 +08:00
```jsx
< ConfigProvider csp = {{ nonce: ' YourNonceCode ' } } >
< Button > My Button< / Button >
< / ConfigProvider >
```
2018-11-26 12:06:42 +08:00
## API
2019-07-11 14:14:33 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
2019-11-21 19:58:41 +08:00
| autoInsertSpaceInButton | Set `false` to remove space between 2 chinese characters on Button | boolean | true | |
2020-01-17 17:23:48 +08:00
| componentSize | Config antd component size | `small` \| `middle` \| `large` | - | |
2019-11-21 19:58:41 +08:00
| csp | Set [Content Security Policy ](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP ) config | { nonce: string } | - | |
| form | Set Form common props | { validateMessages?: [ValidateMessages ](/components/form/#validateMessages ) } | - | |
2020-04-22 10:38:43 +08:00
| input | Set Input common props | { autoComplete?: string } | - | 4.2.0 |
2019-11-21 19:58:41 +08:00
| renderEmpty | set empty content of components. Ref [Empty ](/components/empty/ ) | Function(componentName: string): ReactNode | - | |
2020-06-17 23:18:14 +08:00
| getPopupContainer | to set the container of the popup element. The default is to create a `div` element in `body` . | Function(triggerNode) | () => document.body | |
2020-04-29 20:22:16 +08:00
| getTargetContainer | Config Affix, Anchor scroll target container. | () => HTMLElement | () => window | 4.2.0 |
2019-11-21 19:58:41 +08:00
| locale | language package setting, you can find the packages in [antd/es/locale ](http://unpkg.com/antd/es/locale/ ) | object | |
2020-06-17 23:18:14 +08:00
| prefixCls | set prefix class. `Note:` This will discard default styles from `antd` . | string | `ant` | |
2020-05-05 15:00:43 +08:00
| pageHeader | Unify the ghost of PageHeader, ref [PageHeader ](/components/page-header ) | { ghost:boolean } | true | |
2020-01-17 17:23:48 +08:00
| direction | set direction of layout. See [demo ](#components-config-provider-demo-direction ) | `ltr` \| `rtl` | `ltr` | |
2020-03-22 11:38:02 +08:00
| space | set Space `size` , ref [Space ](/components/space ) | { size: `small` \| `middle` \| `large` \| `number` } | - | 4.1.0 |
2020-05-05 15:00:43 +08:00
| virtual | Disable virtual scroll when set to `false` | boolean | - | 4.3.0 |
2020-06-24 13:36:51 +08:00
| dropdownMatchSelectWidth | Determine whether the dropdown menu and the select input are the same width. Default set `min-width` same as input. Will ignore when value less than select width. `false` will disable virtual scroll | boolean \| number | - | 4.3.0 |
2019-11-09 16:24:07 +08:00
## FAQ
2020-05-27 20:05:13 +08:00
#### How to contribute a new language?
See [<Adding new language> ](/docs/react/i18n#Adding-newplanguage ).
2019-11-21 07:39:57 +08:00
#### Does the locale problem still exist in DatePicker even if ConfigProvider `locale` is used?
2019-11-09 16:24:07 +08:00
2020-05-06 12:03:46 +08:00
Please make sure you set moment locale or that you don't have two different versions of moment.
```js
import 'moment/locale/zh-cn';
moment.locale('zh-cn');
```
2019-12-09 19:40:43 +08:00
#### Modal throw error when setting `getPopupContainer`?
Related issue: https://github.com/ant-design/ant-design/issues/19974
When you config `getPopupContainer` to parentNode globally, Modal will throw error of `triggerNode is undefined` because it did not have a triggerNode. You can try the [fix ](https://github.com/afc163/feedback-antd/commit/3e4d1ad1bc1a38460dc3bf3c56517f737fe7d44a ) below.
```diff
< ConfigProvider
- getPopupContainer={triggerNode => triggerNode.parentNode}
+ getPopupContainer={node => {
+ if (node) {
+ return node.parentNode;
+ }
+ return document.body;
+ }}
>
< App / >
< / ConfigProvider >
```