ant-design/components/config-provider/index.zh-CN.md
Tom Xu 7e782daec0
feat: ConfigProvider add form requiredMark (#27322)
* feat: ConfigProvider add form requiredMark

* Update Form.tsx
2020-10-24 14:27:49 +08:00

4.0 KiB
Raw Blame History

category subtitle cols type title cover
Components 全局化配置 1 其他 ConfigProvider https://gw.alipayobjects.com/zos/alicdn/kegYxl1wj/ConfigProvider.svg

为组件提供统一的全局化配置。

使用

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

import { ConfigProvider } from 'antd';

// ...

export default () => (
  <ConfigProvider direction="rtl">
    <App />
  </ConfigProvider>
);

Content Security Policy

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

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

API

参数 说明 类型 默认值 版本
autoInsertSpaceInButton 设置为 false 时,移除按钮中 2 个汉字之间的空格 boolean true
componentSize 设置 antd 组件大小 small | middle | large -
csp 设置 Content Security Policy 配置 { nonce: string } -
direction 设置文本展示方向。 示例 ltr | rtl ltr
dropdownMatchSelectWidth 下拉菜单和选择器同宽。默认将设置 min-width,当值小于选择框宽度时会被忽略。false 时会关闭虚拟滚动 boolean | number - 4.3.0
form 设置 Form 组件的通用属性 { validateMessages?: ValidateMessages, requiredMark?: boolean | optional } - requiredMark: 4.8.0
getPopupContainer 弹出框Select, Tooltip, Menu 等等)渲染父节点,默认渲染到 body 上。 function(triggerNode) () => document.body
getTargetContainer 配置 Affix、Anchor 滚动监听容器。 () => HTMLElement () => window 4.2.0
input 设置 Input 组件的通用属性 { autoComplete?: string } - 4.2.0
locale 语言包配置,语言包可到 antd/es/locale 目录下寻找 object -
pageHeader 统一设置 PageHeader 的 ghost参考 PageHeader { ghost: boolean } true
prefixCls 设置统一样式前缀。注意:需要配合 less 变量 @ant-prefix 使用 string ant
renderEmpty 自定义组件空状态。参考 空状态 function(componentName: string): ReactNode -
space 设置 Space 的 size,参考 Space { size: small | middle | large | number } - 4.1.0
virtual 设置 false 时关闭虚拟滚动 boolean - 4.3.0

FAQ

如何增加一个新的语言包?

参考《增加语言包》

为什么我使用了 ConfigProvider locale,时间类组件的国际化还有问题?

请检查是否正确设置了 moment 语言包,或者是否有两个版本的 moment 共存。

import 'moment/locale/zh-cn';
moment.locale('zh-cn');

配置 getPopupContainer 导致 Modal 报错?

相关 issuehttps://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>