From d2b8b6ac66771a968b623b47881312e536464621 Mon Sep 17 00:00:00 2001 From: ice <49827327+coding-ice@users.noreply.github.com> Date: Thu, 3 Apr 2025 14:01:03 +0800 Subject: [PATCH] docs(modal): fix incorrect footer type (#53394) * docs(modal): fix incorrect footer type * Update components/modal/index.zh-CN.md Co-authored-by: afc163 Signed-off-by: ice <49827327+coding-ice@users.noreply.github.com> * docs(modal): update footer prop type in English and Chinese documentation * fix(modal): update snapshot values for modal component tests --------- Signed-off-by: ice <49827327+coding-ice@users.noreply.github.com> Co-authored-by: afc163 --- components/modal/index.en-US.md | 12 ++---------- components/modal/index.zh-CN.md | 12 ++---------- scripts/__snapshots__/check-site.ts.snap | 4 ++-- 3 files changed, 6 insertions(+), 22 deletions(-) diff --git a/components/modal/index.en-US.md b/components/modal/index.en-US.md index bd04d5c6d5..112ec1b268 100644 --- a/components/modal/index.en-US.md +++ b/components/modal/index.en-US.md @@ -58,7 +58,7 @@ Common props ref：[Common props](/docs/react/common-props) | confirmLoading | Whether to apply loading visual effect for OK button or not | boolean | false | | | destroyOnClose | Whether to unmount child components on onClose | boolean | false | | | focusTriggerAfterClose | Whether need to focus trigger element after dialog is closed | boolean | true | 4.9.0 | -| footer | Footer content, set as `footer={null}` when you don't need default buttons | React.ReactNode \| ((params:[footerRenderParams](/components/modal#footerrenderparams))=> React.ReactNode) | (OK and Cancel buttons) | renderFunction: 5.9.0 | +| footer | Footer content, set as `footer={null}` when you don't need default buttons | ReactNode \| (originNode: ReactNode, extra: { OkBtn: React.FC, CancelBtn: React.FC }) => ReactNode | (OK and Cancel buttons) | renderFunction: 5.9.0 | | forceRender | Force render Modal | boolean | false | | | getContainer | The mounted node for Modal but still display at fullscreen | HTMLElement \| () => HTMLElement \| Selectors \| false | document.body | | | keyboard | Whether support press esc to close | boolean | true | | @@ -108,7 +108,7 @@ The items listed above are all functions, expecting a settings object as paramet | closable | Whether a close (x) button is visible on top right of the confirm dialog or not | boolean | false | 4.9.0 | | closeIcon | Custom close icon | ReactNode | undefined | 4.9.0 | | content | Content | ReactNode | - | | -| footer | Footer content, set as `footer: null` when you don't need default buttons | React.ReactNode \| ((params:[footerRenderParams](/components/modal#footerrenderparams))=> React.ReactNode) | - | renderFunction: 5.9.0 | +| footer | Footer content, set as `footer: null` when you don't need default buttons | ReactNode \| (originNode: ReactNode, extra: { OkBtn: React.FC, CancelBtn: React.FC }) => ReactNode | - | renderFunction: 5.9.0 | | getContainer | Return the mount node for Modal | HTMLElement \| () => HTMLElement \| Selectors \| false | document.body | | | icon | Custom icon | ReactNode | <ExclamationCircleFilled /> | | | keyboard | Whether support press esc to close | boolean | true | | @@ -184,14 +184,6 @@ return
{contextHolder}
; const confirmed = await modal.confirm({ ... }); ``` -#### footerRenderParams - - -| Property | Description | Type | Default | -| --- | --- | --- | --- | -| originNode | default node | React.ReactNode | - | -| extra | extended options | { OkBtn: FC; CancelBtn: FC } | - | - ## Semantic DOM diff --git a/components/modal/index.zh-CN.md b/components/modal/index.zh-CN.md index 58e4318050..0a8c3873e6 100644 --- a/components/modal/index.zh-CN.md +++ b/components/modal/index.zh-CN.md @@ -59,7 +59,7 @@ demo: | confirmLoading | 确定按钮 loading | boolean | false | | | destroyOnClose | 关闭时销毁 Modal 里的子元素 | boolean | false | | | focusTriggerAfterClose | 对话框关闭后是否需要聚焦触发元素 | boolean | true | 4.9.0 | -| footer | 底部内容，当不需要默认底部按钮时，可以设为 `footer={null}` | React.ReactNode \| ((params:[footerRenderParams](/components/modal-cn#footerrenderparams))=> React.ReactNode) | (确定取消按钮) | renderFunction: 5.9.0 | +| footer | 底部内容，当不需要默认底部按钮时，可以设为 `footer={null}` | ReactNode \| (originNode: ReactNode, extra: { OkBtn: React.FC, CancelBtn: React.FC }) => ReactNode | (确定取消按钮) | renderFunction: 5.9.0 | | forceRender | 强制渲染 Modal | boolean | false | | | getContainer | 指定 Modal 挂载的节点，但依旧为全屏展示，`false` 为挂载在当前位置 | HTMLElement \| () => HTMLElement \| Selectors \| false | document.body | | | keyboard | 是否支持键盘 esc 关闭 | boolean | true | | @@ -109,7 +109,7 @@ demo: | closable | 是否显示右上角的关闭按钮 | boolean | false | 4.9.0 | | closeIcon | 自定义关闭图标 | ReactNode | undefined | 4.9.0 | | content | 内容 | ReactNode | - | | -| footer | 底部内容，当不需要默认底部按钮时，可以设为 `footer: null` | React.ReactNode \| ((params:[footerRenderParams](/components/modal-cn#footerrenderparams))=> React.ReactNode) | - | renderFunction: 5.9.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 | | @@ -185,14 +185,6 @@ return
{contextHolder}
; const confirmed = await modal.confirm({ ... }); ``` -#### footerRenderParams - - -| 参数 | 说明 | 类型 | 默认值 | -| --- | --- | --- | --- | -| originNode | 默认节点 | React.ReactNode | - | -| extra | 扩展选项 | { OkBtn: FC; CancelBtn: FC } | - | - ## Semantic DOM diff --git a/scripts/__snapshots__/check-site.ts.snap b/scripts/__snapshots__/check-site.ts.snap index fb39511dc1..3480b544d6 100644 --- a/scripts/__snapshots__/check-site.ts.snap +++ b/scripts/__snapshots__/check-site.ts.snap @@ -144,9 +144,9 @@ exports[`site test Component components/message en Page 1`] = `3`; exports[`site test Component components/message zh Page 1`] = `3`; -exports[`site test Component components/modal en Page 1`] = `3`; +exports[`site test Component components/modal en Page 1`] = `2`; -exports[`site test Component components/modal zh Page 1`] = `3`; +exports[`site test Component components/modal zh Page 1`] = `2`; exports[`site test Component components/notification en Page 1`] = `3`;