ant-design/components/config-provider/index.en-US.md
zombieJ 81d8eb8afe
feat: ConfigProvider support locale (#17816)
* ConfigProvider support locale

* update docs

* update category

* clean up

* moving locale

* update check script

* update related code

* add test case

* demo link

* update doc

* hide one rule of md with eslint

* update error link
2019-07-24 10:34:55 +08:00

1.6 KiB

category type cols title
Components Other 1 ConfigProvider

ConfigProvider provides a uniform configuration support for components.

Usage

This component provides a configuration to all React components underneath itself via the context API, In the render tree all components will have access to the provided config.

import { ConfigProvider } from 'antd';

// ...

return (
  <ConfigProvider {...yourConfig}>
    <App />
  </ConfigProvider>
);

Content Security Policy

Some component use dynamic style to support wave effect. You can config csp prop if Content Security Policy (CSP) is enabled:

<ConfigProvider csp={{ nonce: 'YourNonceCode' }}>
  <Button>My Button</Button>
</ConfigProvider>

API

Property Description Type Default Version
autoInsertSpaceInButton Set false to remove space between 2 chinese characters on Button boolean true 3.13.0
csp Set Content Security Policy config { nonce: string } - 3.13.1
renderEmpty set empty content of components. Ref Empty Function(componentName: string): ReactNode - 3.12.2
getPopupContainer to set the container of the popup element. The default is to create a div element in body. Function(triggerNode) () => document.body 3.11.0
locale language package setting, you can find the packages in antd/es/locale object 3.21.0
prefixCls set prefix class string ant 3.12.0