在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',
  },
])

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

相关推荐
FRing039 小时前
vue3干货总结3(defineOptions(Vue3.3)、defineModel(Vue3.4)、Pinia)
开发语言·前端·vue.js·vue3
Bczheng19 小时前
组件化服务端渲染模式SSR
前端
whitelbwwww10 小时前
CUDA C++实战--中级
开发语言·前端·c++
张紫娃10 小时前
Chrome插件-Stylus(屏蔽博客广告)
前端·chrome·stylus
Yannik11 小时前
在 Apple Silicon Mac 上用 Jenkins + Fastlane 搭建 iOS CI:从自动打包到 MR 检查流水线的完整实践
前端
Nayana11 小时前
《Web 到 HarmonyOS》-- 打包:Vite 产物 → HAP / HAR / HSP
前端
inksci11 小时前
用飞帆做了个小网页
前端·javascript·css·html
去伪存真11 小时前
被 pnpm 打包坑惨后,我彻底盘明白了硬链接与软链接
前端·electron
zhensherlock12 小时前
Protocol Launcher 系列:CodeHub 移动端 GitHub 协作利器
前端·javascript·typescript·node.js·自动化·github·js
tryCbest16 小时前
Vue3——第 22 篇:Pinia——新一代状态管理(上)
前端·javascript·vue.js