For AI agents: the complete documentation index is available at https://rickyshin93.github.io/tao-ui/zh/llms.txt, the full documentation bundle is available at https://rickyshin93.github.io/tao-ui/zh/llms-full.txt, and this page is available as Markdown at https://rickyshin93.github.io/tao-ui/zh/components/tour.md.
v0.0.57
  • 简体中文
  • Tour

    反馈@rockshin/tao-ui

    通过目标定位、聚光遮罩、自定义操作和键盘导航组织分步引导。

    每个示例都可以独立复制运行。带设备预览的示例可通过工具栏切换桌面与手机宽度。

    带遮罩的居中步骤,以及 disabledInteraction 步骤,会将键盘焦点限制在向导内。允许操作目标的步骤使用非模态语义,目标仍可获得焦点。关闭后焦点返回启动位置。

    示例

    在目标之间引导

    Tour 打开后从 ref 读取目标元素,Next 切换到下一目标。

    390 × 640
    TSX

    受控当前步骤

    将 current 和 open 保存在状态中,再次开始前重置步骤。

    390 × 640
    TSX

    居中的介绍步骤

    省略 target 时,步骤作为介绍面板居中显示。

    390 × 640
    TSX

    主色强调与封面

    type="primary" 改变面板强调方式,每步可添加封面图片或其他 React 内容。

    390 × 640
    TSX

    遮罩、间距与交互

    gap 控制高亮区域与目标之间的间距,disabledInteraction 阻止点击高亮目标。

    390 × 640
    TSX

    自定义指示器与操作

    保留默认操作并增加 Skip;每步的按钮属性可修改文字与事件。

    390 × 640
    TSX

    非模态引导

    mask:false 保持页面清晰可见;keyboard:false 禁用步骤快捷键与 Escape,本例仍可通过 Done 关闭。

    390 × 640
    TSX

    窄屏引导

    面板会围绕目标翻转与偏移,保持在手机视口内。

    390 × 640
    TSX

    API

    Tour

    属性说明类型默认值