cnhis-design-vue 3.1.15-beta.7 → 3.1.15

package/es/packages/shortcut-provider/src/ShortcutProvider.vue.d.ts

@@ -1,6 +1,21 @@
 import { ShortcutManager } from '../../../../es/packages/shortcut-provider';
-declare const _default: import("vue").DefineComponent<{}, {
+declare const _default: import("vue").DefineComponent<{
+    scope: {
+        type: (SymbolConstructor | StringConstructor)[];
+    };
+}, {
+    props: Readonly<import("@vue/shared").LooseRequired<Readonly<import("vue").ExtractPropTypes<{
+        scope: {
+            type: (SymbolConstructor | StringConstructor)[];
+        };
+    }>> & {
+        [x: `on${string}`]: ((...args: any[]) => any) | ((...args: unknown[]) => any) | undefined;
+    }>>;
     shortcutWrapperRef: import("vue").Ref<HTMLElement | undefined>;
     manager: ShortcutManager;
-}, {}, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, import("vue").EmitsOptions, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{}>>, {}>;
+}, unknown, {}, {}, import("vue").ComponentOptionsMixin, import("vue").ComponentOptionsMixin, Record<string, any>, string, import("vue").VNodeProps & import("vue").AllowedComponentProps & import("vue").ComponentCustomProps, Readonly<import("vue").ExtractPropTypes<{
+    scope: {
+        type: (SymbolConstructor | StringConstructor)[];
+    };
+}>>, {}>;
 export default _default;

package/es/packages/shortcut-provider/src/hooks/index.js

@@ -1,2 +1,2 @@
-export { ShortcutManager, useShortcuts } from './useShortcuts.js';
+export { GlobalShortcutProvider, ShortcutManager, useShortcuts } from './useShortcuts.js';
 export { useShortcutSignature } from './useShortcutSignature.js';

package/es/packages/shortcut-provider/src/hooks/useShortcuts.d.ts

@@ -1,5 +1,6 @@
-import { ShortcutItem, ShortcutOption, ShortcutSignatureInfo } from '../../../../../es/packages/shortcut-provider/src/types';
 import { MaybeRef } from '@vueuse/core';
+import { ShortcutItem, ShortcutOption, ShortcutSignatureInfo } from '../../../../../es/packages/shortcut-provider/src/types';
+export declare const GlobalShortcutProvider: unique symbol;
 export declare class ShortcutManager {
     private readonly shortcutCallbackMap;
     private readonly shortcutCache;
@@ -7,27 +8,26 @@ export declare class ShortcutManager {
     private handle?;
     disabled: boolean;
     static log(message: string, dryRun?: boolean): string;
-    constructor(environmentEle?: MaybeRef<HTMLElement | undefined>);
+    constructor(environmentEle?: MaybeRef<HTMLElement | undefined>, scope?: string | Symbol);
     get traverse(): Omit<ShortcutItem, "callback">[];
-    query(key: string): Omit<ShortcutItem, "callback">;
-    updateDisabled(key: string, state?: boolean): Promise<void>;
-    update(key: string, info?: KeyboardEvent | Partial<ShortcutSignatureInfo>): Promise<void>;
+    private query;
+    update(key: string, info: KeyboardEvent | Partial<ShortcutSignatureInfo>): Promise<void>;
     register(shortcutItem: ShortcutItem): {
         stop: () => void;
+        start: () => void;
         signature: () => string;
     };
     start(): this;
     destroy(): void;
+    clear(): void;
 }
-export declare function useShortcuts(glob?: boolean): {
+export declare function useShortcuts(scope?: MaybeRef<string | Symbol | undefined>): {
     register: (shortcut: ShortcutOption) => {
         stop: () => void;
         signature: () => string;
     };
     traverse: () => Omit<ShortcutItem, "callback">[];
-    query: (key: string) => Omit<ShortcutItem, "callback">;
-    update: (key: string, info: KeyboardEvent | Partial<ShortcutSignatureInfo>) => void;
-    onReset: (key: string) => void;
-    updateDisabled: (key: string, state?: boolean) => void;
+    clear: () => void;
+    update: (key: string, info: KeyboardEvent | Partial<ShortcutSignatureInfo>) => Promise<void>;
     updateManagerDisabled: (disabled?: boolean) => void;
 };

package/es/packages/shortcut-provider/src/hooks/useShortcuts.js

@@ -1,15 +1,18 @@
-import { ShortcutStatus, InjectionShortcutManager } from '../../../../packages/shortcut-provider/src/constants';
-import { normalizeSignatureInfo, getKeySignature, getDisplaySignature, isInvalidSignature, isKeyboardEvent, findAncestor, isShortcutProvider } from '../../../../packages/shortcut-provider/src/utils';
-import { reactive, ref, unref, getCurrentInstance, inject, onBeforeUnmount } from 'vue';
 import { useEventListener, useDebounceFn } from '@vueuse/core';
 import { pick, omit, isFunction, isString } from 'lodash-es';
+import { reactive, ref, unref, computed, getCurrentInstance, inject, onBeforeUnmount, onDeactivated, onActivated } from 'vue';
+import { ShortcutStatus, InjectionShortcutManager } from '../../../../packages/shortcut-provider/src/constants';
+import { normalizeSignatureInfo, getKeySignature, getDisplaySignature, isInvalidSignature, isKeyboardEvent, findAncestor, isShortcutProvider } from '../../../../packages/shortcut-provider/src/utils';
 
+const GlobalShortcutProvider = Symbol("Glob");
+const ShortcutManagerCacheMap = /* @__PURE__ */ new Map();
 class ShortcutManager {
-  constructor(environmentEle) {
+  constructor(environmentEle, scope = GlobalShortcutProvider) {
     this.shortcutCallbackMap = reactive(/* @__PURE__ */ new Map());
     this.shortcutCache = ref({});
     this.disabled = false;
     this.environmentEle = environmentEle || window;
+    ShortcutManagerCacheMap.set(scope, this);
   }
   static log(message, dryRun = false) {
     const _message = `[ShortcutManager] ${message}`;
@@ -22,12 +25,6 @@ class ShortcutManager {
   query(key) {
     return this.shortcutCache.value[key];
   }
-  async updateDisabled(key, state) {
-    var _a;
-    const item = this.query(key);
-    await ((_a = item.onUpdateDisabled) == null ? void 0 : _a.call(item, key, state));
-    item.disabled = !!state;
-  }
   async update(key, info) {
     var _a, _b;
     const oldKeySignature = (_a = this.query(key)) == null ? void 0 : _a.currentKeySignature;
@@ -35,11 +32,10 @@ class ShortcutManager {
     const item = this.query(key);
     if (!item)
       return;
-    const newInfo = await ((_b = item.onUpdate) == null ? void 0 : _b.call(item, key, info ? normalizeSignatureInfo(info) : void 0)) || info;
-    if (!newInfo)
-      return;
-    checkSignature(this.shortcutCache, newInfo);
-    item.currentKeySignature = getKeySignature(newInfo);
+    await ((_b = item.onUpdate) == null ? void 0 : _b.call(item, key, info ? normalizeSignatureInfo(info) : void 0));
+    checkSignature(this.shortcutCache, info);
+    item.currentKeySignature = getKeySignature(info);
+    item.shortcutSignature = normalizeSignatureInfo(info);
     this.shortcutCallbackMap.set(item.currentKeySignature, this.shortcutCallbackMap.get(oldKeySignature));
     this.shortcutCallbackMap.delete(oldKeySignature);
     function checkSignature(shortcutCache, info2) {
@@ -69,6 +65,9 @@ class ShortcutManager {
         stop: () => {
           shortcut.status = ShortcutStatus.INACTIVE;
         },
+        start: () => {
+          shortcut.status = ShortcutStatus.ACTIVE;
+        },
         signature: () => shortcut.currentKeySignature
       };
     }
@@ -101,23 +100,35 @@ class ShortcutManager {
     var _a;
     this.handle && ((_a = unref(this.environmentEle)) == null ? void 0 : _a.removeEventListener("keyup", this.handle, { capture: true }));
     this.handle = void 0;
+    this.clear();
+  }
+  clear() {
     this.shortcutCallbackMap.clear();
+    this.shortcutCache.value = {};
   }
 }
 const globManager = new ShortcutManager().start();
-function useShortcuts(glob = false) {
+function useShortcuts(scope) {
   function useManager() {
-    if (getCurrentInstance() && !glob) {
-      return inject(InjectionShortcutManager, globManager);
-    } else {
-      ShortcutManager.log("\u975Esetup\u8BED\u5883\u4E0B\u7684shortcut\u5C06\u5F71\u54CD\u5168\u5C40");
-      return globManager;
-    }
+    return computed(() => {
+      if (unref(scope)) {
+        const result = ShortcutManagerCacheMap.get(unref(scope));
+        if (!result)
+          ShortcutManager.log(`\u4E0D\u5B58\u5728\u7684scope=>${scope}, \u5C06\u4F7F\u7528\u5168\u5C40\u5FEB\u6377\u952E`);
+        return result || globManager;
+      } else if (getCurrentInstance()) {
+        return inject(InjectionShortcutManager, globManager);
+      } else {
+        ShortcutManager.log("\u975Esetup\u8BED\u5883\u4E0B\u7684shortcut\u5C06\u5F71\u54CD\u5168\u5C40");
+        return globManager;
+      }
+    });
   }
   const manager = useManager();
   function createShortcutItem(shortcut) {
     return {
       ...shortcut,
+      shortcutSignature: normalizeSignatureInfo(shortcut.shortcutSignature),
       currentKeySignature: getKeySignature(shortcut.shortcutSignature),
       key: keyFor(shortcut),
       status: ShortcutStatus.ACTIVE,
@@ -141,33 +152,29 @@ function useShortcuts(glob = false) {
     }
   }
   function register(shortcut) {
-    const { stop, signature } = manager.register(createShortcutItem(shortcut));
-    if (getCurrentInstance() && !glob) {
+    const { stop, signature, start } = unref(manager).register(createShortcutItem(shortcut));
+    if (getCurrentInstance()) {
       onBeforeUnmount(stop);
+      onDeactivated(stop);
+      onActivated(start);
     } else {
       ShortcutManager.log("\u5728\u975Esetup\u8BED\u5883\u4E0B\u4F7F\u7528register\u51FD\u6570,\u7EC4\u4EF6\u9500\u6BC1\u65F6\u53EF\u80FD\u9700\u8981\u624B\u52A8\u8C03\u7528stop\u51FD\u6570\u4F7F\u5FEB\u6377\u952E\u5931\u6D3B");
     }
     return { stop, signature };
   }
   function traverse() {
-    return glob ? globManager.traverse : manager.traverse;
-  }
-  function query(key) {
-    return manager.query(key);
+    return unref(manager).traverse;
   }
   function update(key, info) {
-    manager.update(key, info);
-  }
-  function onReset(key) {
-    manager.update(key);
-  }
-  function updateDisabled(key, state) {
-    manager.updateDisabled(key, state);
+    return unref(manager).update(key, info);
   }
   function updateManagerDisabled(disabled) {
-    manager.disabled = !!disabled;
+    unref(manager).disabled = !!disabled;
+  }
+  function clear() {
+    unref(manager).clear();
   }
-  return { register, traverse, query, update, onReset, updateDisabled, updateManagerDisabled };
+  return { register, traverse, clear, update, updateManagerDisabled };
 }
 
-export { ShortcutManager, useShortcuts };
+export { GlobalShortcutProvider, ShortcutManager, useShortcuts };

package/es/packages/shortcut-provider/src/types/index.d.ts

@@ -1,37 +1,21 @@
-import { ArrayAble, WithUndefined } from '../../../../../es/src/types';
-import { VNode } from 'vue';
 import { ShortcutStatus } from '../../../../../es/packages/shortcut-provider/src/constants';
-declare type Render = () => ArrayAble<VNode>;
 export interface ShortcutSignatureInfo {
     ctrl?: boolean;
     shift?: boolean;
     alt?: boolean;
     key: string;
 }
-declare type UpdateResult = Promise<WithUndefined<ShortcutSignatureInfo> | void>;
 export declare type ShortcutOption = {
-    label: string | Render;
+    label: string;
     shortcutSignature: ShortcutSignatureInfo;
     callback(): void;
 } & Partial<{
-    /**
-     * @description 重置时回调
-     * @param key
-     */
-    onReset(key: string): Promise<any>;
     /**
      * @description 更新快捷键回调
      * @param key
      * @param newSignature 用户输入的快捷键签名
-     * @return
-     */
-    onUpdate(key: string, newSignature?: ShortcutSignatureInfo): UpdateResult;
-    /**
-     * @description 更新快捷键disabled状态回调
-     * @param key
-     * @param newState
      */
-    onUpdateDisabled(key: string, newState?: boolean): Promise<any>;
+    onUpdate(key: string, newSignature?: ShortcutSignatureInfo): Promise<void>;
     /**
      * 快捷键输入框展位文本
      */
@@ -57,4 +41,3 @@ export interface ShortcutItem extends ShortcutOption {
     currentKeySignature: string;
     key: string;
 }
-export {};