From 50558e3bdecc145ad7b1f38643594726250648c0 Mon Sep 17 00:00:00 2001
From: xingyu4j <xingyu4j@vip.qq.com>
Date: Wed, 18 Jun 2025 13:56:16 +0800
Subject: [PATCH] perf: help

---
 apps/web-antd/src/layouts/basic.vue           |   3 +-
 .../effects/layouts/src/widgets/help/help.vue | 100 ++++++++++++++++++
 .../effects/layouts/src/widgets/help/index.ts |   1 +
 packages/effects/layouts/src/widgets/index.ts |   1 +
 4 files changed, 103 insertions(+), 2 deletions(-)
 create mode 100644 packages/effects/layouts/src/widgets/help/help.vue
 create mode 100644 packages/effects/layouts/src/widgets/help/index.ts

diff --git a/apps/web-antd/src/layouts/basic.vue b/apps/web-antd/src/layouts/basic.vue
index 7e34cbe43..fc8bcf8af 100644
--- a/apps/web-antd/src/layouts/basic.vue
+++ b/apps/web-antd/src/layouts/basic.vue
@@ -16,6 +16,7 @@ import {
 } from '@vben/icons';
 import {
   BasicLayout,
+  Help,
   LockScreen,
   Notification,
   TenantDropdown,
@@ -39,8 +40,6 @@ import { router } from '#/router';
 import { useAuthStore } from '#/store';
 import LoginForm from '#/views/_core/authentication/login.vue';
 
-import Help from './components/help.vue';
-
 // 租户列表
 const tenants = ref<SystemTenantApi.Tenant[]>([]);
 
diff --git a/packages/effects/layouts/src/widgets/help/help.vue b/packages/effects/layouts/src/widgets/help/help.vue
new file mode 100644
index 000000000..ca3c79c8c
--- /dev/null
+++ b/packages/effects/layouts/src/widgets/help/help.vue
@@ -0,0 +1,100 @@
+<script lang="ts" setup>
+import { $t } from '@vben/locales';
+import { openWindow } from '@vben/utils';
+
+import { useVbenModal } from '@vben-core/popup-ui';
+import { Badge, VbenButton, VbenButtonGroup } from '@vben-core/shadcn-ui';
+
+import { useMagicKeys, whenever } from '@vueuse/core';
+
+defineOptions({
+  name: 'Help',
+});
+
+const keys = useMagicKeys();
+whenever(keys['Alt+KeyH']!, () => {
+  modalApi.open();
+});
+
+const [Modal, modalApi] = useVbenModal({
+  draggable: true,
+  overlayBlur: 5,
+  footer: false,
+  onCancel() {
+    modalApi.close();
+  },
+});
+</script>
+<template>
+  <Modal class="w-2/5" :title="$t('ui.widgets.qa')">
+    <div class="mt-2 flex flex-col">
+      <div class="mt-2 flex flex-row">
+        <VbenButtonGroup class="basis-1/3" :gap="2" border size="large">
+          <p class="p-2">项目地址:</p>
+          <VbenButton
+            variant="link"
+            @click="
+              openWindow('https://gitee.com/yudaocode/yudao-ui-admin-vben')
+            "
+          >
+            Gitee
+          </VbenButton>
+          <VbenButton
+            variant="link"
+            @click="
+              openWindow('https://github.com/yudaocode/yudao-ui-admin-vben')
+            "
+          >
+            Github
+          </VbenButton>
+        </VbenButtonGroup>
+
+        <VbenButtonGroup class="basis-1/3" :gap="2" border size="large">
+          <p class="p-2">issues:</p>
+          <VbenButton
+            variant="link"
+            @click="
+              openWindow(
+                'https://gitee.com/yudaocode/yudao-ui-admin-vben/issues',
+              )
+            "
+          >
+            Gitee
+          </VbenButton>
+          <VbenButton
+            variant="link"
+            @click="
+              openWindow(
+                'https://github.com/yudaocode/yudao-ui-admin-vben/issues',
+              )
+            "
+          >
+            Github
+          </VbenButton>
+        </VbenButtonGroup>
+
+        <VbenButtonGroup class="basis-1/3" :gap="2" border size="large">
+          <p class="p-2">开发文档:</p>
+          <VbenButton
+            variant="link"
+            @click="openWindow('https://doc.iocoder.cn/quick-start/')"
+          >
+            项目文档
+          </VbenButton>
+          <VbenButton variant="link" @click="openWindow('https://antdv.com/')">
+            antdv 文档
+          </VbenButton>
+        </VbenButtonGroup>
+      </div>
+      <p class="mt-2 flex justify-center">
+        <span>
+          <img src="/wx-xingyu.png" alt="数舵科技" />
+        </span>
+      </p>
+      <p class="mt-2 flex justify-center pt-4 text-sm italic">
+        本项目采用<Badge variant="destructive">MIT</Badge>
+        开源协议，个人与企业可100% 免费使用。
+      </p>
+    </div>
+  </Modal>
+</template>
diff --git a/packages/effects/layouts/src/widgets/help/index.ts b/packages/effects/layouts/src/widgets/help/index.ts
new file mode 100644
index 000000000..2d470b4d5
--- /dev/null
+++ b/packages/effects/layouts/src/widgets/help/index.ts
@@ -0,0 +1 @@
+export { default as Help } from './help.vue';
diff --git a/packages/effects/layouts/src/widgets/index.ts b/packages/effects/layouts/src/widgets/index.ts
index efa5e9b8d..0c4ef7ef6 100644
--- a/packages/effects/layouts/src/widgets/index.ts
+++ b/packages/effects/layouts/src/widgets/index.ts
@@ -2,6 +2,7 @@ export { default as Breadcrumb } from './breadcrumb.vue';
 export * from './check-updates';
 export { default as AuthenticationColorToggle } from './color-toggle.vue';
 export * from './global-search';
+export * from './help';
 export { default as LanguageToggle } from './language-toggle.vue';
 export { default as AuthenticationLayoutToggle } from './layout-toggle.vue';
 export * from './lock-screen';