Skip to content

lyh0371/web-guide

Repository files navigation

使用场景

社区有很多关于新手引导的组件,比如优秀的 driver.jsshepherdintrojs ...

但这些组件主要解决的还是静态页面的引导,适用于需要引导的功能都在静态页面上呈现出来的场景。

web-guide 主要解决的是动态页面的引导,即需要引导的内容可以动态的按照先后顺序出现的场景。

查看案例

如何使用

1. 安装

npm i @liuyahui666/web-guide -S

或者

yarn  add  @liuyahui666/web-guide -S

2. 使用

import webGuide,{ defineConfig } from "@liuyahui666/web-guide";
import "@liuyahui666/web-guide/index.css"
new webGuide(defineConfig({
  target: document.querySelector("#app"), // 页面的跟元素
  props: {
    settings: {
      immediate: true, // 是否立即开始引导
      stepArr: [ // 每一步的配置
        {
          element: () => document.querySelector("#addDiv"), // 在那个元素上触发
          trigger: "click", // 如何触发
          popover: {
            title:"请点击div", // 标题
            description:"点击div有惊喜哦", // 详情
          },
        },
        ...
      ],
    },
  },
}));

使用 defineConfig 可获取完成的类型提示