docs: ✏️ 优化演示demo支持在顶部显示对应页面微信小程序的二维码

Moonofweisheng · Dec 14, 2024 · b1f42af · b1f42af
1 parent 7ed7dd3
commit b1f42af
Show file tree

Hide file tree

Showing 83 changed files with 253 additions and 16 deletions.
diff --git a/build/qrcode.js b/build/qrcode.js
@@ -0,0 +1,119 @@
+// 调用微信api生成每个页面的小程序码，使用axios发起请求
+
+const fs = require('fs')
+const path = require('path')
+const axios = require('axios')
+const JSON5 = require('json5') // 引入 json5 库
+
+const appID = process.argv[process.argv.indexOf('--APP_ID') + 1] // 在 --APP_ID 后面
+const appSecret = process.argv[process.argv.indexOf('--APP_SECRET') + 1] // --APP_SECRET 后面
+
+// 获取 access_token 的函数
+async function getAccessToken() {
+  const url = `https://api.weixin.qq.com/cgi-bin/token?grant_type=client_credential&appid=${appID}&secret=${appSecret}`
+
+  try {
+    const response = await axios.get(url)
+    return response.data.access_token
+  } catch (error) {
+    console.error(`获取 access_token 失败: ${error.response ? error.response.data : error.message}`)
+    throw error // 抛出错误以便后续处理
+  }
+}
+
+// 读取 pages.json 文件
+const pagesJsonPath = path.join(__dirname, '../src/pages.json') // 计算 pages.json 的路径
+let pagesJson
+
+try {
+  const jsonData = fs.readFileSync(pagesJsonPath, 'utf8')
+  pagesJson = JSON5.parse(jsonData) // 使用 json5 解析带注释的 JSON
+} catch (error) {
+  console.error(`读取或解析 pages.json 失败: ${error.message}`)
+  process.exit(1) // 退出程序
+}
+
+const pages = pagesJson.pages.filter((page) => page.path.endsWith('Index'))
+
+// 将驼峰命名法转换为小写短横线连接的函数
+function camelToKebabCase(str) {
+  return str
+    .replace(/([a-z])([A-Z])/g, '$1-$2') // 在小写字母和大写字母之间插入短横线
+    .replace(/([A-Z])/g, '-$1') // 在大写字母前插入短横线
+    .replace(/--+/g, '-') // 替换多个短横线为一个短横线
+    .replace(/^-|-$/g, '') // 去掉开头和结尾的短横线
+    .toLowerCase() // 转换为小写
+}
+
+// 删除 wxqrcode 目录及其内容
+function clearWxqrcodeDirectory(outputDir) {
+  if (fs.existsSync(outputDir)) {
+    fs.rmSync(outputDir, { recursive: true, force: true }) // 递归删除目录及其内容
+    console.log(`已删除目录: ${outputDir}`)
+  }
+}
+
+// 生成小程序码的函数
+async function generateMiniProgramCode(accessToken, pagePath, retries = 3) {
+  const url = `https://api.weixin.qq.com/wxa/getwxacode?access_token=${accessToken}`
+  const data = {
+    path: pagePath,
+    width: 430 // 小程序码的宽度，可以根据需要调整
+  }
+
+  for (let attempt = 1; attempt <= retries; attempt++) {
+    try {
+      const response = await axios.post(url, data, {
+        responseType: 'arraybuffer' // 以二进制形式接收图片数据
+      })
+
+      // 确保输出目录存在
+      const outputDir = path.join(__dirname, '../docs/public/wxqrcode')
+      if (!fs.existsSync(outputDir)) {
+        fs.mkdirSync(outputDir, { recursive: true }) // 创建目录及其父目录
+      }
+
+      // 提取组件名并转换格式
+      const componentName = pagePath.split('/')[1] // 假设路径格式为 pages/组件名/Index
+      const formattedName = camelToKebabCase(componentName) // 转换为小写短横线连接
+
+      // 将返回的图片数据保存为文件
+      const fileName = path.join(outputDir, `${formattedName}.png`) // 生成文件名
+      fs.writeFileSync(fileName, response.data)
+      console.log(`小程序码已生成并保存为 ${fileName}`)
+      return // 成功后退出函数
+    } catch (error) {
+      console.error(`生成小程序码失败: ${error.response ? error.response.data : error.message}`)
+      if (attempt < retries) {
+        console.log(`重试 ${attempt}/${retries}...`)
+      } else {
+        console.error(`所有重试均失败，无法生成小程序码: ${pagePath}`)
+      }
+    }
+  }
+}
+
+// 遍历每个页面并生成小程序码
+async function generateCodesForAllPages(accessToken) {
+  for (const page of pages) {
+    await generateMiniProgramCode(accessToken, page.path)
+  }
+}
+
+// 生成二维码图片
+async function genrateQRCodeImage() {
+  const outputDir = path.join(__dirname, '../docs/public/wxqrcode')
+
+  // 在开始生成小程序码之前清空 wxqrcode 目录
+  clearWxqrcodeDirectory(outputDir)
+
+  try {
+    const accessToken = await getAccessToken()
+    await generateCodesForAllPages(accessToken)
+  } catch (error) {
+    console.error('程序执行失败:', error.message)
+  }
+}
+
+// 生成小程序二维码图片  pnpm qrcode -- --APP_ID xxx --APP_SECRET xxx
+genrateQRCodeImage()
diff --git a/docs/.vitepress/theme/components/QrCode.vue b/docs/.vitepress/theme/components/QrCode.vue
@@ -0,0 +1,48 @@
+<template>
+  <div @mouseenter="showQRCode = true" @mouseleave="showQRCode = false">
+    <el-tooltip
+      placement="bottom"
+       effect="light"
+      :visible="showQRCode"
+      :popper-options="{ modifiers: [{ name: 'offset', options: { offset: [0, 20] } }] }"
+    >
+      <svg
+        xmlns="http://www.w3.org/2000/svg"
+        width="1em"
+        height="1em"
+        viewBox="0 0 24 24"
+      >
+        <path fill="currentColor" d="M2 2h9v9H2zm2 2v5h5V4zm9-2h9v9h-9zm2 2v5h5V4zM5.5 5.5h2.004v2.004H5.5zm11 0h2.004v2.004H16.5zm-3.504 7.496H15V15h-2.004zm7 0H22V15h-2.004zM2 13h9v9H2zm2 2v5h5v-5zm11.996.996H18v2h2v2h2V22h-2.004v-2h-2v-2h-2zM5.5 16.5h2.004v2.004H5.5zm7.496 3.496H15V22h-2.004z"></path>
+      </svg>
+      <template #content>
+        <div class="qr-code">
+          <img :src="src" alt="二维码" />
+        </div>
+      </template>
+    </el-tooltip>
+  </div> 
+</template>
+
+<script lang="ts" setup>
+import { ref } from 'vue';
+import { ElTooltip } from 'element-plus';
+interface Props {
+  /** 二维码资源 */
+  src: string
+}
+
+const props = withDefaults(defineProps<Props>(), {
+  src: ''
+})
+
+const showQRCode = ref(false);
+</script>
+
+<style scoped>
+
+.qr-code {
+  width: 130px; /* 设置二维码的宽度 */
+  height: auto; /* 高度自适应 */
+  transition: opacity 0.3s ease; /* 添加过渡效果 */
+}
+</style>
diff --git a/docs/.vitepress/theme/components/VPIframe.vue b/docs/.vitepress/theme/components/VPIframe.vue
@@ -8,13 +8,14 @@
     <div class="demo-header">
       <ExternalLink :href="href" class="demo-link" :style="`${expanded ? '' : 'height:0;width:0;opacity:0'}`">
       </ExternalLink>
+      <QrCode class="demo-qrcode" :src="qrcode" v-if="expanded&&qrcode"></QrCode>
       <el-icon class="expand-icon" style="cursor: pointer;" @click="toggleExpand">
         <component :is="expanded ? Fold : Expand" />
       </el-icon>
     </div>
     <!-- iframe 容器 -->
     <div class="iframe-container">
-      <iframe v-if="expanded" ref="iframe" id="demo" class="iframe" scrolling="auto" frameborder="0" :src="href" />
+      <iframe v-if="expanded&&transitionEnd" ref="iframe" id="demo" class="iframe" scrolling="auto" frameborder="0" :src="href" />
     </div>
   </div>
 </template>
@@ -23,6 +24,8 @@
 import { Expand, Fold } from '@element-plus/icons-vue'
 import { useRoute, useData } from 'vitepress'
 import { computed, onMounted, ref, watch } from 'vue'
+import QrCode from './QrCode.vue'
+
 interface Props {
   /** 是否展开状态 */
   expanded?: boolean
@@ -35,7 +38,7 @@ const props = withDefaults(defineProps<Props>(), {
 // 状态管理
 const baseUrl = ref('')
 const iframe = ref<HTMLIFrameElement | null>(null)
-const transitionEnd = ref(false)
+const transitionEnd = ref(true)
 
 const emit = defineEmits<{
   'update:expanded': [boolean]  // 更新展开状态
@@ -54,6 +57,13 @@ const href = computed(() => {
   return baseUrl.value + `pages/${kebabToCamel(paths[paths.length - 1])}/Index`
 })
 
+const qrcode = computed(() => {
+  const path = route.path
+  const paths = path ? path.split('.')[0].split('/') : []
+  if (!paths.length) return ''
+  return `/wxqrcode/${kebabToCamel(paths[paths.length - 1])}.png`
+})
+
 // 工具函数：转换 kebab-case 为 camelCase
 function kebabToCamel(input: string): string {
   return input.replace(/-([a-z])/g, (match, group) => group.toUpperCase())
@@ -74,17 +84,13 @@ function toggleExpand() {
   // 触发事件通知父组件
   emit('update:expanded', !props.expanded)
   emit('state-change', !props.expanded)
-
-  if (props.expanded) {
-    transitionEnd.value = false
-  }
+  transitionEnd.value = false
 }
 
 // 过渡结束处理
 function onTransitionEnd() {
-  if (!props.expanded) {
-    transitionEnd.value = true
-  }
+  transitionEnd.value = true
+
 }
 
 // iframe 消息通信
@@ -180,6 +186,16 @@ watch(
   color: var(--color);
 }
 
+.demo-qrcode{
+  font-size: 28px !important;
+  transition: all 0.3s ease-in-out;
+  position: absolute;
+  left: calc(50% - 14px);
+  --color: inherit;
+  fill: currentColor;
+  color: var(--color);
+}
+
 .expand-icon {
   position: absolute;
   right: 8px;

diff --git a/docs/public/wxqrcode/action-sheet.png b/docs/public/wxqrcode/action-sheet.png
diff --git a/docs/public/wxqrcode/backtop.png b/docs/public/wxqrcode/backtop.png
diff --git a/docs/public/wxqrcode/badge.png b/docs/public/wxqrcode/badge.png
diff --git a/docs/public/wxqrcode/button.png b/docs/public/wxqrcode/button.png
diff --git a/docs/public/wxqrcode/calendar-view.png b/docs/public/wxqrcode/calendar-view.png
diff --git a/docs/public/wxqrcode/calendar.png b/docs/public/wxqrcode/calendar.png
diff --git a/docs/public/wxqrcode/card.png b/docs/public/wxqrcode/card.png
diff --git a/docs/public/wxqrcode/cell.png b/docs/public/wxqrcode/cell.png
diff --git a/docs/public/wxqrcode/checkbox.png b/docs/public/wxqrcode/checkbox.png
diff --git a/docs/public/wxqrcode/circle.png b/docs/public/wxqrcode/circle.png
diff --git a/docs/public/wxqrcode/col-picker.png b/docs/public/wxqrcode/col-picker.png
diff --git a/docs/public/wxqrcode/collapse.png b/docs/public/wxqrcode/collapse.png
diff --git a/docs/public/wxqrcode/config-provider.png b/docs/public/wxqrcode/config-provider.png
diff --git a/docs/public/wxqrcode/count-down.png b/docs/public/wxqrcode/count-down.png
diff --git a/docs/public/wxqrcode/count-to.png b/docs/public/wxqrcode/count-to.png
diff --git a/docs/public/wxqrcode/curtain.png b/docs/public/wxqrcode/curtain.png
diff --git a/docs/public/wxqrcode/datetime-picker-view.png b/docs/public/wxqrcode/datetime-picker-view.png
diff --git a/docs/public/wxqrcode/datetime-picker.png b/docs/public/wxqrcode/datetime-picker.png
diff --git a/docs/public/wxqrcode/divider.png b/docs/public/wxqrcode/divider.png
diff --git a/docs/public/wxqrcode/drop-menu.png b/docs/public/wxqrcode/drop-menu.png
diff --git a/docs/public/wxqrcode/fab.png b/docs/public/wxqrcode/fab.png
diff --git a/docs/public/wxqrcode/floating-panel.png b/docs/public/wxqrcode/floating-panel.png
diff --git a/docs/public/wxqrcode/form.png b/docs/public/wxqrcode/form.png
diff --git a/docs/public/wxqrcode/gap.png b/docs/public/wxqrcode/gap.png
diff --git a/docs/public/wxqrcode/grid.png b/docs/public/wxqrcode/grid.png
diff --git a/docs/public/wxqrcode/icon.png b/docs/public/wxqrcode/icon.png
diff --git a/docs/public/wxqrcode/img-cropper.png b/docs/public/wxqrcode/img-cropper.png
diff --git a/docs/public/wxqrcode/img.png b/docs/public/wxqrcode/img.png
diff --git a/docs/public/wxqrcode/index-bar.png b/docs/public/wxqrcode/index-bar.png
diff --git a/docs/public/wxqrcode/index.png b/docs/public/wxqrcode/index.png
diff --git a/docs/public/wxqrcode/input-number.png b/docs/public/wxqrcode/input-number.png
diff --git a/docs/public/wxqrcode/input.png b/docs/public/wxqrcode/input.png
diff --git a/docs/public/wxqrcode/keyboard.png b/docs/public/wxqrcode/keyboard.png
diff --git a/docs/public/wxqrcode/layout.png b/docs/public/wxqrcode/layout.png
diff --git a/docs/public/wxqrcode/loading.png b/docs/public/wxqrcode/loading.png
diff --git a/docs/public/wxqrcode/loadmore.png b/docs/public/wxqrcode/loadmore.png
diff --git a/docs/public/wxqrcode/message-box.png b/docs/public/wxqrcode/message-box.png
diff --git a/docs/public/wxqrcode/navbar.png b/docs/public/wxqrcode/navbar.png
diff --git a/docs/public/wxqrcode/notice-bar.png b/docs/public/wxqrcode/notice-bar.png
diff --git a/docs/public/wxqrcode/notify.png b/docs/public/wxqrcode/notify.png
diff --git a/docs/public/wxqrcode/number-keyboard.png b/docs/public/wxqrcode/number-keyboard.png
diff --git a/docs/public/wxqrcode/overlay.png b/docs/public/wxqrcode/overlay.png
diff --git a/docs/public/wxqrcode/pagination.png b/docs/public/wxqrcode/pagination.png
diff --git a/docs/public/wxqrcode/password-input.png b/docs/public/wxqrcode/password-input.png
diff --git a/docs/public/wxqrcode/picker-view.png b/docs/public/wxqrcode/picker-view.png
diff --git a/docs/public/wxqrcode/picker.png b/docs/public/wxqrcode/picker.png
diff --git a/docs/public/wxqrcode/popover.png b/docs/public/wxqrcode/popover.png
diff --git a/docs/public/wxqrcode/popup.png b/docs/public/wxqrcode/popup.png
diff --git a/docs/public/wxqrcode/progress.png b/docs/public/wxqrcode/progress.png
diff --git a/docs/public/wxqrcode/radio.png b/docs/public/wxqrcode/radio.png
diff --git a/docs/public/wxqrcode/rate.png b/docs/public/wxqrcode/rate.png
diff --git a/docs/public/wxqrcode/resize.png b/docs/public/wxqrcode/resize.png
diff --git a/docs/public/wxqrcode/search.png b/docs/public/wxqrcode/search.png
diff --git a/docs/public/wxqrcode/segmented.png b/docs/public/wxqrcode/segmented.png
diff --git a/docs/public/wxqrcode/select-picker.png b/docs/public/wxqrcode/select-picker.png
diff --git a/docs/public/wxqrcode/sidebar.png b/docs/public/wxqrcode/sidebar.png
diff --git a/docs/public/wxqrcode/skeleton.png b/docs/public/wxqrcode/skeleton.png
diff --git a/docs/public/wxqrcode/slider.png b/docs/public/wxqrcode/slider.png
diff --git a/docs/public/wxqrcode/sort-button.png b/docs/public/wxqrcode/sort-button.png
diff --git a/docs/public/wxqrcode/status-tip.png b/docs/public/wxqrcode/status-tip.png
diff --git a/docs/public/wxqrcode/steps.png b/docs/public/wxqrcode/steps.png
diff --git a/docs/public/wxqrcode/sticky.png b/docs/public/wxqrcode/sticky.png
diff --git a/docs/public/wxqrcode/swipe-action.png b/docs/public/wxqrcode/swipe-action.png
diff --git a/docs/public/wxqrcode/swiper.png b/docs/public/wxqrcode/swiper.png
diff --git a/docs/public/wxqrcode/switch.png b/docs/public/wxqrcode/switch.png
diff --git a/docs/public/wxqrcode/tabbar.png b/docs/public/wxqrcode/tabbar.png
diff --git a/docs/public/wxqrcode/table.png b/docs/public/wxqrcode/table.png
diff --git a/docs/public/wxqrcode/tabs.png b/docs/public/wxqrcode/tabs.png
diff --git a/docs/public/wxqrcode/tag.png b/docs/public/wxqrcode/tag.png
diff --git a/docs/public/wxqrcode/text.png b/docs/public/wxqrcode/text.png
diff --git a/docs/public/wxqrcode/textarea.png b/docs/public/wxqrcode/textarea.png
diff --git a/docs/public/wxqrcode/toast.png b/docs/public/wxqrcode/toast.png
diff --git a/docs/public/wxqrcode/tooltip.png b/docs/public/wxqrcode/tooltip.png
diff --git a/docs/public/wxqrcode/transition.png b/docs/public/wxqrcode/transition.png
diff --git a/docs/public/wxqrcode/upload.png b/docs/public/wxqrcode/upload.png
diff --git a/docs/public/wxqrcode/watermark.png b/docs/public/wxqrcode/watermark.png
diff --git a/docs/public/wxqrcode/wx-reward-ad.png b/docs/public/wxqrcode/wx-reward-ad.png
diff --git a/package.json b/package.json
@@ -55,7 +55,8 @@
     "compiler": "npm run clean:lib && node build/compiler.js",
     "upload:mp-weixin": "uni build -p mp-weixin && minici --platform weixin",
     "upload:mp-alipay": "uni build -p mp-alipay && minici --platform alipay",
-    "upload:mp-dingtalk": "uni build -p mp-dingtalk && minici --platform dd"
+    "upload:mp-dingtalk": "uni build -p mp-dingtalk && minici --platform dd",
+    "qrcode": "node build/qrcode.js"
   },
   "dependencies": {
     "@dcloudio/uni-app": "3.0.0-4020420240722002",
@@ -97,13 +98,15 @@
     "@vue/runtime-core": "^3.4.38",
     "@vue/tsconfig": "^0.1.3",
     "@vueuse/core": "^12.0.0",
+    "axios": "^1.7.9",
     "eslint": "^8.36.0",
     "eslint-config-prettier": "^8.7.0",
     "eslint-plugin-prettier": "^4.2.1",
     "eslint-plugin-vue": "^9.9.0",
     "git-cz": "^4.9.0",
     "husky": "^8.0.3",
     "inquirer": "8.0.0",
+    "json5": "^2.2.3",
     "lint-staged": "^13.2.0",
     "mini-types": "^0.1.7",
     "miniprogram-api-typings": "^3.12.3",