From 9a2192340ac528369acd69feca10b2e38fcd1a02 Mon Sep 17 00:00:00 2001 From: ice <49827327+coding-ice@users.noreply.github.com> Date: Mon, 20 Jan 2025 17:13:43 +0800 Subject: [PATCH] docs(tour): update prop types for target and placement in documentation (#52498) * docs(tour): update prop types for target and placement in documentation * Update components/tour/index.zh-CN.md Co-authored-by: thinkasany <480968828@qq.com> Signed-off-by: ice <49827327+coding-ice@users.noreply.github.com> --------- Signed-off-by: ice <49827327+coding-ice@users.noreply.github.com> Co-authored-by: thinkasany <480968828@qq.com> --- components/tour/index.en-US.md | 2 +- components/tour/index.zh-CN.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/components/tour/index.en-US.md b/components/tour/index.en-US.md index 9e5038241b..763fd58f1e 100644 --- a/components/tour/index.en-US.md +++ b/components/tour/index.en-US.md @@ -53,7 +53,7 @@ Common props ref：[Common props](/docs/react/common-props) | Property | Description | Type | Default | Version | | --- | --- | --- | --- | --- | -| target | Get the element the guide card points to. Empty makes it show in center of screen | `() => HTMLElement` `HTMLElement` | - | | +| target | Get the element the guide card points to. Empty makes it show in center of screen | `() => HTMLElement` \| `HTMLElement` | - | | | arrow | Whether to show the arrow, including the configuration whether to point to the center of the element | `boolean` `{ pointAtCenter: boolean}` | `true` | | | closeIcon | Customize close icon | `React.ReactNode` | `true` | 5.9.0 | | cover | Displayed pictures or videos | `ReactNode` | - | | diff --git a/components/tour/index.zh-CN.md b/components/tour/index.zh-CN.md index 2f67369588..06d4ee80c1 100644 --- a/components/tour/index.zh-CN.md +++ b/components/tour/index.zh-CN.md @@ -61,7 +61,7 @@ tag: 5.0.0 | cover | 展示的图片或者视频 | `ReactNode` | - | | | title | 标题 | `ReactNode` | - | | | description | 主要描述部分 | `ReactNode` | - | | -| placement | 引导卡片相对于目标元素的位置 | `center` `left` `leftTop` `leftBottom` `right` `rightTop` `rightBottom` `top` `topLeft` `topRight` `bottom` `bottomLeft` `bottomRight` `bottom` | | | +| placement | 引导卡片相对于目标元素的位置 | `center` `left` `leftTop` `leftBottom` `right` `rightTop` `rightBottom` `top` `topLeft` `topRight` `bottom` `bottomLeft` `bottomRight` | `bottom` | | | onClose | 关闭引导时的回调函数 | `Function` | - | | | mask | 是否启用蒙层，也可传入配置改变蒙层样式和填充色，默认跟随 Tour 的 `mask` 属性 | `boolean \| { style?: React.CSSProperties; color?: string; }` | `true` | | | type | 类型，影响底色与文字颜色 | `default` \| `primary` | `default` | |