mirror of
https://github.com/ant-design/ant-design.git
synced 2024-12-21 13:18:04 +08:00
612d5c0702
Co-authored-by: afc163 <afc163@gmail.com> Co-authored-by: KAROS\81948 <chenwenfan@harmonycloud.cn>
75 lines
4.4 KiB
Markdown
75 lines
4.4 KiB
Markdown
---
|
||
category: Components
|
||
group: 数据展示
|
||
title: Tour
|
||
subtitle: 漫游式引导
|
||
description: 用于分步引导用户了解产品功能的气泡组件。
|
||
cover: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*NMvqRZpuJfQAAAAAAAAAAAAADrJ8AQ/original
|
||
coverDark: https://mdn.alipayobjects.com/huamei_7uahnr/afts/img/A*D70qQJJmzhgAAAAAAAAAAAAADrJ8AQ/original
|
||
demo:
|
||
cols: 2
|
||
tag: 5.0.0
|
||
---
|
||
|
||
## 何时使用
|
||
|
||
常用于引导用户了解产品功能。
|
||
|
||
## 代码演示
|
||
|
||
<!-- prettier-ignore -->
|
||
<code src="./demo/basic.tsx">基本</code>
|
||
<code src="./demo/non-modal.tsx">非模态</code>
|
||
<code src="./demo/placement.tsx">位置</code>
|
||
<code src="./demo/mask.tsx">自定义遮罩样式</code>
|
||
<code src="./demo/indicator.tsx">自定义指示器</code>
|
||
<code src="./demo/gap.tsx">自定义高亮区域的样式</code>
|
||
<code src="./demo/render-panel.tsx" debug>\_InternalPanelDoNotUseOrYouWillBeFired</code>
|
||
|
||
## API
|
||
|
||
通用属性参考：[通用属性](/docs/react/common-props)
|
||
|
||
### Tour
|
||
|
||
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
||
| --- | --- | --- | --- | --- |
|
||
| arrow | 是否显示箭头，包含是否指向元素中心的配置 | `boolean` \| `{ pointAtCenter: boolean}` | `true` | |
|
||
| closeIcon | 自定义关闭按钮 | `React.ReactNode` | `true` | 5.9.0 |
|
||
| disabledInteraction | 禁用高亮区域交互 | `boolean` | `false` | 5.13.0 |
|
||
| gap | 控制高亮区域的圆角边框和显示间距 | `{ offset?: number \| [number, number]; radius?: number }` | `{ offset?: 6 ; radius?: 2 }` | 5.0.0 (数组类型的 `offset`: 5.9.0 ) |
|
||
| placement | 引导卡片相对于目标元素的位置 | `center` `left` `leftTop` `leftBottom` `right` `rightTop` `rightBottom` `top` `topLeft` `topRight` `bottom` `bottomLeft` `bottomRight` | `bottom` | |
|
||
| onClose | 关闭引导时的回调函数 | `Function` | - | |
|
||
| onFinish | 引导完成时的回调 | `Function` | - | |
|
||
| mask | 是否启用蒙层，也可传入配置改变蒙层样式和填充色 | `boolean \| { style?: React.CSSProperties; color?: string; }` | `true` | |
|
||
| type | 类型，影响底色与文字颜色 | `default` \| `primary` | `default` | |
|
||
| open | 打开引导 | `boolean` | - | |
|
||
| onChange | 步骤改变时的回调，current 为当前的步骤 | `(current: number) => void` | - | |
|
||
| current | 当前处于哪一步 | `number` | - | |
|
||
| scrollIntoViewOptions | 是否支持当前元素滚动到视窗内，也可传入配置指定滚动视窗的相关参数 | `boolean \| ScrollIntoViewOptions` | `true` | 5.2.0 |
|
||
| indicatorsRender | 自定义指示器 | `(current: number, total: number) => ReactNode` | - | 5.2.0 |
|
||
| zIndex | Tour 的层级 | number | 1001 | 5.3.0 |
|
||
| getPopupContainer | 设置 Tour 浮层的渲染节点，默认是 body | `(node: HTMLElement) => HTMLElement` | body | 5.12.0 |
|
||
|
||
### TourStep 引导步骤卡片
|
||
|
||
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|
||
| --- | --- | --- | --- | --- |
|
||
| target | 获取引导卡片指向的元素，为空时居中于屏幕 | `() => HTMLElement` \| `HTMLElement` | - | |
|
||
| arrow | 是否显示箭头，包含是否指向元素中心的配置 | `boolean` \| `{ pointAtCenter: boolean}` | `true` | |
|
||
| closeIcon | 自定义关闭按钮 | `React.ReactNode` | `true` | 5.9.0 |
|
||
| cover | 展示的图片或者视频 | `ReactNode` | - | |
|
||
| title | 标题 | `ReactNode` | - | |
|
||
| description | 主要描述部分 | `ReactNode` | - | |
|
||
| 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` | |
|
||
| nextButtonProps | 下一步按钮的属性 | `{ children: ReactNode; onClick: Function }` | - | |
|
||
| prevButtonProps | 上一步按钮的属性 | `{ children: ReactNode; onClick: Function }` | - | |
|
||
| scrollIntoViewOptions | 是否支持当前元素滚动到视窗内，也可传入配置指定滚动视窗的相关参数，默认跟随 Tour 的 `scrollIntoViewOptions` 属性 | `boolean \| ScrollIntoViewOptions` | `true` | 5.2.0 |
|
||
|
||
## 主题变量（Design Token）
|
||
|
||
<ComponentTokenTable component="Tour"></ComponentTokenTable>
|