mirror/ant-design
1
0
Fork 0
mirror of https://github.com/ant-design/ant-design.git synced 2024-11-24 11:10:01 +08:00
Code Issues Actions 25 Packages Projects Releases Wiki Activity
0e28360622
ant-design/components/config-provider/index.zh-CN.md

15 KiB
Raw Blame History

category subtitle group title cover coverDark
Components 全局化配置 其他 ConfigProvider https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*NVKORa7BCVwAAAAAAAAAAAAADrJ8AQ/original https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*YC4ERpGAddoAAAAAAAAAAAAADrJ8AQ/original

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

使用

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

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

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

export default Demo;

Content Security Policy

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

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

代码演示

国际化 方向 组件尺寸 主题 自定义波纹 静态方法 前缀 获取配置 警告

API

参数 说明 类型 默认值 版本
autoInsertSpaceInButton 设置为 false 时，移除按钮中 2 个汉字之间的空格 boolean true
componentDisabled 设置 antd 组件禁用状态 boolean - 4.21.0
componentSize 设置 antd 组件大小 small | middle | large -
csp 设置 Content Security Policy 配置 { nonce: string } -
direction 设置文本展示方向。 示例 ltr | rtl ltr
getPopupContainer 弹出框（Select, Tooltip, Menu 等等）渲染父节点，默认渲染到 body 上。 function(triggerNode) () => document.body
getTargetContainer 配置 Affix、Anchor 滚动监听容器。 () => HTMLElement () => window 4.2.0
iconPrefixCls 设置图标统一样式前缀 string anticon 4.11.0
locale 语言包配置，语言包可到 antd/locale 目录下寻找 object -
popupMatchSelectWidth 下拉菜单和选择器同宽。默认将设置 min-width，当值小于选择框宽度时会被忽略。false 时会关闭虚拟滚动 boolean | number - 5.5.0
popupOverflow Select 类组件弹层展示逻辑，默认为可视区域滚动，可配置成滚动区域滚动 'viewport' | 'scroll' 'viewport' 5.5.0
prefixCls 设置统一样式前缀 string ant
renderEmpty 自定义组件空状态。参考 空状态 function(componentName: string): ReactNode -
theme 设置主题，参考 定制主题 Theme - 5.0.0
virtual 设置 false 时关闭虚拟滚动 boolean - 4.3.0
warning 设置警告等级，strict 为 false 时会将废弃相关信息聚合为单条信息 { strict: boolean } - 5.10.0

ConfigProvider.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() 5.3.0+

5.2.0 版本后可用。获取父级 Provider 的值。如 DisabledContextProvider、SizeContextProvider。

const {
  componentDisabled, // 5.3.0+
  componentSize, // 5.3.0+
} = ConfigProvider.useConfig();
返回值 说明 类型 默认值 版本
componentDisabled antd 组件禁用状态 boolean - 5.3.0
componentSize antd 组件大小状态 small | middle | large - 5.3.0

组件配置

参数 说明 类型 默认值 版本
alert 设置 Alert 组件的通用属性 { className?: string, style?: React.CSSProperties, closeIcon?: React.ReactNode } - 5.7.0, closeIcon: 5.14.0
anchor 设置 Anchor 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
avatar 设置 Avatar 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
badge 设置 Badge 组件的通用属性 { className?: string, style?: React.CSSProperties, classNames?: { count?: string, indicator?: string }, styles?: { count?: React.CSSProperties, indicator?: React.CSSProperties } } - 5.7.0
breadcrumb 设置 Breadcrumb 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
button 设置 Button 组件的通用属性 { className?: string, style?: React.CSSProperties, classNames?: { icon: string }, styles?: { icon: React.CSSProperties } } - 5.6.0
calendar 设置 Calendar 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
card 设置 Card 组件的通用属性 { className?: string, style?: React.CSSProperties, classNames?: CardProps["classNames"], styles?: CardProps["styles"] } - 5.7.0, classNames 和 styles: 5.14.0
carousel 设置 Carousel 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
cascader 设置 Cascader 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
checkbox 设置 Checkbox 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
collapse 设置 Collapse 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
colorPicker 设置 ColorPicker 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
datePicker 设置 DatePicker 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
rangePicker 设置 RangePicker 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.11.0
descriptions 设置 Descriptions 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
divider 设置 Divider 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
drawer 设置 Drawer 组件的通用属性 { className?: string, style?: React.CSSProperties, classNames?: DrawerProps["classNames"], styles?: DrawerProps["styles"], closeIcon?: ReactNode } - 5.7.0, classNames 和 styles: 5.10.0, closeIcon: 5.14.0
dropdown 设置 Dropdown 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.11.0
empty 设置 Empty 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
flex 设置 Flex 组件的通用属性 { className?: string, style?: React.CSSProperties, vertical?: boolean } - 5.10.0
form 设置 Form 组件的通用属性 { className?: string, style?: React.CSSProperties, validateMessages?: ValidateMessages, requiredMark?: boolean | optional, colon?: boolean, scrollToFirstError?: boolean | Options} - requiredMark: 4.8.0; colon: 4.18.0; scrollToFirstError: 5.2.0; className: 5.7.0; style: 5.7.0
image 设置 Image 组件的通用属性 { className?: string, style?: React.CSSProperties, preview?: { closeIcon?: React.ReactNode } } - 5.7.0, closeIcon: 5.14.0
input 设置 Input 组件的通用属性 { autoComplete?: string, className?: string, style?: React.CSSProperties } - 5.7.0
layout 设置 Layout 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
list 设置 List 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
menu 设置 Menu 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
mentions 设置 Mentions 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
message 设置 Message 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
modal 设置 Modal 组件的通用属性 { className?: string, style?: React.CSSProperties, classNames?: ModalProps["classNames"], styles?: ModalProps["styles"], closeIcon?: React.ReactNode } - 5.7.0, classNames 和 styles: 5.10.0, closeIcon: 5.14.0
notification 设置 Notification 组件的通用属性 { className?: string, style?: React.CSSProperties, closeIcon?: React.ReactNode } - 5.7.0, closeIcon: 5.14.0
pagination 设置 Pagination 组件的通用属性 { showSizeChanger?: boolean, className?: string, style?: React.CSSProperties } - 5.7.0
progress 设置 Progress 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
radio 设置 Radio 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
rate 设置 Rate 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
result 设置 Result 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
skeleton 设置 Skeleton 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
segmented 设置 Segmented 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
select 设置 Select 组件的通用属性 { className?: string, showSearch?: boolean, style?: React.CSSProperties } - 5.7.0
slider 设置 Slider 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
switch 设置 Switch 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
space 设置 Space 的通用属性，参考 Space { size: small | middle | large | number, className?: string, style?: React.CSSProperties, classNames?: { item: string }, styles?: { item: React.CSSProperties } } - 5.6.0
spin 设置 Spin 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
statistic 设置 Statistic 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
steps 设置 Steps 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
table 设置 Table 组件的通用属性 { className?: string, style?: React.CSSProperties, expandable?: { expandIcon?: props => React.ReactNode } } - 5.7.0, expandable: 5.14.0
tabs 设置 Tabs 组件的通用属性 { className?: string, style?: React.CSSProperties, indicator?: { size?: GetIndicatorSize, align?: start | center | end }, moreIcon?: ReactNode, addIcon?: ReactNode } - 5.7.0, moreIcon and addIcon: 5.14.0
tag 设置 Tag 组件的通用属性 { className?: string, style?: React.CSSProperties, closeIcon?: React.ReactNode } - 5.7.0, closeIcon: 5.14.0
timeline 设置 Timeline 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
timePicker 设置 TimePicker 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
tour 设置 Tour 组件的通用属性 { closeIcon?: React.ReactNode } - 5.14.0
transfer 设置 Transfer 组件的通用属性 { className?: string, style?: React.CSSProperties, selectionsIcon?: React.ReactNode } - 5.7.0, selectionsIcon: 5.14.0
tree 设置 Tree 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
typography 设置 Typography 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
upload 设置 Upload 组件的通用属性 { className?: string, style?: React.CSSProperties } - 5.7.0
wave 设置水波纹特效 { disabled?: boolean, showEffect?: (node: HTMLElement, info: { className, token, component }) => void } - 5.8.0

FAQ

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

参考《增加语言包》。

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

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

配置 getPopupContainer 导致 Modal 报错？

相关 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。

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

Vite 生产模式打包后国际化 locale 设置不生效？

相关 issue：#39045

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

prefixCls 优先级(前者被后者覆盖)

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