ConfigProvider

使用 {#usage}

ConfigProvider 使用 React 的 context 特性，只需在应用外围包裹一次即可全局生效。

import React from 'react';
import { ConfigProvider } from 'antd';

// ...
const Demo: React.FC = () => (
  <ConfigProvider direction="rtl">
    <App />
  </ConfigProvider>
);

export default Demo;

内容安全策略（CSP）{#csp}

部分组件为了支持波纹效果，使用了动态样式。如果开启了 Content Security Policy (CSP)，你可以通过 csp 属性来进行配置：

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

代码演示 {#examples}

<code src="./demo/locale.tsx">国际化</code> <code src="./demo/direction.tsx">方向</code> <code src="./demo/size.tsx">组件尺寸</code> <code src="./demo/theme.tsx">主题</code> <code src="./demo/wave.tsx">自定义波纹</code> <code src="./demo/holderRender.tsx">静态方法</code> <code src="./demo/prefixCls.tsx" debug>前缀</code> <code src="./demo/useConfig.tsx" debug>获取配置</code> <code src="./demo/warning.tsx" debug>警告</code>

API

ConfigProvider.config() {#config}

设置 Modal、Message、Notification 静态方法配置，只会对非 hooks 的静态方法调用生效。

ConfigProvider.config({
  // 5.13.0+
  holderRender: (children) => (
    <ConfigProvider
      prefixCls="ant"
      iconPrefixCls="anticon"
      theme={{ token: { colorPrimary: 'red' } }}
    >
      {children}
    </ConfigProvider>
  ),
});

ConfigProvider.useConfig() <Badge>5.3.0+</Badge> {#useconfig}

获取父级 Provider 的值，如 DisabledContextProvider、SizeContextProvider。

const {
  componentDisabled, // 5.3.0+
  componentSize, // 5.3.0+
} = ConfigProvider.useConfig();

组件配置 {#component-config}

FAQ

如何增加一个新的语言包？ {#faq-add-locale}

参考《增加语言包》。

为什么时间类组件的国际化 locale 设置不生效？ {#faq-locale-not-work}

参考 FAQ 为什么时间类组件的国际化 locale 设置不生效？。

配置 getPopupContainer 导致 Modal 报错？ {#faq-get-popup-container}

相关 issue：https://github.com/ant-design/ant-design/issues/19974

当如下全局设置 getPopupContainer 为触发节点的 parentNode 时，由于 Modal 的用法不存在 triggerNode，这样会导致 triggerNode is undefined 的报错，需要增加一个判断条件。

 <ConfigProvider
-  getPopupContainer={triggerNode => triggerNode.parentNode}
+  getPopupContainer={node => {
+    if (node) {
+      return node.parentNode;
+    }
+    return document.body;
+  }}
 >
   <App />
 </ConfigProvider>

为什么 message.info、notification.open 或 Modal.confirm 等方法内的 ReactNode 无法继承 ConfigProvider 的属性？比如 prefixCls 和 theme。 {#faq-message-inherit}

静态方法是使用 ReactDOM.render 重新渲染一个 React 根节点上，和主应用的 React 节点是脱离的。我们建议使用 useMessage、useNotification 和 useModal 来使用相关方法。原先的静态方法在 5.0 中已被废弃。

Vite 生产模式打包后国际化 locale 设置不生效？ {#faq-vite-locale-not-work}

相关 issue：#39045

由于 Vite 生产模式下打包与开发模式不同，cjs 格式的文件会多一层，需要 zhCN.default 来获取。推荐 Vite 用户直接从 antd/es/locale 目录下引入 esm 格式的 locale 文件。

prefixCls 优先级(前者被后者覆盖) {#faq-prefixcls-priority}

1. ConfigProvider.config({ prefixCls: 'prefix-1' })
2. ConfigProvider.config({ holderRender: (children) => <ConfigProvider prefixCls="prefix-2">{children}</ConfigProvider> })
3. message.config({ prefixCls: 'prefix-3' })