mirror of
https://gitee.com/ant-design/ant-design.git
synced 2024-12-05 05:28:20 +08:00
b0850139f2
* feat: init * feat: update * feat: upate * feat: update * feat: update * feat: init * feat: init * feat: init * feat: update * feat: update * feat: update * feat: update rc-tour * feat: init component * feat: init component * chore: update pck * doc: update doc * doc: update reviewer * doc: update reviewer * doc: update reviewer * feat: update reviewer * feat: update reviewer * feat: update doc * feat: update deme * feat: update demo doc * feat: update demo * feat: update demo * feat: update style * feat: update dom & style * feat: update dome * feat: update dome * docs: update demo * feat: update doc * feat: update dome * feat: add locale * doc: update locale * doc: add test * feat: add test case * feat: add test case * feat: update package * feat: update ts * feat: update ts * feat: update snapshots * feat: update demo * feat: update demo * feat: update demo * feat: edit maxSize * feat: edit maxSize * feat: update lint * feat: update lint * feat: update style reviewer * feat: update style * feat: merge next * feat: add locale * feat: reset bundleSize * feat: change maxSize * feat: update test coverage * feat: update test coverage * feat: add type * chore: simplify en locale * feat: update * feat: update test snap * docs: demo update * chore: adjust style * chore: adjust style * chore: bump rc-tour * Update package.json * feat: update package * feat: update package * feat: update cover * docs: update api * docs: update overview snap * feat: update token * feat: delete repeat ts * feat: remove finishButtonProps * chore: update demo * feat: tour style * test: fix lint * chore: code clean Co-authored-by: lijianan <574980606@qq.com> Co-authored-by: 二货机器人 <smith3816@gmail.com> Co-authored-by: MadCcc <1075746765@qq.com>
2.2 KiB
2.2 KiB
| category | subtitle | type | title | cover |
|---|---|---|---|---|
| Components | 漫游式引导 | 数据展示 | Tour | https://gw.alipayobjects.com/zos/bmw-prod/cc3fcbfa-bf5b-4c8c-8a3d-c3f8388c75e8.svg |
用于分步引导用户了解产品功能的气泡组件。自 5.0.0 版本开始提供该组件。
何时使用
常用于引导用户了解产品功能。
API
Tour
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| arrow | 是否显示箭头，包含是否指向元素中心的配置 | boolean | { pointAtCenter: boolean} |
true |
|
| placement | 引导卡片相对于目标元素的位置 | left leftTop leftBottom right rightTop rightBottom top topLeft topRight bottom bottomLeft bottomRight |
bottom |
|
| onClose | 关闭引导时的回调函数 | Function |
- | |
| onFinish | 引导完成时的回调 | Function |
- | |
| mask | 是否启用蒙层 | boolean |
true |
|
| type | 类型，影响底色与文字颜色 | default | primary |
default |
TourStep 引导步骤卡片
| 属性 | 说明 | 类型 | 默认值 | 版本 |
|---|---|---|---|---|
| target | 获取引导卡片指向的元素，为空时居中于屏幕 | () => HTMLElement | HTMLElement |
- | |
| arrow | 是否显示箭头，包含是否指向元素中心的配置 | boolean | { pointAtCenter: boolean} |
true |
|
| cover | 展示的图片或者视频 | ReactNode |
- | |
| title | 标题 | ReactNode |
- | |
| description | 主要描述部分 | ReactNode |
- | |
| placement | 引导卡片相对于目标元素的位置 | left leftTop leftBottom right rightTop rightBottom top topLeft topRight bottom bottomLeft bottomRight bottom |
||
| onClose | 关闭引导时的回调函数 | Function |
- | |
| mask | 是否启用蒙层，默认跟随 Tour 的 mask 属性 |
boolean |
true |
|
| type | 类型，影响底色与文字颜色 | default | primary |
default |
|
| nextButtonProps | 下一步按钮的属性 | { children: ReactNode; onClick: Function } |
- | |
| prevButtonProps | 上一步按钮的属性 | { children: ReactNode; onClick: Function } |
- |