From fe9121ebb936327d67dfbdc182022ca2ef1a7236 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?kiner-tang=28=E6=96=87=E8=BE=89=29?= <1127031143@qq.com> Date: Wed, 7 Jun 2023 13:49:31 +0800 Subject: [PATCH] docs: update docs about getContainer (#42885) --- components/image/index.en-US.md | 2 +- components/image/index.zh-CN.md | 2 +- components/message/index.en-US.md | 2 +- components/message/index.zh-CN.md | 2 +- components/modal/index.zh-CN.md | 2 +- components/notification/index.en-US.md | 4 ++-- components/notification/index.zh-CN.md | 4 ++-- 7 files changed, 9 insertions(+), 9 deletions(-) diff --git a/components/image/index.en-US.md b/components/image/index.en-US.md index d45e155de8..8fbc5950ae 100644 --- a/components/image/index.en-US.md +++ b/components/image/index.en-US.md @@ -48,7 +48,7 @@ Previewable image. { visible?: boolean; onVisibleChange?: (visible, prevVisible, current: number) => void; // `current` only support after v5.3.0 - getContainer?: string | HTMLElement | (() => HTMLElement); // v4.8.0 + getContainer?: string | HTMLElement | (() => HTMLElement); // v4.8.0 The mounted node for preview dialog but still display at fullScreen src?: string; // v4.10.0 mask?: ReactNode; // v4.9.0 maskClassName?: string; // v4.11.0 diff --git a/components/image/index.zh-CN.md b/components/image/index.zh-CN.md index f01f3907b8..31e0bf23e8 100644 --- a/components/image/index.zh-CN.md +++ b/components/image/index.zh-CN.md @@ -49,7 +49,7 @@ coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*LVQ3R5JjjJEAAA { visible?: boolean; onVisibleChange?: (visible, prevVisible, current: number) => void; // current 参数 v5.3.0 后支持 - getContainer?: string | HTMLElement | (() => HTMLElement); // v4.8.0 + getContainer?: string | HTMLElement | (() => HTMLElement); // v4.8.0 指定预览窗口挂载的节点，但依旧为全屏展示 src?: string; // v4.10.0 mask?: ReactNode; // v4.9.0 maskClassName?: string; // v4.11.0 diff --git a/components/message/index.en-US.md b/components/message/index.en-US.md index b1051b0ed8..34478737b3 100644 --- a/components/message/index.en-US.md +++ b/components/message/index.en-US.md @@ -103,7 +103,7 @@ message.config({ | Argument | Description | Type | Default | Version | | --- | --- | --- | --- | --- | | duration | Time before auto-dismiss, in seconds | number | 3 | | -| getContainer | Return the mount node for Message | () => HTMLElement | () => document.body | | +| getContainer | Return the mount node for Message, but still display at fullScreen | () => HTMLElement | () => document.body | | | maxCount | Max message show, drop oldest if exceed limit | number | - | | | prefixCls | The prefix className of message node | string | `ant-message` | 4.5.0 | | rtl | Whether to enable RTL mode | boolean | false | | diff --git a/components/message/index.zh-CN.md b/components/message/index.zh-CN.md index fe608a94c5..ab08b8e42f 100644 --- a/components/message/index.zh-CN.md +++ b/components/message/index.zh-CN.md @@ -104,7 +104,7 @@ message.config({ | 参数 | 说明 | 类型 | 默认值 | 版本 | | --- | --- | --- | --- | --- | | duration | 默认自动关闭延时，单位秒 | number | 3 | | -| getContainer | 配置渲染节点的输出位置 | () => HTMLElement | () => document.body | | +| getContainer | 配置渲染节点的输出位置，但依旧为全屏展示 | () => HTMLElement | () => document.body | | | maxCount | 最大显示数, 超过限制时，最早的消息会被自动关闭 | number | - | | | prefixCls | 消息节点的 className 前缀 | string | `ant-message` | 4.5.0 | | rtl | 是否开启 RTL 模式 | boolean | false | | diff --git a/components/modal/index.zh-CN.md b/components/modal/index.zh-CN.md index 1c0b468d7f..7a1994eb53 100644 --- a/components/modal/index.zh-CN.md +++ b/components/modal/index.zh-CN.md @@ -55,7 +55,7 @@ demo: | focusTriggerAfterClose | 对话框关闭后是否需要聚焦触发元素 | boolean | true | 4.9.0 | | footer | 底部内容，当不需要默认底部按钮时，可以设为 `footer={null}` | ReactNode | (确定取消按钮) | | | forceRender | 强制渲染 Modal | boolean | false | | -| getContainer | 指定 Modal 挂载的节点，但依旧为全局展示，`false` 为挂载在当前位置 | HTMLElement \| () => HTMLElement \| Selectors \| false | document.body | | +| getContainer | 指定 Modal 挂载的节点，但依旧为全屏展示，`false` 为挂载在当前位置 | HTMLElement \| () => HTMLElement \| Selectors \| false | document.body | | | keyboard | 是否支持键盘 esc 关闭 | boolean | true | | | mask | 是否展示遮罩 | boolean | true | | | maskClosable | 点击蒙层是否允许关闭 | boolean | true | | diff --git a/components/notification/index.en-US.md b/components/notification/index.en-US.md index c13e7e0358..b9fa0f6cf8 100644 --- a/components/notification/index.en-US.md +++ b/components/notification/index.en-US.md @@ -69,7 +69,7 @@ The properties of config are as follows: | --- | --- | --- | --- | --- | | bottom | Distance from the bottom of the viewport, when `placement` is `bottomRight` or `bottomLeft` (unit: pixels) | number | 24 | | | closeIcon | Custom close icon | ReactNode | - | | -| getContainer | Return the mount node for Notification | () => HTMLNode | () => document.body | | +| getContainer | Return the mount node for Notification, but still display at fullScreen | () => HTMLNode | () => document.body | | | placement | Position of Notification, can be one of `topLeft` `topRight` `bottomLeft` `bottomRight` | string | `topRight` | | | rtl | Whether to enable RTL mode | boolean | false | | | top | Distance from the top of the viewport, when `placement` is `topRight` or `topLeft` (unit: pixels) | number | 24 | | @@ -101,7 +101,7 @@ notification.config({ | bottom | Distance from the bottom of the viewport, when `placement` is `bottomRight` or `bottomLeft` (unit: pixels) | number | 24 | | | closeIcon | Custom close icon | ReactNode | - | | | duration | Time in seconds before Notification is closed. When set to 0 or null, it will never be closed automatically | number | 4.5 | | -| getContainer | Return the mount node for Notification | () => HTMLNode | () => document.body | | +| getContainer | Return the mount node for Notification, but still display at fullScreen | () => HTMLNode | () => document.body | | | placement | Position of Notification, can be one of `topLeft` `topRight` `bottomLeft` `bottomRight` | string | `topRight` | | | rtl | Whether to enable RTL mode | boolean | false | | | top | Distance from the top of the viewport, when `placement` is `topRight` or `topLeft` (unit: pixels) | number | 24 | | diff --git a/components/notification/index.zh-CN.md b/components/notification/index.zh-CN.md index 78d61d77c5..06b0c5ca3f 100644 --- a/components/notification/index.zh-CN.md +++ b/components/notification/index.zh-CN.md @@ -70,7 +70,7 @@ config 参数如下： | --- | --- | --- | --- | --- | | bottom | 消息从底部弹出时，距离底部的位置，单位像素 | number | 24 | | | closeIcon | 自定义关闭图标 | ReactNode | - | | -| getContainer | 配置渲染节点的输出位置 | () => HTMLNode | () => document.body | | +| getContainer | 配置渲染节点的输出位置，但依旧为全屏展示 | () => HTMLNode | () => document.body | | | placement | 弹出位置，可选 `top` `topLeft` `topRight` `bottom` `bottomLeft` `bottomRight` | string | `topRight` | | | rtl | 是否开启 RTL 模式 | boolean | false | | | top | 消息从顶部弹出时，距离顶部的位置，单位像素 | number | 24 | | @@ -102,7 +102,7 @@ notification.config({ | bottom | 消息从底部弹出时，距离底部的位置，单位像素 | number | 24 | | | closeIcon | 自定义关闭图标 | ReactNode | - | | | duration | 默认自动关闭延时，单位秒 | number | 4.5 | | -| getContainer | 配置渲染节点的输出位置 | () => HTMLNode | () => document.body | | +| getContainer | 配置渲染节点的输出位置，但依旧为全屏展示 | () => HTMLNode | () => document.body | | | placement | 弹出位置，可选 `top` `topLeft` `topRight` `bottom` `bottomLeft` `bottomRight` | string | `topRight` | | | rtl | 是否开启 RTL 模式 | boolean | false | | | top | 消息从顶部弹出时，距离顶部的位置，单位像素 | number | 24 | |