R后悔药 Rue.js
  • 首页
    • 深度指南
    • 实战例子
    • 快速上手
    • 路由指南
    • 术语表
    • 错误代码参考
  • API
    • 合作伙伴
    • 插件
    • 组件库
    • 工具链
    • Text.js
    • 新闻简报
    • 常见问题
    • 团队
    • 版本发布
    • 社区指南
    • 行为规范
    • 隐私政策
  • 赞助
  • 合作伙伴
设置
目录统计
总条目
  • 按钮 Button
  • 排版 Typography
  • 时间选择器 TimePicker
  • 下拉菜单 Dropdown
  • 悬浮操作按钮 FAB
  • 模态框 Modal
  • 切换 Swap
  • 主题控制器 Theme Controller
  • 手风琴 Accordion
  • 头像 Avatar
  • 徽标 Badge
  • 卡片 Card
  • 轮播 Carousel
  • 聊天气泡 Chat
  • 折叠面板 Collapse
  • 倒计时 Countdown
  • 描述列表 Descriptions
  • 对比 Diff
  • 二维码 QRCode
  • 悬浮 3D 卡片 Hover 3D
  • 悬浮画廊 Hover Gallery
  • 键盘提示 Kbd
  • 列表 List
  • 统计 Stat
  • 状态 Status
  • 表格 Table
  • 文本轮播 Text Rotate
  • 时间线 Timeline
  • 锚点 Anchor
  • 固钉 Affix
  • 面包屑 Breadcrumbs
  • 底部导航 Dock
  • 链接 Link
  • 菜单 Menu
  • 导航栏 Navbar
  • 分页 Pagination
  • 步骤 Steps
  • 选项卡 Tabs
  • 提示 Alert
  • 结果页 Result
  • 空状态 Empty
  • 加载 Loading
  • 全局提示 Message
  • 进度条 Progress
  • 环形进度 Radial Progress
  • 骨架屏 Skeleton
  • 通知提醒框 Notification
  • 轻提示 Toast
  • 气泡确认框 Popconfirm
  • 气泡卡片 Popover
  • 工具提示 Tooltip
  • 日历 Calendar
  • 颜色选择器 ColorPicker
  • 复选框 Checkbox
  • 字段集 Fieldset
  • 表单 Form
  • 文件输入 File Input
  • 筛选器 Filter
  • 标签 Label
  • 单选框 Radio
  • 范围选择 Range
  • 评分 Rating
  • 分段选择 Segmented
  • 自动完成 AutoComplete
  • 选择器 Select
  • 树选择 TreeSelect
  • 树控件 Tree
  • 提及输入 Mentions
  • 穿梭框 Transfer
  • 漫游引导 Tour
  • 输入框 Input
  • 数字输入 InputNumber
  • 文本域 Textarea
  • 开关 Toggle
  • 校验器 Validator
  • 分隔线 Divider
  • 弹性布局 Flex
  • 分割面板 Splitter
  • 抽屉侧边栏 Drawer
  • 页脚 Footer
  • 栅格 Grid
  • 瀑布流 Masonry
  • 布局 Layout
  • 主视觉区 Hero
  • 指示器 Indicator
  • 组合项 Join
  • 蒙版 Mask
  • 水印 Watermark
  • 间距 Space
  • 堆叠 Stack
  • 浏览器样机 Mockup Browser
  • 代码样机 Mockup Code
  • 手机样机 Mockup Phone
  • 窗口样机 Mockup Window
目录统计
总条目
  • 按钮 Button
  • 排版 Typography
  • 时间选择器 TimePicker
  • 下拉菜单 Dropdown
  • 悬浮操作按钮 FAB
  • 模态框 Modal
  • 切换 Swap
  • 主题控制器 Theme Controller
  • 手风琴 Accordion
  • 头像 Avatar
  • 徽标 Badge
  • 卡片 Card
  • 轮播 Carousel
  • 聊天气泡 Chat
  • 折叠面板 Collapse
  • 倒计时 Countdown
  • 描述列表 Descriptions
  • 对比 Diff
  • 二维码 QRCode
  • 悬浮 3D 卡片 Hover 3D
  • 悬浮画廊 Hover Gallery
  • 键盘提示 Kbd
  • 列表 List
  • 统计 Stat
  • 状态 Status
  • 表格 Table
  • 文本轮播 Text Rotate
  • 时间线 Timeline
  • 锚点 Anchor
  • 固钉 Affix
  • 面包屑 Breadcrumbs
  • 底部导航 Dock
  • 链接 Link
  • 菜单 Menu
  • 导航栏 Navbar
  • 分页 Pagination
  • 步骤 Steps
  • 选项卡 Tabs
  • 提示 Alert
  • 结果页 Result
  • 空状态 Empty
  • 加载 Loading
  • 全局提示 Message
  • 进度条 Progress
  • 环形进度 Radial Progress
  • 骨架屏 Skeleton
  • 通知提醒框 Notification
  • 轻提示 Toast
  • 气泡确认框 Popconfirm
  • 气泡卡片 Popover
  • 工具提示 Tooltip
  • 日历 Calendar
  • 颜色选择器 ColorPicker
  • 复选框 Checkbox
  • 字段集 Fieldset
  • 表单 Form
  • 文件输入 File Input
  • 筛选器 Filter
  • 标签 Label
  • 单选框 Radio
  • 范围选择 Range
  • 评分 Rating
  • 分段选择 Segmented
  • 自动完成 AutoComplete
  • 选择器 Select
  • 树选择 TreeSelect
  • 树控件 Tree
  • 提及输入 Mentions
  • 穿梭框 Transfer
  • 漫游引导 Tour
  • 输入框 Input
  • 数字输入 InputNumber
  • 文本域 Textarea
  • 开关 Toggle
  • 校验器 Validator
  • 分隔线 Divider
  • 弹性布局 Flex
  • 分割面板 Splitter
  • 抽屉侧边栏 Drawer
  • 页脚 Footer
  • 栅格 Grid
  • 瀑布流 Masonry
  • 布局 Layout
  • 主视觉区 Hero
  • 指示器 Indicator
  • 组合项 Join
  • 蒙版 Mask
  • 水印 Watermark
  • 间距 Space
  • 堆叠 Stack
  • 浏览器样机 Mockup Browser
  • 代码样机 Mockup Code
  • 手机样机 Mockup Phone
  • 窗口样机 Mockup Window

Tour 漫游引导

Tour 用分步浮层把用户带过关键入口、局部强调和最终动作。Rue 的实现参考了成熟组件库的能力模型,但视觉仍然保持自己的 card、badge 和 button 语言,不直接照搬现成面板样式。

Tour 覆盖的不只是静态外观,也包含完整执行逻辑:围绕真实 DOM target 做高亮、自动定位、切步滚动、非模态展示,以及自定义 indicator 和底部 actions。

何时使用

  • 需要把新用户逐步带过核心入口、关键按钮或首次配置流程。
  • 需要在复杂页面里突出某个局部区域,并配合文案解释当前操作目的。
  • 需要把产品说明、轻 onboarding 和最终业务动作串成一条连续体验。

# 基础引导

点击 Basic 后,从 Upload、Save 到更多操作依次弹出讲解。

代码演示
点击 Basic 按钮后弹出引导
Action Bar
点击 Basic 后,会依次讲解 Upload、Save 和更多操作。
Code 示例

# 欢迎页与非模态

展示没有 target 的中心步骤,以及 mask=false 时的轻量引导方式。

欢迎页 + 非模态引导
适合把版本亮点和页面主内容穿在同一条体验线上。
Release Note
Shipping cockpit for product operations
把素材、上线窗口、审批节点和回放笔记收进同一块工作区,不必在多个页面之间反复跳转。
Launches
12
Reviews
5
Pending
2

# Placement 与交互洞口

切换 top/right/bottom/left,并验证高亮区默认仍可继续触发目标元素。

Placement 与高亮区实验
切换浮层方向时,目标按钮仍然可以在洞口区域被点击。

# 自定义指示器与动作区

通过 primary 主题、cover、indicatorsRender 和 actionsRender 把引导做成更完整的任务流。

自定义 indicator 与 actions
这套写法更接近常见分步引导的心智,但视觉和布局还是 Rue 自己的。
Launch Summary
One surface for launch, approval and playback
用一个页面完成素材汇总、审批流转、上线窗口对齐和上线后的回放,不再分散在多个工具里。
Brief
完成背景与目标归纳
Review
跨团队确认视觉与文案
Ship
统一 CTA 与发布时间窗

# API

属性说明类型默认值
steps引导步骤数组,每步可独立配置 target、placement、mask、cover 与按钮文案。TourStepProps[][]
open / defaultOpen受控或非受控地打开引导浮层。booleanfalse
current / defaultCurrent受控或非受控地指定当前步骤索引。number0
placement全局浮层位置,单步可继续覆盖。TourPlacementbottom
mask / disabledInteraction控制遮罩是否启用,以及高亮区是否允许继续交互。boolean | { color?: string; style?: object } / booleantrue / false
gap调整高亮区与目标的间距和圆角,适合按钮、卡片、输入框等不同密度场景。{ offset?: number | [number, number]; radius?: number }{ offset: 8, radius: 18 }
arrow / closeIcon / type配置箭头、关闭按钮与主视觉主题。boolean | object / any / default | primarytrue / x / default
indicatorsRender / actionsRender自定义底部步骤指示器与整体操作区。(current, total) => any / (originNode, info) => any-
scrollIntoViewOptions步骤切换时自动把目标滚动进视口,可关闭或传入原生配置。boolean | ScrollIntoViewOptions{ block: center, inline: center, behavior: smooth }
onChange / onClose / onFinish / onOpenChange监听步骤变化、关闭、完成和打开状态变化。function-
classNames / styles按语义节点扩展 root、mask、spotlight、panel、footer、indicator 等样式。object-
页内导航
页内导航
文档
  • 深度指南
  • 实战例子
  • 快速上手
  • 术语表
  • 错误码参照表
关于
  • 常见问题
  • 团队
  • 版本发布
  • 社区指南
生态
  • 插件
  • 组件库
  • 路由指南
  • Text.js
© 2024-2026 Xiangmin Liu
Rue.JS