在vue中封装useIntro来更好的使用Intro.js

Intro.js 是一个用于创建交互式引导和教程的 JavaScript 库。它可以帮助你向用户展示应用程序的功能、导航和特性,并提供步骤指导,以便他们更好地理解和使用你的应用。

为什么需要去封装

  1. 封装初始化配置,避免在项目中每处使用都去配置
  2. 优化使用体验,保证每次调用尽可能少的去写冗余的内容
  3. 针对SPA,使用onUnmounted确保切换页面效果正常,且在调用处无需手动处理页面卸载的情况

具体封装

首先安装intro.js

shell 复制代码
pnpm add intro.js
js 复制代码
import type { Options } from 'intro.js/src/option'
import type { IntroStep } from 'intro.js/src/core/steps'
import introJs from 'intro.js'
import 'intro.js/minified/introjs.min.css'
// 自定义覆盖的intro样式
import './assets/introJs.css'

export const useIntro = (steps: Partial<IntroStep>[], options?: Partial<Options>) => {
  const intro = introJs().setOptions({
    // 配置项目需要的默认初始值
    exitOnEsc: false,
    hidePrev: true,
    exitOnOverlayClick: false,
    showButtons: false,
    showBullets: false,
    steps,
    ...options,
  }).onbeforechange(async () => {
    // 每次切换前增加0.5s延迟 
    return new Promise((resolve) => {
      setInterval(resolve, 500)
    })
  })

  function stop() {
    intro.exit(true)
  }

  function start() {
    nextTick(() => {
      intro.start()
    })
  }

  function next() {
    intro.nextStep()
  }

  onUnmounted(() => {
    stop()
  })
  
  // 导出
  return {
    intro, stop, start, next,
  }
}

导出一共四个内容

  • intro: 当前intro.js的实例,可以根据文档调用实例方法
  • stop: 关闭当前引导
  • start:开始引导
  • next:手动下一步

业务使用

js 复制代码
const { intro, start, next } = useIntro([
  {
    element: '#album',
    intro: '选择素材',
  },
  {
    element: '#add',
    intro: '确认添加',
    position: 'top',
  },
])

封装后使用更加便利,只需要传入对应的步骤即可,无需其他额外处理

相关推荐
因吹斯汀6 分钟前
一饭封神:当AI厨神遇上你的冰箱,八大菜系大师在线battle!
前端·vue.js·ai编程
再学一点就睡10 分钟前
NATAPP 内网穿透指南:让本地项目轻松 “走出去”
前端
拜无忧10 分钟前
2025最新React项目架构指南:从零到一,为前端小白打造
前端·react.js·typescript
稻草人不怕疼12 分钟前
记一次从“按钮点不动”到“窗口派发缺失”的排查过程
前端
irving同学4623830 分钟前
TypeORM 列装饰器完整总结
前端·后端·nestjs
彭于晏爱编程33 分钟前
你真的了解 Map、Set 嘛
前端
崔璨37 分钟前
详解Vue3的响应式系统
前端·vue.js
摸鱼的鱼lv37 分钟前
🔥 Vue.js组件通信全攻略:从父子传值到全局状态管理,一篇搞定所有场景!🚀
前端·vue.js
IT_陈寒1 小时前
Java性能优化:10个让你的Spring Boot应用提速300%的隐藏技巧
前端·人工智能·后端
lichong9511 小时前
【混合开发】vue+Android、iPhone、鸿蒙、win、macOS、Linux之dist打包发布在Android工程asserts里
android·vue.js·iphone