SuperAPI AI 工具集

tour-guide

前端与建站

查看项目

更新于 10-15 22:10

技能介绍

用途:为 React/Next.js(含 Tailwind)应用添加应用内产品导览,即遮罩层加围绕指定元素的 spotlight 挖孔、tooltip 标签与“点击任意处关闭”提示,不依赖任何第三方导览库。

主要能力:通过单个组件 components/ui/tour-guide.tsx 实现,0 外部依赖(仅 React);用 data-tour="..." 标记需高亮元素;每个路由声明 spots: TourSpot[](selector 加 label,可选 labelSide、spotlightOnly、tooltipOnly);运行时测量 DOM 并绘制 SVG 遮罩与 spotlight 挖孔;点击任意处关闭;支持移动端与桌面端响应式。

使用方式:1) 复制组件文件,按品牌调整 TOUR_THEME 中 6 个颜色 token,dismissText 可通过 prop 修改;2) 在目标元素上添加 data-tour 属性;3) 在路由中引入 TourGuide,用 tourActive 状态与触发按钮控制,传入 SPOTS 数组。

限制:不适用于多步骤 next/prev 导览,一次展示当前路由全部停留点;不能使用 joyride/intro.js/driver.js 等库;非 React 应用需自行移植;selector 不匹配、元素不可见或离屏会被跳过,可能造成导览为空;若应用存在高于 z-[500] 的层级会遮挡遮罩;测量延迟 300ms,异步列表需在数据就绪后打开或重新测量;移动端与桌面端布局不同时建议分开声明两组 spots。

适用场景:希望在自研应用中快速加入 spotlight 式上手引导、且不愿引入额外依赖的前端项目。所需命令与具体价格资料暂未提供。