Modal

何时使用 {#when-to-use}

需要用户处理事务，又不希望跳转页面以致打断工作流程时，可以使用 Modal 在当前页面正中打开一个浮层，承载相应的操作。

另外当需要一个简洁的确认框询问用户时，可以使用 App.useApp 封装的语法糖方法。

代码演示 {#examples}

<code src="./demo/basic.tsx">基本</code> <code src="./demo/async.tsx">异步关闭</code> <code src="./demo/footer.tsx">自定义页脚</code> <code src="./demo/mask.tsx">遮罩</code> <code src="./demo/loading.tsx" version="5.18.0">加载中</code> <code src="./demo/footer-render.tsx" version="5.9.0">自定义页脚渲染函数</code> <code src="./demo/hooks.tsx">使用 hooks 获得上下文</code> <code src="./demo/locale.tsx">国际化</code> <code src="./demo/manual.tsx">手动更新和移除</code> <code src="./demo/position.tsx">自定义位置</code> <code src="./demo/dark.tsx" debug>调试使用</code> <code src="./demo/button-props.tsx">自定义页脚按钮属性</code> <code src="./demo/modal-render.tsx">自定义渲染对话框</code> <code src="./demo/width.tsx">自定义模态的宽度</code> <code src="./demo/static-info.tsx">静态方法</code> <code src="./demo/confirm.tsx">静态确认对话框</code> <code src="./demo/confirm-router.tsx">销毁确认对话框</code> <code src="./demo/style-class.tsx" version="6.0.0">自定义语义结构的样式和类</code> <code src="./demo/nested.tsx" debug>嵌套弹框</code> <code src="./demo/render-panel.tsx" debug>_InternalPanelDoNotUseOrYouWillBeFired</code> <code src="./demo/custom-mouse-position.tsx" debug>控制弹框动画原点</code> <code src="./demo/wireframe.tsx" debug>线框风格</code> <code src="./demo/component-token.tsx" debug>组件 Token</code>

API

通用属性参考：通用属性

注意

• <Modal /> 默认关闭后状态不会自动清空，如果希望每次打开都是新内容，请设置 destroyOnHidden。
• <Modal /> 和 Form 一起配合使用时，设置 destroyOnHidden 也不会在 Modal 关闭时销毁表单字段数据，需要设置 <Form preserve={false} />。
• Modal.method() RTL 模式仅支持 hooks 用法。

Modal.method()

包括：

• Modal.info
• Modal.success
• Modal.error
• Modal.warning
• Modal.confirm

以上均为一个函数，参数为 object，具体属性如下：

以上函数调用后，会返回一个引用，可以通过该引用更新和关闭弹窗。

ClosableType

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 change
browserHistory.listen(() => {
  Modal.destroyAll();
});

Modal.useModal()

当你需要使用 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({ ... });

Semantic DOM

<code src="./demo/_semantic.tsx" simplify="true"></code>

主题变量（Design Token）{#design-token}

<ComponentTokenTable component="Modal"></ComponentTokenTable>

FAQ

为什么 Modal 关闭时，内容不会更新？ {#faq-content-not-update}

Modal 在关闭时会将内容进行 memo 从而避免关闭过程中的内容跳跃。也因此如果你在配合使用 Form 有关闭时重置 initialValues 的操作，请通过在 effect 中调用 resetFields 来重置。

为什么 Modal 方法不能获取 context、redux、的内容和 ConfigProvider locale/prefixCls/theme 等配置？ {#faq-context-redux}

直接调用 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}
    <Context2.Provider value="Design">
    </Context2.Provider>
  </Context1.Provider>
);

异同：通过 hooks 创建的 contextHolder 必须插入到子元素节点中才会生效，当你不需要上下文信息时请直接调用。

可通过 App 包裹组件 简化 useModal 等方法需要手动植入 contextHolder 的问题。

静态方法如何设置 prefixCls ？ {#faq-set-prefix-cls}

你可以通过 ConfigProvider.config 进行设置。