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

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

相关推荐
brief of gali4 分钟前
记录一个奇怪的前端布局现象
前端
计算机毕设指导68 分钟前
基于 SpringBoot 的作业管理系统【附源码】
java·vue.js·spring boot·后端·mysql·spring·intellij-idea
Json_181790144801 小时前
电商拍立淘按图搜索API接口系列,文档说明参考
前端·数据库
风尚云网1 小时前
风尚云网前端学习:一个简易前端新手友好的HTML5页面布局与样式设计
前端·css·学习·html·html5·风尚云网
木子02041 小时前
前端VUE项目启动方式
前端·javascript·vue.js
GISer_Jing1 小时前
React核心功能详解(一)
前端·react.js·前端框架
捂月2 小时前
Spring Boot 深度解析:快速构建高效、现代化的 Web 应用程序
前端·spring boot·后端
深度混淆2 小时前
实用功能,觊觎(Edge)浏览器的内置截(长)图功能
前端·edge
Smartdaili China2 小时前
如何在 Microsoft Edge 中设置代理: 快速而简单的方法
前端·爬虫·安全·microsoft·edge·社交·动态住宅代理
秦老师Q2 小时前
「Chromeg谷歌浏览器/Edge浏览器」篡改猴Tempermongkey插件的安装与使用
前端·chrome·edge