feat: 新增 hotkeys 子包，统一维护全局快捷键

Author: hooray

apps/core-ant-design-vue/package.json

@@ -15,6 +15,7 @@
   "dependencies": {
     "@fantastic-admin/components": "workspace:*",
     "@fantastic-admin/composables": "workspace:*",
+    "@fantastic-admin/hotkeys": "workspace:*",
     "@fantastic-admin/settings": "workspace:*",
     "@fantastic-admin/types": "workspace:*",
     "@vee-validate/zod": "catalog:",
@@ -28,7 +29,6 @@
     "dayjs": "catalog:",
     "eruda": "catalog:",
     "es-toolkit": "catalog:",
-    "hotkeys-js": "catalog:",
     "mitt": "catalog:",
     "nprogress": "catalog:",
     "path-browserify": "catalog:",

apps/core-ant-design-vue/src/hotkeys/README.md

@@ -0,0 +1,57 @@
+import type { HotkeyBinding } from '@fantastic-admin/hotkeys'
+
+/**
+ * 业务扩展快捷键 id
+ *
+ * 使用方式：
+ *
+ * export const EXT_HOTKEY_ID = {
+ *   demoOpen: 'demo.open',
+ * } as const
+ */
+export const EXT_HOTKEY_ID = {} as const
+
+type ExtendHotkeyId = typeof EXT_HOTKEY_ID[keyof typeof EXT_HOTKEY_ID]
+
+/**
+ * 业务扩展全局快捷键
+ *
+ * 示例：
+ *
+ * export const extendGlobalHotkeyBindings = [
+ *   {
+ *     id: EXT_HOTKEY_ID.demoOpen,
+ *     keys: ['command+j', 'ctrl+j'],
+ *     enabled: ctx => ctx.settings.toolbar.menuSearch.enable,
+ *     help: {
+ *       group: 'global',
+ *       titleKey: 'global.demoOpen',
+ *       order: 90,
+ *       visible: ctx => ctx.settings.toolbar.menuSearch.enable,
+ *       displayKeys: {
+ *         default: ['Ctrl', 'J'],
+ *         mac: ['⌘', 'J'],
+ *       },
+ *     },
+ *   },
+ * ] satisfies HotkeyBinding<ExtendHotkeyId>[]
+ */
+export const extendGlobalHotkeyBindings = [] satisfies HotkeyBinding<ExtendHotkeyId>[]
+
+/**
+ * 业务扩展局部快捷键
+ *
+ * 示例：
+ *
+ * export const extendScopedHotkeyBindings = [
+ *   {
+ *     id: EXT_HOTKEY_ID.demoConfirm,
+ *     keys: ['enter'],
+ *   },
+ *   {
+ *     id: EXT_HOTKEY_ID.demoClose,
+ *     keys: ['esc'],
+ *   },
+ * ] satisfies HotkeyBinding<ExtendHotkeyId>[]
+ */
+export const extendScopedHotkeyBindings = [] satisfies HotkeyBinding<ExtendHotkeyId>[]

apps/core-ant-design-vue/src/hotkeys/extend.ts

@@ -0,0 +1,41 @@
+import type {
+  HotkeyBinding,
+  HotkeyContextBase,
+  HotkeyDisplayKeys,
+  HotkeyHandler,
+  HotkeyHandlerArgs,
+  HotkeyHandlersMap,
+  HotkeyHelpGroup,
+  HotkeyHelpMeta,
+} from '@fantastic-admin/hotkeys'
+import { createHotkeys } from '@fantastic-admin/hotkeys'
+import { EXT_HOTKEY_ID, extendGlobalHotkeyBindings, extendScopedHotkeyBindings } from './extend'
+
+const appHotkeys = createHotkeys({
+  extendIds: EXT_HOTKEY_ID,
+  extendGlobalHotkeyBindings,
+  extendScopedHotkeyBindings,
+  getContext: () => ({
+    settings: useAppSettingsStore().settings,
+  }),
+})
+
+export const HOTKEY_ID = appHotkeys.HOTKEY_ID
+export const hotkeyIds = appHotkeys.hotkeyIds
+export const globalHotkeyBindings = appHotkeys.globalHotkeyBindings
+export const menuSearchHotkeyBindings = appHotkeys.menuSearchHotkeyBindings
+export const hotkeyBindings = appHotkeys.hotkeyBindings
+export const useHotkey = appHotkeys.useHotkey
+export const useHotkeyBindings = appHotkeys.useHotkeyBindings
+
+export type HotkeyId = typeof HOTKEY_ID[keyof typeof HOTKEY_ID]
+export type {
+  HotkeyBinding,
+  HotkeyContextBase,
+  HotkeyDisplayKeys,
+  HotkeyHandler,
+  HotkeyHandlerArgs,
+  HotkeyHandlersMap,
+  HotkeyHelpGroup,
+  HotkeyHelpMeta,
+}