feat(guide): 添加操作指引 (#106)

* fix(slot): 优化部分slot写法,减少手动判断 * fix(slot): 优化部分slot写法,减少手动判断 * feat(guide): 添加操作指引
2026-01-09 09:40:21 +08:00 · 2024-11-22 15:47:00 +08:00
parent 6af6eb3c99
commit 6563797afc
12 changed files with 154 additions and 6 deletions
--- a/src/layouts/components/BeginnerGuide.vue
+++ b/src/layouts/components/BeginnerGuide.vue
@@ -0,0 +1,138 @@
+<template>
+  <n-tooltip trigger="hover">
+    <template #trigger>
+      <i
+        class="i-fe:beginner mr-16 cursor-pointer text-20"
+        @click="show = true"
+      />
+    </template>
+    操作指引
+  </n-tooltip>
+
+  <Vue3IntroStep
+    ref="myIntroStep"
+    v-model:show="show"
+    class="beginner-guide"
+    :config="config"
+  >
+    <template #prev="{ tipItem, index }">
+      <NButton type="primary" color="#fff" text-color="#fff" ghost round size="small" @click="prev(tipItem, index)">
+        上一步
+      </NButton>
+    </template>
+    <template #next="{ tipItem }">
+      <NButton type="primary" color="#fff" text-color="#fff" ghost round size="small" @click="next(tipItem)">
+        下一步
+      </NButton>
+    </template>
+
+    <template #skip>
+      <NButton type="primary" color="#fff" text-color="#fff" ghost round size="small" @click="skip">
+        跳过
+      </NButton>
+    </template>
+
+    <template #done>
+      <NButton type="primary" color="#fff" text-color="#fff" ghost round size="small" @click="done">
+        完成
+      </NButton>
+    </template>
+  </Vue3IntroStep>
+</template>
+
+<script setup>
+import { lStorage } from '@/utils'
+import Vue3IntroStep from 'vue3-intro-step'
+
+const myIntroStep = shallowRef(null)
+const show = shallowRef(false)
+const config = {
+  backgroundOpacity: 0.8,
+  titleStyle: {
+    textAlign: 'left',
+    fontSize: '18px',
+  },
+  contentStyle: {
+    textAlign: 'left',
+    fontSize: '14px',
+  },
+  tips: [
+    {
+      el: '#toggleTheme',
+      tipPosition: 'bottom',
+      title: '切换系统主题',
+      content: '一键开启护眼模式',
+    },
+    {
+      el: '#fullscreen',
+      tipPosition: 'bottom',
+      title: '全屏/退出全屏',
+      content: '一键开启全屏',
+    },
+    {
+      el: '#theme-setting',
+      tipPosition: 'bottom',
+      title: '设置主题色',
+      content: '调整为你喜欢的主题色',
+    },
+    {
+      el: '#user-dropdown',
+      tipPosition: 'bottom',
+      title: '个人中心',
+      content: '查看个人资料和退出系统',
+    },
+    {
+      el: '#menu-collapse',
+      tipPosition: 'bottom',
+      title: '展开/收起菜单',
+      content: '一键展开/收起菜单',
+    },
+    {
+      el: '#top-tab',
+      tipPosition: 'bottom',
+      title: '标签栏',
+      content: '鼠标滚轮滑动可调整至最佳视野',
+    },
+    {
+      el: '#layout-setting',
+      tipPosition: 'left',
+      title: '调整系统布局',
+      content: '将系统布局调整为你喜欢的样子',
+    },
+  ],
+}
+
+onMounted(() => {
+  if (lStorage.get('beginner-guide') === true)
+    return
+  show.value = true
+})
+
+function skip() {
+  lStorage.set('beginner-guide', true)
+  show.value = false
+}
+
+function done() {
+  lStorage.set('beginner-guide', true)
+  show.value = false
+}
+
+function next() {
+  // tipItem当前的提示项信息
+  // 调用vue3-intro-step的next方法 手动触发下一步
+  myIntroStep.value.next()
+}
+function prev() {
+  // 调用vue3-intro-step的prev方法 手动触发上一步
+  myIntroStep.value.prev()
+}
+</script>
+
+<style lang="scss" scoped>
+.beginner-guide {
+  .n-button {
+    margin-right: 12px;
+  }
+}
+</style>