2018-11-26 12:06:42 +08:00
---
category: Components
2022-11-09 12:28:04 +08:00
group: Other
2018-11-26 12:06:42 +08:00
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';
// ...
2020-08-03 14:35:11 +08:00
export default () => (
< ConfigProvider direction = "rtl" >
2018-11-26 12:06:42 +08:00
< 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 >
```
2022-11-09 12:28:04 +08:00
## Examples
2022-11-17 17:31:26 +08:00
<!-- prettier - ignore -->
2022-11-09 12:28:04 +08:00
< code src = "./demo/locale.tsx" > Locale< / code >
< code src = "./demo/direction.tsx" > Direction< / code >
< code src = "./demo/size.tsx" > Component size< / code >
< code src = "./demo/theme.tsx" > Theme< / code >
< code src = "./demo/prefixCls.tsx" debug > prefixCls< / code >
2018-11-26 12:06:42 +08:00
## API
2022-11-17 17:31:26 +08:00
| Property | Description | Type | Default | Version |
| --- | --- | --- | --- | --- |
| autoInsertSpaceInButton | Set false to remove space between 2 chinese characters on Button | boolean | true | |
| componentDisabled | Config antd component `disabled` | boolean | - | 4.21.0 |
| componentSize | Config antd component size | `small` \| `middle` \| `large` | - | |
| csp | Set [Content Security Policy ](https://developer.mozilla.org/en-US/docs/Web/HTTP/CSP ) config | { nonce: string } | - | |
| direction | Set direction of layout. See [demo ](#components-config-provider-demo-direction ) | `ltr` \| `rtl` | `ltr` | |
| 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 |
| form | Set Form common props | { validateMessages?: [ValidateMessages ](/components/form/#validateMessages ), requiredMark?: boolean \| `optional` } | - | requiredMark: 4.8.0 |
| getPopupContainer | To set the container of the popup element. The default is to create a `div` element in `body` | function(triggerNode) | () => document.body | |
| getTargetContainer | Config Affix, Anchor scroll target container | () => HTMLElement | () => window | 4.2.0 |
| iconPrefixCls | Set icon prefix className | string | `anticon` | 4.11.0 |
| input | Set Input common props | { autoComplete?: string } | - | 4.2.0 |
| locale | Language package setting, you can find the packages in [antd/locale ](http://unpkg.com/antd/locale/ ) | object | - | |
| prefixCls | Set prefix className | string | `ant` | |
| renderEmpty | Set empty content of components. Ref [Empty ](/components/empty/ ) | function(componentName: string): ReactNode | - | |
| space | Set Space `size` , ref [Space ](/components/space ) | { size: `small` \| `middle` \| `large` \| `number` } | - | 4.1.0 |
| theme | Set theme, ref [Customize Theme ](/docs/react/customize-theme-v5 ) | - | - | 5.0.0 |
| virtual | Disable virtual scroll when set to `false` | boolean | - | 4.3.0 |
2019-11-09 16:24:07 +08:00
2021-02-09 21:49:15 +08:00
### ConfigProvider.config() `4.13.0+`
2021-03-16 09:33:16 +08:00
Setting `Modal` 、`Message`、`Notification` rootPrefixCls.
2021-02-09 21:49:15 +08:00
```jsx
ConfigProvider.config({
2021-06-09 15:36:59 +08:00
prefixCls: 'ant', // 4.13.0+
iconPrefixCls: 'anticon', // 4.17.0+
2021-02-09 21:49:15 +08:00
});
```
2019-11-09 16:24:07 +08:00
## FAQ
2020-05-27 20:05:13 +08:00
#### How to contribute a new language?
2022-11-09 12:28:04 +08:00
See [<Adding new language> ](/docs/react/i18n#Adding-newplanguage ).
2020-05-27 20:05:13 +08:00
2022-07-12 13:10:20 +08:00
#### Date-related components locale is not working?
2019-11-09 16:24:07 +08:00
2022-07-12 13:10:20 +08:00
See FAQ [Date-related-components-locale-is-not-working? ](/docs/react/faq#Date-related-components-locale-is-not-working? )
2019-12-09 19:40:43 +08:00
#### Modal throw error when setting `getPopupContainer`?
2020-10-21 10:33:43 +08:00
Related issue: < https: / / github . com / ant-design / ant-design / issues / 19974 >
2019-12-09 19:40:43 +08:00
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 >
```