官方资料
本教程以 Driver.js 1.x 的主流 API 为基础。实际项目中遇到版本差异时,应优先查看官方文档和当前安装包的类型定义。
常用链接
| 资源 | 地址 | 说明 |
|---|---|---|
| 官方网站 | driverjs.com | 项目介绍、示例和文档入口 |
| 安装文档 | Installation | npm、pnpm、yarn、CDN 用法 |
| API 文档 | API | 配置项、方法、step、popover 与 hooks |
| 异步导览 | Async Tour | 异步步骤和自定义按钮行为 |
| GitHub 仓库 | driver.js | 源码、Issue、Release 与示例 |
| npm 包 | driver.js | 版本、安装量和包信息 |
本地查询版本
查询 npm 最新版本:
npm view driver.js version
查询项目中安装的版本:
npm list driver.js
查看包内类型定义和样式文件:
ls node_modules/driver.js
在 Windows PowerShell 中可以使用:
Get-ChildItem node_modules\driver.js
API 速查
| API | 用途 |
|---|---|
driver(options) |
创建 Driver.js 实例 |
drive(index?) |
启动多步骤导览,可从指定步骤开始 |
highlight(step) |
高亮单个元素 |
moveNext() |
移动到下一步 |
movePrevious() |
移动到上一步 |
destroy() |
结束并销毁当前导览 |
getState() |
获取当前实例状态 |
hints(options) |
创建 Hints 实例,需要从 driver.js/hints 导入 |
show() |
显示 hints 提示点 |
hide() |
隐藏 hints 提示点 |
open(id) |
打开指定 hint 的弹层 |
dismiss(id) |
移除指定 hint 的提示点 |
继续学习建议
学习官方 API 时,建议按这个顺序看:
- 先看 installation,确认导入方式和 CSS。
- 再看 configuration,理解全局配置。
- 接着看 popover 和 step,掌握每一步的写法。
- 最后看 hooks、async tour 和 hints,用于处理真实业务页面。
如果你的页面引导开始包含大量异步流程、权限分支和状态恢复逻辑,应重新审视产品流程本身。Driver.js 适合辅助用户理解界面,但不应成为复杂流程的主要承载方式。