使用import { Modal } from 'antd'; |
文档贡献者
需要用户处理事务，又不希望跳转页面以致打断工作流程时，可以使用 Modal 在当前页面正中打开一个浮层，承载相应的操作。
另外当需要一个简洁的确认框询问用户时，可以使用 App.useApp 封装的语法糖方法。
通用属性参考：通用属性
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| afterClose | Modal 完全关闭后的回调 | function | - | |
| cancelButtonProps | cancel 按钮 props | ButtonProps | - | |
| cancelText | 取消按钮文字 | ReactNode | 取消 | |
| centered | 垂直居中展示 Modal | boolean | false | |
| classNames | 用于自定义 Modal 组件内部各语义化结构的 class，支持对象或函数 | Record<SemanticDOM, string> | (info: { props }) => Record<SemanticDOM, string> | - | |
| closable | 是否显示右上角的关闭按钮 | boolean | ClosableType | true | - |
| closeIcon | 自定义关闭图标。5.7.0：设置为 null 或 false 时隐藏关闭按钮 | ReactNode | <CloseOutlined /> | |
| confirmLoading | 确定按钮 loading | boolean | false | |
| 关闭时销毁 Modal 里的子元素 | boolean | false | ||
| destroyOnHidden | 关闭时销毁 Modal 里的子元素 | boolean | false | 5.25.0 |
对话框关闭后是否需要聚焦触发元素。请使用 focusable.focusTriggerAfterClose 替代 | boolean | true | 4.9.0 | |
| footer | 底部内容，当不需要默认底部按钮时，可以设为 footer={null} | ReactNode | (originNode: ReactNode, extra: { OkBtn: React.FC, CancelBtn: React.FC }) => ReactNode | (确定取消按钮) | renderFunction: 5.9.0 |
| forceRender | 强制渲染 Modal | boolean | false | |
| focusable | 对话框内焦点管理的配置 | { trap?: boolean, focusTriggerAfterClose?: boolean } | - | 6.2.0 |
| getContainer | 指定 Modal 挂载的节点，但依旧为全屏展示，false 为挂载在当前位置 | HTMLElement | () => HTMLElement | Selectors | false | document.body | |
| keyboard | 是否支持键盘 esc 关闭 | boolean | true | |
| mask | 遮罩效果 | boolean | {enabled: boolean, blur: boolean, closable?: boolean} | true | mask.closable: 6.3.0 |
| maskClosable | 点击蒙层是否允许关闭 | boolean | true | |
| modalRender | 自定义渲染对话框 | (node: ReactNode) => ReactNode | - | 4.7.0 |
| okButtonProps | ok 按钮 props | ButtonProps | - | |
| okText | 确认按钮文字 | ReactNode | 确定 | |
| okType | 确认按钮类型 | string | primary | |
| style | 可用于设置浮层的样式，调整浮层位置等 | CSSProperties | - | |
| styles | 用于自定义 Modal 组件内部各语义化结构的行内 style，支持对象或函数 | Record<SemanticDOM, CSSProperties> | (info: { props }) => Record<SemanticDOM, CSSProperties> | - | |
| loading | 显示骨架屏 | boolean | 5.18.0 | |
| title | 标题 | ReactNode | - | |
| open | 对话框是否可见 | boolean | - | |
| width | 宽度 | string | number | Breakpoint | 520 | Breakpoint: 5.23.0 |
| wrapClassName | 对话框外层容器的类名 | string | - | |
| zIndex | 设置 Modal 的 z-index | number | 1000 | |
| onCancel | 点击遮罩层或右上角叉或取消按钮的回调 | function(e) | - | |
| onOk | 点击确定回调 | function(e) | - | |
| afterOpenChange | 打开和关闭 Modal 时动画结束后的回调 | (open: boolean) => void | - | 5.4.0 |
<Modal /> 默认关闭后状态不会自动清空，如果希望每次打开都是新内容，请设置 destroyOnHidden。<Modal /> 和 Form 一起配合使用时，设置 destroyOnHidden 也不会在 Modal 关闭时销毁表单字段数据，需要设置 <Form preserve={false} />。Modal.method() RTL 模式仅支持 hooks 用法。包括：
Modal.infoModal.successModal.errorModal.warningModal.confirm以上均为一个函数，参数为 object，具体属性如下：
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| afterClose | Modal 完全关闭后的回调 | function | - | 4.9.0 |
指定自动获得焦点的按钮。请使用 focusable.autoFocusButton 替代 | null | ok | cancel | ok | ||
| cancelButtonProps | cancel 按钮 props | ButtonProps | - | |
| cancelText | 设置 Modal.confirm 取消按钮文字 | string | 取消 | |
| centered | 垂直居中展示 Modal | boolean | false | |
| className | 容器类名 | string | - | |
| closable | 是否显示右上角的关闭按钮 | boolean | ClosableType | false | - |
| closeIcon | 自定义关闭图标 | ReactNode | undefined | 4.9.0 |
| content | 内容 | ReactNode | - | |
| focusable.autoFocusButton | 指定自动获得焦点的按钮 | null | ok | cancel | ok | 6.2.0 |
| footer | 底部内容，当不需要默认底部按钮时，可以设为 footer: null | ReactNode | (originNode: ReactNode, extra: { OkBtn: React.FC, CancelBtn: React.FC }) => ReactNode | - | renderFunction: 5.9.0 |
| getContainer | 指定 Modal 挂载的 HTML 节点，false 为挂载在当前 dom | HTMLElement | () => HTMLElement | Selectors | false | document.body | |
| icon | 自定义图标 | ReactNode | <ExclamationCircleFilled /> | |
| keyboard | 是否支持键盘 esc 关闭 | boolean | true | |
| mask | 遮罩效果 | boolean | {enabled?: boolean, blur?: boolean, closable?: boolean} | true | |
| 点击蒙层是否允许关闭 | boolean | false | ||
| okButtonProps | ok 按钮 props | ButtonProps | - | |
| okText | 确认按钮文字 | string | 确定 | |
| okType | 确认按钮类型 | string | primary | |
| style | 可用于设置浮层的样式，调整浮层位置等 | CSSProperties | - | |
| title | 标题 | ReactNode | - | |
| width | 宽度 | string | number | 416 | |
| wrapClassName | 对话框外层容器的类名 | string | - | 4.18.0 |
| zIndex | 设置 Modal 的 z-index | number | 1000 | |
| onCancel | 点击取消回调，参数为关闭函数，若返回 promise 时 resolve 为正常关闭, reject 为不关闭 | function(close) | - | |
| onOk | 点击确定回调，参数为关闭函数，若返回 promise 时 resolve 为正常关闭, reject 为不关闭 | function(close) | - |
以上函数调用后，会返回一个引用，可以通过该引用更新和关闭弹窗。
| 参数 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| afterClose | Modal 完全关闭后的回调 | function | - | - |
| closeIcon | 自定义关闭图标 | ReactNode | undefined | - |
| disabled | 关闭图标是否禁用 | boolean | false | - |
| onClose | 弹窗关闭即时调用 | Function | undefined | - |
const modal = Modal.info();modal.update({title: '修改的标题',content: '修改的内容',});// 在 4.8.0 或更高版本中，可以通过传入函数的方式更新弹窗modal.update((prevConfig) => ({...prevConfig,title: `${prevConfig.title}（新）`,}));modal.destroy();
Modal.destroyAll使用 Modal.destroyAll() 可以销毁弹出的确认窗（即上述的 Modal.info、Modal.success、Modal.error、Modal.warning、Modal.confirm）。通常用于路由监听当中，处理路由前进、后退不能销毁确认对话框的问题，而不用各处去使用实例的返回值进行关闭（modal.destroy() 适用于主动关闭，而不是路由这样被动关闭）
import { browserHistory } from 'react-router';// router changebrowserHistory.listen(() => {Modal.destroyAll();});
当你需要使用 Context 时，可以通过 Modal.useModal 创建一个 contextHolder 插入子节点中。通过 hooks 创建的临时 Modal 将会得到 contextHolder 所在位置的所有上下文。创建的 modal 对象拥有与 Modal.method 相同的创建通知方法。
const [modal, contextHolder] = Modal.useModal();React.useEffect(() => {modal.confirm({// ...});}, []);return <div>{contextHolder}</div>;
modal.confirm 返回方法：
destroy：销毁当前窗口update：更新当前窗口then：Promise 链式调用，支持 await 操作。该方法为 Hooks 仅有//点击 `onOk` 时返回 `true`，点击 `onCancel` 时返回 `false`const confirmed = await modal.confirm({ ... });
| Token 名称 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| contentBg | 内容区域背景色 | string | #ffffff |
| footerBg | 底部区域背景色 | string | transparent |
| headerBg | 顶部背景色 | string | transparent |
| titleColor | 标题字体颜色 | string | rgba(0,0,0,0.88) |
| titleFontSize | 标题字体大小 | string | number | 16 |
| titleLineHeight | 标题行高 | string | number | 1.5 |
| Token 名称 | 描述 | 类型 | 默认值 |
|---|---|---|---|
| colorBgMask | 浮层的背景蒙层颜色，用于遮罩浮层下面的内容，Modal、Drawer、Image 等组件的蒙层使用的是该 token | string | rgba(0,0,0,0.45) |
| colorBgTextActive | 控制文本在激活状态下的背景色。 | string | rgba(0,0,0,0.15) |
| colorBgTextHover | 控制文本在悬停状态下的背景色。 | string | rgba(0,0,0,0.06) |
| colorIcon | 控制弱操作图标的颜色，例如 allowClear 或 Alert 关闭按钮。 * | string | rgba(0,0,0,0.45) |
| colorIconHover | 控制弱操作图标在悬浮状态下的颜色，例如 allowClear 或 Alert 关闭按钮。 | string | rgba(0,0,0,0.88) |
| colorPrimaryBorder | 主色梯度下的描边用色，用在 Slider 等组件的描边上。 | string | #91caff |
| colorSplit | 用于作为分割线的颜色，此颜色和 colorBorderSecondary 的颜色一致，但是用的是透明色。 | string | rgba(5,5,5,0.06) |
| colorText | 最深的文本色。为了符合W3C标准，默认的文本颜色使用了该色，同时这个颜色也是最深的中性色。 | string | rgba(0,0,0,0.88) |
| borderRadiusLG | LG号圆角，用于组件中的一些大圆角，如 Card、Modal 等一些组件样式。 | number | 8 |
| borderRadiusSM | SM号圆角，用于组件小尺寸下的圆角，如 Button、Input、Select 等输入类控件在 small size 下的圆角 | number | 4 |
| boxShadow | 控制元素阴影样式。 | string | 0 6px 16px 0 rgba(0,0,0,0.08), 0 3px 6px -4px rgba(0,0,0,0.12), 0 9px 28px 8px rgba(0,0,0,0.05) |
| controlHeight | Ant Design 中按钮和输入框等基础控件的高度 | number | 32 |
| fontFamily | Ant Design 的字体家族中优先使用系统默认的界面字体，同时提供了一套利于屏显的备用字体库，来维护在不同平台以及浏览器的显示下，字体始终保持良好的易读性和可读性，体现了友好、稳定和专业的特性。 | string | -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, 'Noto Sans', sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji' |
| fontSize | 设计系统中使用最广泛的字体大小，文本梯度也将基于该字号进行派生。 | number | 14 |
| fontSizeHeading5 | h5 标签使用的字号 | string | number | 16 |
| fontSizeLG | 大号字体大小 | number | 16 |
| fontWeightStrong | 控制标题类组件（如 h1、h2、h3）或选中项的字体粗细。 | number | 600 |
| lineHeight | 文本行高 | number | 1.5714285714285714 |
| lineHeightHeading5 | h5 标签所使用的行高 | number | 1.5 |
| lineType | 用于控制组件边框、分割线等的样式，默认是实线 | string | solid |
| lineWidth | 用于控制组件边框、分割线等的宽度 | number | 1 |
| lineWidthFocus | 控制线条的宽度，当组件处于聚焦态时。 | number | 3 |
| margin | 控制元素外边距，中等尺寸。 | number | 16 |
| marginXS | 控制元素外边距，小尺寸。 | number | 8 |
| motionDurationMid | 动效播放速度，中速。用于中型元素动画交互 | string | 0.2s |
| motionDurationSlow | 动效播放速度，慢速。用于大型元素如面板动画交互 | string | 0.3s |
| motionEaseInOutCirc | 预设动效曲率 | string | |
| motionEaseOutCirc | 预设动效曲率 | string | |
| padding | 控制元素的内间距。 | number | 16 |
| screenLGMin | 控制大屏幕的最小宽度。 | number | 992 |
| screenMDMin | 控制中等屏幕的最小宽度。 | number | 768 |
| screenSMMax | 控制小屏幕的最大宽度。 | number | 767 |
| screenSMMin | 控制小屏幕的最小宽度。 | number | 576 |
| screenXLMin | 控制超大屏幕的最小宽度。 | number | 1200 |
| screenXSMin | 控制超小屏幕的最小宽度。 | number | 480 |
| screenXXLMin | 控制超超大屏幕的最小宽度。 | number | 1600 |
| screenXXXLMin | 控制超超超大屏幕的最小宽度。 | number | 1920 |
| zIndexPopupBase | 浮层类组件的基础 Z 轴值，用于一些悬浮类的组件的可以基于该值 Z 轴控制层级，例如 FloatButton、 Affix、Modal 等 | number | 1000 |
Modal 在关闭时会将内容进行 memo 从而避免关闭过程中的内容跳跃。也因此如果你在配合使用 Form 有关闭时重置 initialValues 的操作，请通过在 effect 中调用 resetFields 来重置。
locale/prefixCls/theme 等配置？直接调用 Modal 方法，antd 会通过 ReactDOM.render 动态创建新的 React 实体。其 context 与当前代码所在 context 并不相同，因而无法获取 context 信息。
当你需要 context 信息（例如 ConfigProvider 配置的内容）时，可以通过 Modal.useModal 方法会返回 modal 实体以及 contextHolder 节点。将其插入到你需要获取 context 位置即可：
const [modal, contextHolder] = Modal.useModal();return (<Context1.Provider value="Ant">{/* contextHolder 在 Context1 内，它可以获得 Context1 的 context */}{contextHolder}<Context2.Provider value="Design">{/* contextHolder 在 Context2 外，因而不会获得 Context2 的 context */}</Context2.Provider></Context1.Provider>);
异同：通过 hooks 创建的 contextHolder 必须插入到子元素节点中才会生效，当你不需要上下文信息时请直接调用。
可通过 App 包裹组件 简化
useModal等方法需要手动植入 contextHolder 的问题。
你可以通过 ConfigProvider.config 进行设置。