实现
2025年5月1日大约 7 分钟约 1972 字
技术选择
1.有intro.js,这个是要收费的,并且和vue3的兼容性不够
2.vue_tour不好用
3.最终选择了用户量最大、且已经跑通demo的driver.js
代码实现
1.架构设计,建立一个userGuide类,抽取出常用的方法
import {driver} from "driver.js";
import {commonConfig} from "@/utils/userGuide/config";
import {parallelEditUserGuideStep, parallelEditUserGuideType} from "@/utils/userGuide/parallelEditGuide";
import "driver.js/dist/driver.css";
import './index.css'
import {getCurrUserNavNeeded, setCurrUserNavOff} from "@/api/userGuide";
import parallelEditPersonsStore from "@/store/parallelEdit/parallelEditPersons";
import {parallelEditDesc} from "@/utils/userGuide/descriptionGetter";
export class UserGuide {
private currStep: number = 0
public driverObj: any = {}
private guideName = ''
private guideDetail = ''
private otherParams: any
private currGuideType: string
private judge = { // todo
guideFeature: (type: string) => {
if(type.includes('PE_') && type in parallelEditUserGuideStep) {
return {
feature: "parallelEdit",
page: type.replace('PE_', ''),
isNeedGuide: this.otherParams
}
}
},
isNoNeedGuide: async (otherCondition: boolean = false) => {
// this.dontShowAgain()
const list = await getCurrUserNavNeeded()
const res = list.data.guide_details && list.data.guide_details[this.guideName] && list.data.guide_details[this.guideName].includes(this.guideDetail)
return res
},
isParallelEdit: false
}
constructor(type: string, otherParams: any = 100) {
this.otherParams = otherParams
this.currGuideType = type
const guideInfo = this.judge.guideFeature(type)
if(guideInfo) {
this.guideName = guideInfo.feature
this.guideDetail = guideInfo.page
this.init(type)
}
}
async init(type: string){
if(await this.judge.isNoNeedGuide()) { return }
switch (this.guideName){
case 'parallelEdit':
this.handleParallelEdit()
break
}
}
handleParallelEdit = () => {
if(this.guideDetail === "editPage" && !this.otherParams) { return }
const options = {
// @ts-ignore
steps: parallelEditUserGuideStep[this.currGuideType],
popoverClass: 'driverjs-theme',
...commonConfig.driverConfig,
onDestroyed: ()=> {
this.dontShowAgain()
}
}
if(this.currGuideType === parallelEditUserGuideType.COMMIT_CONFIG) {
options.steps[0].popover.description = parallelEditDesc.handleConflictBtn("handleMultiConflictBtn")
}
// @ts-ignore
this.driverObj = driver(options)
this.driverObj.drive()
}
/**
* @description 后续不再显示
*/
dontShowAgain(){
setCurrUserNavOff({
guide_name: this.guideName,
guide_detail: this.guideDetail
})
this.destroy()
}
destroy() { driver().destroy() }
}
export const userGuideFactor = (type: String, page: string) => {
// todo
}2.要先梳理哪些是需要指引的
import {commonConfig, } from "@/utils/userGuide/config";
import firstNewRow from './assets/firstModefy1.png'
import secondNewRow from './assets/secontModefy1.png'
import mergeTwoRow from './assets/autoMerge1.png'
import saveAs from './assets/saveAs.png'
import importSaveAs from './assets/importSaveAs.png'
import conflictHandlePage from './assets/conflictHandlePage.png'
import {parallelEditDesc} from "@/utils/userGuide/descriptionGetter";
export enum parallelEditUserGuideType {
ALL = "PE_allStep",
TABLE_LIST = "PE_tableListPage",
EDIT_PAGE = "PE_editPage",
COMMIT_CONFIG = 'PE_commitConfigPage',
HANDLE_CONFLICT = "PE_handleConflictPage",
CELL_SELECT = 'PE_cellSelectPage'
}
let tableListPage = [
{
// element: ".one-wrapper",// 提示框出现的位置
popover: {
title: "我们开发了个新功能",
description: "在表格列表页,点击并行编辑,可以同时编辑多个表单,同时提交,提交后,可以查看提交结果。",
side: "left",
...commonConfig.popover
},
},
{
element: ".two-wrapper",
popover: {
title: "文件列表",
description: "请在文件列表中进行选择",
side: "right",
...commonConfig.popover,
},
},
{
element: ".parallel-edit-btn",
popover: {
title: "点击并行编辑",
description: "点击并行编辑后您无需等待即可进行表格操作",
position: "right",
...commonConfig.popover,
},
},
]
// 考虑没有处理冲突的情况
let commitConfigPage = [
{
element: ".handleMultiConflictBtn",
popover: {
title: "1.点此处可同时处理多个冲突文件",
description: parallelEditDesc.handleConflictBtn("handleMultiConflictBtn"),
side: "right",
align: "center",
...commonConfig.popover,
}
},
{
element: ".handleConflictBtn",
popover: {
title: "2.自动合并:多人修改了不同位置,点击”处理冲突“后将进行自动合并,举例如下",
description: parallelEditDesc.autoMerge(),
side: "bottom",
align: 'center',
...commonConfig.popover,
},
},
{
element: ".handleConflictBtn",
popover: {
title: "3.冲突处理:如多人修改了同一处,点击”处理冲突“后将进入冲突解决页面",
description: `<img style='height: 530px; width: 1500px;' src='${conflictHandlePage}'/>`,
side: "bottom",
align: "start",
...commonConfig.popover,
}
}
]
let editPage = [
{
popover: {
title: "1.并行编辑新功能上线啦!",
side: "bottom",
align: 'center',
...commonConfig.popover
},
},
{
element: ".parallelEditCount",
popover: {
title: "2.允许多人同时编辑同一个表",
side: "bottom",
align: 'center',
...commonConfig.popover
},
},
{
element: ".commitBtn",
popover: {
title: "3.编辑完成后可进行提交",
side: "left",
align: "center",
...commonConfig.popover,
},
},
{
element: ".saveAs",
popover: {
title: "4.也可点此可阶段性保存当前编辑内容",
description: `<img style='height: 402.5px; width: 1270px;' src='${saveAs}'/>`,
side: "left",
align: "start",
...commonConfig.popover,
},
},
{
element: ".importDraftOrFile",
popover: {
title: "5.然后点击导入->导入草稿可将之前编辑的内容恢复",
description: `<img style='height: 402.5px; width: 1270px;' src='${importSaveAs}'/>`,
side: "left",
align: "start",
...commonConfig.popover,
},
},
]
let cellSelectBtn = [
{
element: ".conflictCellSelectBtn",
popover: {
title: "1.可选中冲突单元格到处理结果区域",
side: "right",
align: "center",
...commonConfig.popover,
}
},
{
element: ".rowSelectBtn",
popover: {
title: "2.可选择整行到处理结果区域",
// description: "点击并行编辑后您无需等待即可进行表格操作",
side: "bottom",
align: "end",
...commonConfig.popover,
}
}
]
let handleConflictPage = [
{
element: ".conflictTaleSelector",
popover: {
title: "1.选择要解决冲突的文件和表格",
side: "right",
align: 'center',
...commonConfig.popover,
},
},
{
element: ".conflictTypeSelector",// 提示框出现的位置
popover: {
title: "2.选择具体解决冲突的类型",
side: "right",
align: 'start',
...commonConfig.popover
},
},
{
element: ".conflictHandleArea",
popover: {
title: "3.冲突展示区域",
side: "bottom",
align: 'center',
...commonConfig.popover,
},
},
{
element: ".fork-table",
popover: {
title: "4.解决冲突后的结果显示区域",
description: "注意:如出现非冲突数据显示空白,可忽视。",
side: "top",
align: 'center',
...commonConfig.popover,
},
},
{
element: ".commitHandledResBtn",
popover: {
title: "5.所有冲突解决完毕后,提交处理结果",
side: "left",
align: 'center',
...commonConfig.popover,
},
}
]
export const parallelEditUserGuideStep = {
"PE_tableListPage" : tableListPage,
"PE_commitConfigPage" : commitConfigPage,
"PE_editPage" : editPage,
"PE_handleConflictPage": handleConflictPage,
'PE_cellSelectPage' : cellSelectBtn
}3.设置要指引位置的类名,并且在代码中加入类名

4.然后在特定页面直接调用

new UserGuide(parallelEditUserGuideType.HANDLE_CONFLICT, null)CSS实现
/**
* @description: 用户导航的一些常用css
* part1: 自定义类应用到弹出窗口
*/
/* Class assigned to popover wrapper */
/*.driver-popover {*/
/* width: 1000px;*/
/*}*/
/* Arrow pointing towards the highlighted element */
.driver-popover-arrow {}
/* Title and description */
.driver-popover-title {}
.driver-popover-description {}
/* Close button displayed on the top right corner */
.driver-popover-close-btn {}
/* Footer of the popover displaying progress and navigation buttons */
.driver-popover-footer {}
.driver-popover-progress-text {}
.driver-popover-prev-btn {}
.driver-popover-next-btn {}
/**
*@description: 弹框不同状态的样式
*/
.driver-active {} /* is active */
.driver-fade {} /* is animated */
.driver-simple {} /* is not animated */
.driver-active-element {}
.driver-popover.driverjs-theme {
max-width: 3000px;
min-width: 300px;
/*width: 100px;*/
/*background-color: #fde047;*/
/*color: #000;*/
}
.driver-popover.driverjs-theme .driver-popover-title {
font-size: 16px;
}
.driver-popover.driverjs-theme .driver-popover-title,
.driver-popover.driverjs-theme .driver-popover-description,
.driver-popover.driverjs-theme .driver-popover-progress-text {
color: #000;
}
.driver-popover.driverjs-theme button {
/*flex: 1;*/
text-align: center;
/*background-color: #000;*/
/*color: #ffffff;*/
/*border: 2px solid #000;*/
/*text-shadow: none;*/
/*font-size: 14px;*/
/*padding: 5px 8px;*/
/*border-radius: 6px;*/
}
.driver-popover.driverjs-theme button:hover {
/*background-color: #000;*/
/*color: #ffffff;*/
}
.driver-popover.driverjs-theme .driver-popover-navigation-btns {
/*justify-content: space-between;*/
/*gap: 3px;*/
}
.driver-popover.driverjs-theme .driver-popover-close-btn {
color: #9b9b9b;
}
.driver-popover.driverjs-theme .driver-popover-close-btn:hover {
color: #000;
}
.driver-popover.driverjs-theme .driver-popover-arrow-side-left.driver-popover-arrow {
border-left-color: #fde047;
}
.driver-popover.driverjs-theme .driver-popover-arrow-side-right.driver-popover-arrow {
border-right-color: #fde047;
}
.driver-popover.driverjs-theme .driver-popover-arrow-side-top.driver-popover-arrow {
border-top-color: #fde047;
}
.driver-popover.driverjs-theme .driver-popover-arrow-side-bottom.driver-popover-arrow {
border-bottom-color: #fde047;
}
.arrow {
display: flex;
justify-content: center;
align-items: center;
height: 80px;
}
.arrow::before {
content: '↓';
font-size: 44px;
color: black;
}一些配置项
export const commonConfig = {
driverConfig: {
// className: 'scoped-class', //包裹driver.js弹窗的类名
animate: true, // 高亮元素改变时是否显示动画
opacity: 0.75, //背景透明度(0 表示只有弹窗并且没有遮罩)
stagePadding: 10, // 元素与边缘的距离
allowClose: true, // 是否允许点击遮罩时关闭
overlayClickNext: true, //是否允许点击遮罩时移到到下一步
doneBtnText: '简单,会了!', // 最终按钮上的文本
closeBtnText: '跳过', // 当前步骤关闭按钮上的文本
nextBtnText: '下一步', //当前步骤下一步按钮上的文本
prevBtnText: '上一步', // 当前步骤上一步按钮上的文本
keyboardControl: true, // 是否允许通告键盘控制(escape关闭,箭头键用于移动)
scrollIntoViewOptions: {}, // `scrollIntoView()` 方法的选项
showButtons: ["next", "previous", "close"],// 是否显示按钮
showProgress: true, // 是否显示步骤进度
progressText: `{{current}} / {{total}}`,
disableActiveInteraction: true,
smoothScroll: true,
// onHighlightStarted: (el: Element) => {}, // 元素开将要高亮时调用
// onHighlighted: (Element) {}, // 元素开完全高亮时调用
// onDeselected: (Element) {}, // 取消选择时调用
// onReset: (Element) {}, // 遮罩将要关闭时调用
// onNext: (Element) => {}, // 任何步骤中移到到下一步时调用
// onPrevious: (Element) => {}, // 任何步骤中移到到上一步时调用
},
popover: {
nextBtnText: '下一步',
prevBtnText: '上一步',
doneBtnText: '简单,会了' ,
closeBtnText: '跳过', // 当前步骤关闭按钮上的文本
},
popoverBegin: {
prevBtnText: "上一步",
nextBtnText: "下一步",
},
popoverEnd: {
prevBtnText: "下一步",
nextBtnText: "简单,会了!",
},
prevBtnText: null
}
export const htmlDesc = {
parallelEdit: {
}
// todo
}一些样式了避免写在一起太复杂,也可以提取出来
/**
* @description 根据不同情况去动态获取description
*/
import multiConflictBtn from "./assets/multiConflictBtn.png"
import singleConflictBtn from "./assets/singleConflictBtn.png"
import firstNewRow from './assets/firstModefy1.png'
import secondNewRow from './assets/secontModefy1.png'
import mergeTwoRow from './assets/autoMerge1.png'
import "./index.css"
export const parallelEditDesc = {
handleConflictBtn: (type: string) => {
const isExist = document.querySelector(`.${type}`)
console.log("handleConflictBtn", isExist)
return isExist
? ""
: type === "handleMultiConflictBtn"
? `<img style="width: 1149px; height: 868px" src='${multiConflictBtn}'/>`
: `<img style="width: 1149px; height: 868px" src='${singleConflictBtn}'/>`
},
autoMerge: () => {
return `
<span style="display: flex; flex-direction: column; gap: 20px;">
<div style="display: flex; gap: 20px;">
<img style='width: 669px; height: 46px;' src='${firstNewRow}' />
<img style='width: 662px; height: 44px;' src='${secondNewRow}' />
</div>
<div class="arrow"></div>
<div style=" display: flex; gap: 20px; justify-content: center; align-items: center; margin-bottom: 20px">
<img style='width: 761px; height: 64px;' src='${mergeTwoRow}' />
</div>
</span>`
}
}目录结构

待确认
1.是每个页面进行单独的导航吗?还是一路导航到底?