npm - @visactor/vtable-plugins - Versions diffs - 1.20.2 → 1.21.0 - Mend

@visactor/vtable-plugins 1.20.2 → 1.21.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (9) hide show

package/cjs/excel-edit-cell-keyboard.d.ts +15 -0
package/cjs/excel-edit-cell-keyboard.js +30 -13
package/cjs/excel-edit-cell-keyboard.js.map +1 -1
package/dist/vtable-plugins.js +63 -37
package/dist/vtable-plugins.min.js +2 -2
package/es/excel-edit-cell-keyboard.d.ts +15 -0
package/es/excel-edit-cell-keyboard.js +29 -12
package/es/excel-edit-cell-keyboard.js.map +1 -1
package/package.json +7 -7

package/cjs/excel-edit-cell-keyboard.d.ts CHANGED Viewed

@@ -1,8 +1,19 @@
 import type { ListTable, BaseTableAPI, pluginsDefinition } from '@visactor/vtable';
 import type { TableEvents } from '@visactor/vtable/src/core/TABLE_EVENT_TYPE';
 import type { EventArg } from './types';
+export declare enum ExcelEditCellKeyboardResponse {
+    ENTER = "enter",
+    TAB = "tab",
+    ARROW_LEFT = "arrowLeft",
+    ARROW_RIGHT = "arrowRight",
+    ARROW_DOWN = "arrowDown",
+    ARROW_UP = "arrowUp",
+    DELETE = "delete",
+    BACKSPACE = "backspace"
+}
 export type IExcelEditCellKeyboardPluginOptions = {
     id?: string;
+    responseKeyboard?: ExcelEditCellKeyboardResponse[];
 };
 export declare class ExcelEditCellKeyboardPlugin implements pluginsDefinition.IVTablePlugin {
     id: string;
@@ -10,10 +21,14 @@ export declare class ExcelEditCellKeyboardPlugin implements pluginsDefinition.IV
     runTime: "initialized"[];
     table: ListTable;
     pluginOptions: IExcelEditCellKeyboardPluginOptions;
+    responseKeyboard: ExcelEditCellKeyboardResponse[];
     constructor(pluginOptions?: IExcelEditCellKeyboardPluginOptions);
     run(...args: [EventArg, TableEvents[keyof TableEvents] | TableEvents[keyof TableEvents][], BaseTableAPI]): void;
     bindEvent(): void;
     handleKeyDown(event: KeyboardEvent): void;
     isExcelShortcutKey(event: KeyboardEvent): boolean;
+    setResponseKeyboard(responseKeyboard: ExcelEditCellKeyboardResponse[]): void;
+    deleteResponseKeyboard(responseKeyboard: ExcelEditCellKeyboardResponse[]): void;
+    addResponseKeyboard(responseKeyboard: ExcelEditCellKeyboardResponse[]): void;
     release(): void;
 }

package/cjs/excel-edit-cell-keyboard.js CHANGED Viewed

@@ -2,16 +2,26 @@
 Object.defineProperty(exports, "__esModule", {
     value: !0
-}), exports.ExcelEditCellKeyboardPlugin = void 0;
+}), exports.ExcelEditCellKeyboardPlugin = exports.ExcelEditCellKeyboardResponse = void 0;
 const vtable_1 = require("@visactor/vtable");
+var ExcelEditCellKeyboardResponse;
+!function(ExcelEditCellKeyboardResponse) {
+    ExcelEditCellKeyboardResponse.ENTER = "enter", ExcelEditCellKeyboardResponse.TAB = "tab",
+    ExcelEditCellKeyboardResponse.ARROW_LEFT = "arrowLeft", ExcelEditCellKeyboardResponse.ARROW_RIGHT = "arrowRight",
+    ExcelEditCellKeyboardResponse.ARROW_DOWN = "arrowDown", ExcelEditCellKeyboardResponse.ARROW_UP = "arrowUp",
+    ExcelEditCellKeyboardResponse.DELETE = "delete", ExcelEditCellKeyboardResponse.BACKSPACE = "backspace";
+}(ExcelEditCellKeyboardResponse = exports.ExcelEditCellKeyboardResponse || (exports.ExcelEditCellKeyboardResponse = {}));
 class ExcelEditCellKeyboardPlugin {
     constructor(pluginOptions) {
-        var _a;
+        var _a, _b;
         this.id = "excel-edit-cell-keyboard", this.name = "Excel Edit Cell Keyboard", this.runTime = [ vtable_1.TABLE_EVENT_TYPE.INITIALIZED ],
         this.id = null !== (_a = null == pluginOptions ? void 0 : pluginOptions.id) && void 0 !== _a ? _a : this.id,
-        this.pluginOptions = pluginOptions, this.bindEvent();
+        this.pluginOptions = pluginOptions, this.responseKeyboard = null !== (_b = null == pluginOptions ? void 0 : pluginOptions.responseKeyboard) && void 0 !== _b ? _b : [ ExcelEditCellKeyboardResponse.ENTER, ExcelEditCellKeyboardResponse.TAB, ExcelEditCellKeyboardResponse.ARROW_LEFT, ExcelEditCellKeyboardResponse.ARROW_RIGHT, ExcelEditCellKeyboardResponse.ARROW_DOWN, ExcelEditCellKeyboardResponse.ARROW_UP, ExcelEditCellKeyboardResponse.DELETE, ExcelEditCellKeyboardResponse.BACKSPACE ],
+        this.bindEvent();
     }
     run(...args) {
         const table = args[2];
@@ -21,27 +31,34 @@ class ExcelEditCellKeyboardPlugin {
         document.addEventListener("keydown", this.handleKeyDown.bind(this), !0);
     }
     handleKeyDown(event) {
-        if (this.table.editorManager) if ("keydown" === this.table.editorManager.beginTriggerEditCellMode) {
-            if (this.table.editorManager.editingEditor && this.isExcelShortcutKey(event)) {
-                const {col: col, row: row} = this.table.editorManager.editCell;
-                this.table.editorManager.completeEdit(), this.table.getElement().focus(), event.shiftKey || event.ctrlKey || event.metaKey || ("Enter" === event.key ? this.table.selectCell(col, row + 1) : "Tab" === event.key ? this.table.selectCell(col + 1, row) : "ArrowLeft" === event.key ? this.table.selectCell(col - 1, row) : "ArrowRight" === event.key ? this.table.selectCell(col + 1, row) : "ArrowDown" === event.key ? this.table.selectCell(col, row + 1) : "ArrowUp" === event.key && this.table.selectCell(col, row - 1),
-                event.stopPropagation(), event.preventDefault());
-            }
+        if (this.table.editorManager && this.isExcelShortcutKey(event)) if (this.table.editorManager.editingEditor && "keydown" === this.table.editorManager.beginTriggerEditCellMode) {
+            const {col: col, row: row} = this.table.editorManager.editCell;
+            this.table.editorManager.completeEdit(), this.table.getElement().focus(), event.shiftKey || event.ctrlKey || event.metaKey || (event.key === ExcelEditCellKeyboardResponse.ENTER ? this.table.selectCell(col, row + 1) : event.key === ExcelEditCellKeyboardResponse.TAB ? this.table.selectCell(col + 1, row) : event.key === ExcelEditCellKeyboardResponse.ARROW_LEFT ? this.table.selectCell(col - 1, row) : event.key === ExcelEditCellKeyboardResponse.ARROW_RIGHT ? this.table.selectCell(col + 1, row) : event.key === ExcelEditCellKeyboardResponse.ARROW_DOWN ? this.table.selectCell(col, row + 1) : event.key === ExcelEditCellKeyboardResponse.ARROW_UP && this.table.selectCell(col, row - 1),
+            event.stopPropagation(), event.preventDefault());
         } else {
             const {col: col, row: row} = this.table.stateManager.select.cellPos;
-            if (!this.table.editorManager.editingEditor || "Enter" !== event.key && "Tab" !== event.key) {
-                if (!this.table.editorManager.editingEditor && ("Delete" === event.key || "Backspace" === event.key)) {
+            if (!this.table.editorManager.editingEditor || event.key !== ExcelEditCellKeyboardResponse.ENTER && event.key !== ExcelEditCellKeyboardResponse.TAB) {
+                if (!this.table.editorManager.editingEditor && (event.key === ExcelEditCellKeyboardResponse.DELETE || event.key === ExcelEditCellKeyboardResponse.BACKSPACE)) {
                     const selectCells = this.table.getSelectedCellInfos();
                     (null == selectCells ? void 0 : selectCells.length) > 0 && deleteSelectRange(selectCells, this.table),
                     event.stopPropagation(), event.preventDefault();
                 }
             } else this.table.editorManager.completeEdit(), this.table.getElement().focus(),
-            "Enter" === event.key ? this.table.selectCell(col, row + 1) : "Tab" === event.key && this.table.selectCell(col + 1, row),
+            event.key === ExcelEditCellKeyboardResponse.ENTER ? this.table.selectCell(col, row + 1) : event.key === ExcelEditCellKeyboardResponse.TAB && this.table.selectCell(col + 1, row),
             event.stopPropagation(), event.preventDefault();
         }
     }
     isExcelShortcutKey(event) {
-        return "Enter" === event.key || "Tab" === event.key || "ArrowLeft" === event.key || "ArrowRight" === event.key || "ArrowDown" === event.key || "ArrowUp" === event.key;
+        return this.responseKeyboard.includes(event.key);
+    }
+    setResponseKeyboard(responseKeyboard) {
+        this.responseKeyboard = responseKeyboard;
+    }
+    deleteResponseKeyboard(responseKeyboard) {
+        this.responseKeyboard = this.responseKeyboard.filter((key => !responseKeyboard.includes(key)));
+    }
+    addResponseKeyboard(responseKeyboard) {
+        this.responseKeyboard = [ ...this.responseKeyboard, ...responseKeyboard ];
     }
     release() {
         document.removeEventListener("keydown", this.handleKeyDown, !0);

package/cjs/excel-edit-cell-keyboard.js.map CHANGED Viewed

	@@ -1 +1 @@
1	- {"version":3,"sources":["../src/excel-edit-cell-keyboard.ts"],"names":[],"mappings":";;;AACA,6CAAoD;AAUpD,MAAa,2BAA2B;IAMtC,YAAY,aAAmD;;QAL/D,OAAE,GAAG,0BAA0B,CAAC;QAChC,SAAI,GAAG,0BAA0B,CAAC;QAClC,YAAO,GAAG,CAAC,yBAAgB,CAAC,WAAW,CAAC,CAAC;QAIvC,IAAI,CAAC,EAAE,GAAG,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,EAAE,mCAAI,IAAI,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QAEnC,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IACD,GAAG,CAAC,GAAG,IAAiG;QACtG,MAAM,KAAK,GAAiB,IAAI,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,KAAkB,CAAC;IAClC,CAAC;IAED,SAAS;QAEP,QAAQ,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;IAc5E,CAAC;IACD,aAAa,CAAC,KAAoB;QAChC,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,EAAE;YAE5B,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,wBAAwB,KAAK,SAAS,EAAE;gBACnE,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,IAAI,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE;oBAC5E,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC;oBACvD,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;oBACxC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC;oBAChC,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;wBAEvD,IAAI,KAAK,CAAC,GAAG,KAAK,OAAO,EAAE;4BACzB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC;yBACrC;6BAAM,IAAI,KAAK,CAAC,GAAG,KAAK,KAAK,EAAE;4BAC9B,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;yBACrC;6BAAM,IAAI,KAAK,CAAC,GAAG,KAAK,WAAW,EAAE;4BACpC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;yBACrC;6BAAM,IAAI,KAAK,CAAC,GAAG,KAAK,YAAY,EAAE;4BACrC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;yBACrC;6BAAM,IAAI,KAAK,CAAC,GAAG,KAAK,WAAW,EAAE;4BACpC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC;yBACrC;6BAAM,IAAI,KAAK,CAAC,GAAG,KAAK,SAAS,EAAE;4BAClC,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC;yBACrC;wBAED,KAAK,CAAC,eAAe,EAAE,CAAC;wBACxB,KAAK,CAAC,cAAc,EAAE,CAAC;qBACxB;iBACF;aACF;iBAAM;gBACL,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC;gBAC5D,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,IAAI,CAAC,KAAK,CAAC,GAAG,KAAK,OAAO,IAAI,KAAK,CAAC,GAAG,KAAK,KAAK,CAAC,EAAE;oBAC5F,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;oBACxC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC;oBAChC,IAAI,KAAK,CAAC,GAAG,KAAK,OAAO,EAAE;wBACzB,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC;qBACrC;yBAAM,IAAI,KAAK,CAAC,GAAG,KAAK,KAAK,EAAE;wBAC9B,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;qBACrC;oBAED,KAAK,CAAC,eAAe,EAAE,CAAC;oBACxB,KAAK,CAAC,cAAc,EAAE,CAAC;iBACxB;qBAAM,IAAI,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,IAAI,CAAC,KAAK,CAAC,GAAG,KAAK,QAAQ,IAAI,KAAK,CAAC,GAAG,KAAK,WAAW,CAAC,EAAE;oBAE3G,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC;oBACtD,IAAI,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,IAAG,CAAC,EAAE;wBAE3B,iBAAiB,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;qBAC5C;oBAED,KAAK,CAAC,eAAe,EAAE,CAAC;oBACxB,KAAK,CAAC,cAAc,EAAE,CAAC;iBACxB;aACF;SACF;IACH,CAAC;IAED,kBAAkB,CAAC,KAAoB;QACrC,OAAO,CACL,KAAK,CAAC,GAAG,KAAK,OAAO;YACrB,KAAK,CAAC,GAAG,KAAK,KAAK;YACnB,KAAK,CAAC,GAAG,KAAK,WAAW;YACzB,KAAK,CAAC,GAAG,KAAK,YAAY;YAC1B,KAAK,CAAC,GAAG,KAAK,WAAW;YACzB,KAAK,CAAC,GAAG,KAAK,SAAS,CACxB,CAAC;IACJ,CAAC;IACD,OAAO;QACL,QAAQ,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC;CACF;AAvGD,kEAuGC;AAED,SAAS,iBAAiB,CAAC,WAA+B,EAAE,aAAwB;IAClF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC9C,aAAa,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;SACjF;KACF;AACH,CAAC","file":"excel-edit-cell-keyboard.js","sourcesContent":["import type { ListTable, BaseTableAPI, TYPES, pluginsDefinition } from '@visactor/vtable';\nimport { TABLE_EVENT_TYPE } from '@visactor/vtable';\nimport type { TableEvents } from '@visactor/vtable/src/core/TABLE_EVENT_TYPE';\nimport type { EventArg } from './types';\n//备用插件配置项目前感觉都走默认逻辑就行\nexport type IExcelEditCellKeyboardPluginOptions = {\n id?: string;\n // 是否响应删除\n // enableDeleteKey?: boolean;\n};\n\nexport class ExcelEditCellKeyboardPlugin implements pluginsDefinition.IVTablePlugin {\n id = `excel-edit-cell-keyboard`;\n name = 'Excel Edit Cell Keyboard';\n runTime = [TABLE_EVENT_TYPE.INITIALIZED];\n table: ListTable;\n pluginOptions: IExcelEditCellKeyboardPluginOptions;\n constructor(pluginOptions?: IExcelEditCellKeyboardPluginOptions) {\n this.id = pluginOptions?.id ?? this.id;\n this.pluginOptions = pluginOptions;\n\n this.bindEvent();\n }\n run(...args: [EventArg, TableEvents[keyof TableEvents] \| TableEvents[keyof TableEvents][], BaseTableAPI]) {\n const table: BaseTableAPI = args[2];\n this.table = table as ListTable;\n }\n\n bindEvent() {\n //监听document全局的keydown事件捕获阶段监听可以及时阻止事件传播和默认行为\n document.addEventListener('keydown', this.handleKeyDown.bind(this), true);\n // this.table.on('selected_cell', () => {\n // this.updateHighlight();\n // });\n\n // this.table.on('selected_clear', () => {\n // this.clearHighlight();\n // });\n\n // this.table.on('mousemove_table', () => {\n // if (this.table.stateManager.select.selecting) {\n // this.updateHighlight();\n // }\n // });\n }\n handleKeyDown(event: KeyboardEvent) {\n if (this.table.editorManager) {\n //判断是键盘触发编辑单元格的情况下，那么在编辑状态中切换方向需要选中下一个继续编辑\n if (this.table.editorManager.beginTriggerEditCellMode === 'keydown') {\n if (this.table.editorManager.editingEditor && this.isExcelShortcutKey(event)) {\n const { col, row } = this.table.editorManager.editCell;\n this.table.editorManager.completeEdit();\n this.table.getElement().focus();\n if (!event.shiftKey && !event.ctrlKey && !event.metaKey) {\n //有这些配合键，则不进行选中下一个单元格的行为执行vtable内部逻辑\n if (event.key === 'Enter') {\n this.table.selectCell(col, row + 1);\n } else if (event.key === 'Tab') {\n this.table.selectCell(col + 1, row);\n } else if (event.key === 'ArrowLeft') {\n this.table.selectCell(col - 1, row);\n } else if (event.key === 'ArrowRight') {\n this.table.selectCell(col + 1, row);\n } else if (event.key === 'ArrowDown') {\n this.table.selectCell(col, row + 1);\n } else if (event.key === 'ArrowUp') {\n this.table.selectCell(col, row - 1);\n }\n // 阻止事件传播和默认行为\n event.stopPropagation();\n event.preventDefault();\n }\n }\n } else {\n const { col, row } = this.table.stateManager.select.cellPos;\n if (this.table.editorManager.editingEditor && (event.key === 'Enter' \|\| event.key === 'Tab')) {\n this.table.editorManager.completeEdit();\n this.table.getElement().focus();\n if (event.key === 'Enter') {\n this.table.selectCell(col, row + 1);\n } else if (event.key === 'Tab') {\n this.table.selectCell(col + 1, row);\n }\n // 阻止事件传播和默认行为\n event.stopPropagation();\n event.preventDefault();\n } else if (!this.table.editorManager.editingEditor && (event.key === 'Delete' \|\| event.key === 'Backspace')) {\n //响应删除键，删除\n const selectCells = this.table.getSelectedCellInfos();\n if (selectCells?.length > 0) {\n // 如果选中的是范围，则删除范围内的所有单元格\n deleteSelectRange(selectCells, this.table);\n }\n // 阻止事件传播和默认行为\n event.stopPropagation();\n event.preventDefault();\n }\n }\n }\n }\n // 判断event的keyCode是否是excel的快捷键\n isExcelShortcutKey(event: KeyboardEvent) {\n return (\n event.key === 'Enter' \|\|\n event.key === 'Tab' \|\|\n event.key === 'ArrowLeft' \|\|\n event.key === 'ArrowRight' \|\|\n event.key === 'ArrowDown' \|\|\n event.key === 'ArrowUp'\n );\n }\n release() {\n document.removeEventListener('keydown', this.handleKeyDown, true);\n }\n}\n//将选中单元格的值设置为空\nfunction deleteSelectRange(selectCells: TYPES.CellInfo[][], tableInstance: ListTable) {\n for (let i = 0; i < selectCells.length; i++) {\n for (let j = 0; j < selectCells[i].length; j++) {\n tableInstance.changeCellValue(selectCells[i][j].col, selectCells[i][j].row, '');\n }\n }\n}\n"]}
1	+ {"version":3,"sources":["../src/excel-edit-cell-keyboard.ts"],"names":[],"mappings":";;;AACA,6CAAoD;AAGpD,IAAY,6BASX;AATD,WAAY,6BAA6B;IACvC,gDAAe,CAAA;IACf,4CAAW,CAAA;IACX,yDAAwB,CAAA;IACxB,2DAA0B,CAAA;IAC1B,yDAAwB,CAAA;IACxB,qDAAoB,CAAA;IACpB,kDAAiB,CAAA;IACjB,wDAAuB,CAAA;AACzB,CAAC,EATW,6BAA6B,GAA7B,qCAA6B,KAA7B,qCAA6B,QASxC;AASD,MAAa,2BAA2B;IAOtC,YAAY,aAAmD;;QAN/D,OAAE,GAAG,0BAA0B,CAAC;QAChC,SAAI,GAAG,0BAA0B,CAAC;QAClC,YAAO,GAAG,CAAC,yBAAgB,CAAC,WAAW,CAAC,CAAC;QAKvC,IAAI,CAAC,EAAE,GAAG,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,EAAE,mCAAI,IAAI,CAAC,EAAE,CAAC;QACvC,IAAI,CAAC,aAAa,GAAG,aAAa,CAAC;QACnC,IAAI,CAAC,gBAAgB,GAAG,MAAA,aAAa,aAAb,aAAa,uBAAb,aAAa,CAAE,gBAAgB,mCAAI;YACzD,6BAA6B,CAAC,KAAK;YACnC,6BAA6B,CAAC,GAAG;YACjC,6BAA6B,CAAC,UAAU;YACxC,6BAA6B,CAAC,WAAW;YACzC,6BAA6B,CAAC,UAAU;YACxC,6BAA6B,CAAC,QAAQ;YACtC,6BAA6B,CAAC,MAAM;YACpC,6BAA6B,CAAC,SAAS;SACxC,CAAC;QAEF,IAAI,CAAC,SAAS,EAAE,CAAC;IACnB,CAAC;IACD,GAAG,CAAC,GAAG,IAAiG;QACtG,MAAM,KAAK,GAAiB,IAAI,CAAC,CAAC,CAAC,CAAC;QACpC,IAAI,CAAC,KAAK,GAAG,KAAkB,CAAC;IAClC,CAAC;IAED,SAAS;QAEP,QAAQ,CAAC,gBAAgB,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,CAAC,IAAI,CAAC,IAAI,CAAC,EAAE,IAAI,CAAC,CAAC;IAc5E,CAAC;IACD,aAAa,CAAC,KAAoB;QAChC,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,IAAI,IAAI,CAAC,kBAAkB,CAAC,KAAK,CAAC,EAAE;YAE9D,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa,IAAI,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,wBAAwB,KAAK,SAAS,EAAE;gBAC7G,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,QAAQ,CAAC;gBACvD,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;gBACxC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC;gBAChC,IAAI,CAAC,KAAK,CAAC,QAAQ,IAAI,CAAC,KAAK,CAAC,OAAO,IAAI,CAAC,KAAK,CAAC,OAAO,EAAE;oBAEvD,IAAI,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,KAAK,EAAE;wBACrD,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC;qBACrC;yBAAM,IAAI,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,GAAG,EAAE;wBAC1D,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;qBACrC;yBAAM,IAAI,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,UAAU,EAAE;wBACjE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;qBACrC;yBAAM,IAAI,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,WAAW,EAAE;wBAClE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;qBACrC;yBAAM,IAAI,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,UAAU,EAAE;wBACjE,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC;qBACrC;yBAAM,IAAI,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,QAAQ,EAAE;wBAC/D,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC;qBACrC;oBAED,KAAK,CAAC,eAAe,EAAE,CAAC;oBACxB,KAAK,CAAC,cAAc,EAAE,CAAC;iBACxB;aACF;iBAAM;gBACL,MAAM,EAAE,GAAG,EAAE,GAAG,EAAE,GAAG,IAAI,CAAC,KAAK,CAAC,YAAY,CAAC,MAAM,CAAC,OAAO,CAAC;gBAC5D,IACE,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa;oBACtC,CAAC,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,KAAK,IAAI,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,GAAG,CAAC,EACtG;oBACA,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,YAAY,EAAE,CAAC;oBACxC,IAAI,CAAC,KAAK,CAAC,UAAU,EAAE,CAAC,KAAK,EAAE,CAAC;oBAChC,IAAI,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,KAAK,EAAE;wBACrD,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,EAAE,GAAG,GAAG,CAAC,CAAC,CAAC;qBACrC;yBAAM,IAAI,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,GAAG,EAAE;wBAC1D,IAAI,CAAC,KAAK,CAAC,UAAU,CAAC,GAAG,GAAG,CAAC,EAAE,GAAG,CAAC,CAAC;qBACrC;oBAED,KAAK,CAAC,eAAe,EAAE,CAAC;oBACxB,KAAK,CAAC,cAAc,EAAE,CAAC;iBACxB;qBAAM,IACL,CAAC,IAAI,CAAC,KAAK,CAAC,aAAa,CAAC,aAAa;oBACvC,CAAC,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,MAAM,IAAI,KAAK,CAAC,GAAG,KAAK,6BAA6B,CAAC,SAAS,CAAC,EAC7G;oBAEA,MAAM,WAAW,GAAG,IAAI,CAAC,KAAK,CAAC,oBAAoB,EAAE,CAAC;oBACtD,IAAI,CAAA,WAAW,aAAX,WAAW,uBAAX,WAAW,CAAE,MAAM,IAAG,CAAC,EAAE;wBAE3B,iBAAiB,CAAC,WAAW,EAAE,IAAI,CAAC,KAAK,CAAC,CAAC;qBAC5C;oBAED,KAAK,CAAC,eAAe,EAAE,CAAC;oBACxB,KAAK,CAAC,cAAc,EAAE,CAAC;iBACxB;aACF;SACF;IACH,CAAC;IAED,kBAAkB,CAAC,KAAoB;QACrC,OAAO,IAAI,CAAC,gBAAgB,CAAC,QAAQ,CAAC,KAAK,CAAC,GAAoC,CAAC,CAAC;IACpF,CAAC;IACD,mBAAmB,CAAC,gBAAiD;QACnE,IAAI,CAAC,gBAAgB,GAAG,gBAAgB,CAAC;IAC3C,CAAC;IACD,sBAAsB,CAAC,gBAAiD;QACtE,IAAI,CAAC,gBAAgB,GAAG,IAAI,CAAC,gBAAgB,CAAC,MAAM,CAAC,GAAG,CAAC,EAAE,CAAC,CAAC,gBAAgB,CAAC,QAAQ,CAAC,GAAG,CAAC,CAAC,CAAC;IAC/F,CAAC;IACD,mBAAmB,CAAC,gBAAiD;QACnE,IAAI,CAAC,gBAAgB,GAAG,CAAC,GAAG,IAAI,CAAC,gBAAgB,EAAE,GAAG,gBAAgB,CAAC,CAAC;IAC1E,CAAC;IACD,OAAO;QACL,QAAQ,CAAC,mBAAmB,CAAC,SAAS,EAAE,IAAI,CAAC,aAAa,EAAE,IAAI,CAAC,CAAC;IACpE,CAAC;CACF;AAxHD,kEAwHC;AAED,SAAS,iBAAiB,CAAC,WAA+B,EAAE,aAAwB;IAClF,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;QAC3C,KAAK,IAAI,CAAC,GAAG,CAAC,EAAE,CAAC,GAAG,WAAW,CAAC,CAAC,CAAC,CAAC,MAAM,EAAE,CAAC,EAAE,EAAE;YAC9C,aAAa,CAAC,eAAe,CAAC,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,WAAW,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,CAAC,GAAG,EAAE,EAAE,CAAC,CAAC;SACjF;KACF;AACH,CAAC","file":"excel-edit-cell-keyboard.js","sourcesContent":["import type { ListTable, BaseTableAPI, TYPES, pluginsDefinition } from '@visactor/vtable';\nimport { TABLE_EVENT_TYPE } from '@visactor/vtable';\nimport type { TableEvents } from '@visactor/vtable/src/core/TABLE_EVENT_TYPE';\nimport type { EventArg } from './types';\nexport enum ExcelEditCellKeyboardResponse {\n ENTER = 'enter',\n TAB = 'tab',\n ARROW_LEFT = 'arrowLeft',\n ARROW_RIGHT = 'arrowRight',\n ARROW_DOWN = 'arrowDown',\n ARROW_UP = 'arrowUp',\n DELETE = 'delete',\n BACKSPACE = 'backspace'\n}\n//备用插件配置项目前感觉都走默认逻辑就行\nexport type IExcelEditCellKeyboardPluginOptions = {\n id?: string;\n responseKeyboard?: ExcelEditCellKeyboardResponse[];\n // 是否响应删除\n // enableDeleteKey?: boolean;\n};\n\nexport class ExcelEditCellKeyboardPlugin implements pluginsDefinition.IVTablePlugin {\n id = `excel-edit-cell-keyboard`;\n name = 'Excel Edit Cell Keyboard';\n runTime = [TABLE_EVENT_TYPE.INITIALIZED];\n table: ListTable;\n pluginOptions: IExcelEditCellKeyboardPluginOptions;\n responseKeyboard: ExcelEditCellKeyboardResponse[];\n constructor(pluginOptions?: IExcelEditCellKeyboardPluginOptions) {\n this.id = pluginOptions?.id ?? this.id;\n this.pluginOptions = pluginOptions;\n this.responseKeyboard = pluginOptions?.responseKeyboard ?? [\n ExcelEditCellKeyboardResponse.ENTER,\n ExcelEditCellKeyboardResponse.TAB,\n ExcelEditCellKeyboardResponse.ARROW_LEFT,\n ExcelEditCellKeyboardResponse.ARROW_RIGHT,\n ExcelEditCellKeyboardResponse.ARROW_DOWN,\n ExcelEditCellKeyboardResponse.ARROW_UP,\n ExcelEditCellKeyboardResponse.DELETE,\n ExcelEditCellKeyboardResponse.BACKSPACE\n ];\n\n this.bindEvent();\n }\n run(...args: [EventArg, TableEvents[keyof TableEvents] \| TableEvents[keyof TableEvents][], BaseTableAPI]) {\n const table: BaseTableAPI = args[2];\n this.table = table as ListTable;\n }\n\n bindEvent() {\n //监听document全局的keydown事件捕获阶段监听可以及时阻止事件传播和默认行为\n document.addEventListener('keydown', this.handleKeyDown.bind(this), true);\n // this.table.on('selected_cell', () => {\n // this.updateHighlight();\n // });\n\n // this.table.on('selected_clear', () => {\n // this.clearHighlight();\n // });\n\n // this.table.on('mousemove_table', () => {\n // if (this.table.stateManager.select.selecting) {\n // this.updateHighlight();\n // }\n // });\n }\n handleKeyDown(event: KeyboardEvent) {\n if (this.table.editorManager && this.isExcelShortcutKey(event)) {\n //判断是键盘触发编辑单元格的情况下，那么在编辑状态中切换方向需要选中下一个继续编辑\n if (this.table.editorManager.editingEditor && this.table.editorManager.beginTriggerEditCellMode === 'keydown') {\n const { col, row } = this.table.editorManager.editCell;\n this.table.editorManager.completeEdit();\n this.table.getElement().focus();\n if (!event.shiftKey && !event.ctrlKey && !event.metaKey) {\n //有这些配合键，则不进行选中下一个单元格的行为执行vtable内部逻辑\n if (event.key === ExcelEditCellKeyboardResponse.ENTER) {\n this.table.selectCell(col, row + 1);\n } else if (event.key === ExcelEditCellKeyboardResponse.TAB) {\n this.table.selectCell(col + 1, row);\n } else if (event.key === ExcelEditCellKeyboardResponse.ARROW_LEFT) {\n this.table.selectCell(col - 1, row);\n } else if (event.key === ExcelEditCellKeyboardResponse.ARROW_RIGHT) {\n this.table.selectCell(col + 1, row);\n } else if (event.key === ExcelEditCellKeyboardResponse.ARROW_DOWN) {\n this.table.selectCell(col, row + 1);\n } else if (event.key === ExcelEditCellKeyboardResponse.ARROW_UP) {\n this.table.selectCell(col, row - 1);\n }\n // 阻止事件传播和默认行为\n event.stopPropagation();\n event.preventDefault();\n }\n } else {\n const { col, row } = this.table.stateManager.select.cellPos;\n if (\n this.table.editorManager.editingEditor &&\n (event.key === ExcelEditCellKeyboardResponse.ENTER \|\| event.key === ExcelEditCellKeyboardResponse.TAB)\n ) {\n this.table.editorManager.completeEdit();\n this.table.getElement().focus();\n if (event.key === ExcelEditCellKeyboardResponse.ENTER) {\n this.table.selectCell(col, row + 1);\n } else if (event.key === ExcelEditCellKeyboardResponse.TAB) {\n this.table.selectCell(col + 1, row);\n }\n // 阻止事件传播和默认行为\n event.stopPropagation();\n event.preventDefault();\n } else if (\n !this.table.editorManager.editingEditor &&\n (event.key === ExcelEditCellKeyboardResponse.DELETE \|\| event.key === ExcelEditCellKeyboardResponse.BACKSPACE)\n ) {\n //响应删除键，删除\n const selectCells = this.table.getSelectedCellInfos();\n if (selectCells?.length > 0) {\n // 如果选中的是范围，则删除范围内的所有单元格\n deleteSelectRange(selectCells, this.table);\n }\n // 阻止事件传播和默认行为\n event.stopPropagation();\n event.preventDefault();\n }\n }\n }\n }\n // 判断event的keyCode是否是excel的快捷键\n isExcelShortcutKey(event: KeyboardEvent) {\n return this.responseKeyboard.includes(event.key as ExcelEditCellKeyboardResponse);\n }\n setResponseKeyboard(responseKeyboard: ExcelEditCellKeyboardResponse[]) {\n this.responseKeyboard = responseKeyboard;\n }\n deleteResponseKeyboard(responseKeyboard: ExcelEditCellKeyboardResponse[]) {\n this.responseKeyboard = this.responseKeyboard.filter(key => !responseKeyboard.includes(key));\n }\n addResponseKeyboard(responseKeyboard: ExcelEditCellKeyboardResponse[]) {\n this.responseKeyboard = [...this.responseKeyboard, ...responseKeyboard];\n }\n release() {\n document.removeEventListener('keydown', this.handleKeyDown, true);\n }\n}\n//将选中单元格的值设置为空\nfunction deleteSelectRange(selectCells: TYPES.CellInfo[][], tableInstance: ListTable) {\n for (let i = 0; i < selectCells.length; i++) {\n for (let j = 0; j < selectCells[i].length; j++) {\n tableInstance.changeCellValue(selectCells[i][j].col, selectCells[i][j].row, '');\n }\n }\n}\n"]}

package/dist/vtable-plugins.js CHANGED Viewed

@@ -1063,15 +1063,37 @@
         return (a.start.col === b.start.col && a.start.row === b.start.row && a.end.col === b.end.col && a.end.row === b.end.row);
     }
+    exports.ExcelEditCellKeyboardResponse = void 0;
+    (function (ExcelEditCellKeyboardResponse) {
+        ExcelEditCellKeyboardResponse["ENTER"] = "enter";
+        ExcelEditCellKeyboardResponse["TAB"] = "tab";
+        ExcelEditCellKeyboardResponse["ARROW_LEFT"] = "arrowLeft";
+        ExcelEditCellKeyboardResponse["ARROW_RIGHT"] = "arrowRight";
+        ExcelEditCellKeyboardResponse["ARROW_DOWN"] = "arrowDown";
+        ExcelEditCellKeyboardResponse["ARROW_UP"] = "arrowUp";
+        ExcelEditCellKeyboardResponse["DELETE"] = "delete";
+        ExcelEditCellKeyboardResponse["BACKSPACE"] = "backspace";
+    })(exports.ExcelEditCellKeyboardResponse || (exports.ExcelEditCellKeyboardResponse = {}));
     class ExcelEditCellKeyboardPlugin {
         id = `excel-edit-cell-keyboard`;
         name = 'Excel Edit Cell Keyboard';
         runTime = [vtable.TABLE_EVENT_TYPE.INITIALIZED];
         table;
         pluginOptions;
+        responseKeyboard;
         constructor(pluginOptions) {
             this.id = pluginOptions?.id ?? this.id;
             this.pluginOptions = pluginOptions;
+            this.responseKeyboard = pluginOptions?.responseKeyboard ?? [
+                exports.ExcelEditCellKeyboardResponse.ENTER,
+                exports.ExcelEditCellKeyboardResponse.TAB,
+                exports.ExcelEditCellKeyboardResponse.ARROW_LEFT,
+                exports.ExcelEditCellKeyboardResponse.ARROW_RIGHT,
+                exports.ExcelEditCellKeyboardResponse.ARROW_DOWN,
+                exports.ExcelEditCellKeyboardResponse.ARROW_UP,
+                exports.ExcelEditCellKeyboardResponse.DELETE,
+                exports.ExcelEditCellKeyboardResponse.BACKSPACE
+            ];
             this.bindEvent();
         }
         run(...args) {
@@ -1082,51 +1104,51 @@
             document.addEventListener('keydown', this.handleKeyDown.bind(this), true);
         }
         handleKeyDown(event) {
-            if (this.table.editorManager) {
-                if (this.table.editorManager.beginTriggerEditCellMode === 'keydown') {
-                    if (this.table.editorManager.editingEditor && this.isExcelShortcutKey(event)) {
-                        const { col, row } = this.table.editorManager.editCell;
-                        this.table.editorManager.completeEdit();
-                        this.table.getElement().focus();
-                        if (!event.shiftKey && !event.ctrlKey && !event.metaKey) {
-                            if (event.key === 'Enter') {
-                                this.table.selectCell(col, row + 1);
-                            }
-                            else if (event.key === 'Tab') {
-                                this.table.selectCell(col + 1, row);
-                            }
-                            else if (event.key === 'ArrowLeft') {
-                                this.table.selectCell(col - 1, row);
-                            }
-                            else if (event.key === 'ArrowRight') {
-                                this.table.selectCell(col + 1, row);
-                            }
-                            else if (event.key === 'ArrowDown') {
-                                this.table.selectCell(col, row + 1);
-                            }
-                            else if (event.key === 'ArrowUp') {
-                                this.table.selectCell(col, row - 1);
-                            }
-                            event.stopPropagation();
-                            event.preventDefault();
+            if (this.table.editorManager && this.isExcelShortcutKey(event)) {
+                if (this.table.editorManager.editingEditor && this.table.editorManager.beginTriggerEditCellMode === 'keydown') {
+                    const { col, row } = this.table.editorManager.editCell;
+                    this.table.editorManager.completeEdit();
+                    this.table.getElement().focus();
+                    if (!event.shiftKey && !event.ctrlKey && !event.metaKey) {
+                        if (event.key === exports.ExcelEditCellKeyboardResponse.ENTER) {
+                            this.table.selectCell(col, row + 1);
+                        }
+                        else if (event.key === exports.ExcelEditCellKeyboardResponse.TAB) {
+                            this.table.selectCell(col + 1, row);
+                        }
+                        else if (event.key === exports.ExcelEditCellKeyboardResponse.ARROW_LEFT) {
+                            this.table.selectCell(col - 1, row);
+                        }
+                        else if (event.key === exports.ExcelEditCellKeyboardResponse.ARROW_RIGHT) {
+                            this.table.selectCell(col + 1, row);
+                        }
+                        else if (event.key === exports.ExcelEditCellKeyboardResponse.ARROW_DOWN) {
+                            this.table.selectCell(col, row + 1);
                         }
+                        else if (event.key === exports.ExcelEditCellKeyboardResponse.ARROW_UP) {
+                            this.table.selectCell(col, row - 1);
+                        }
+                        event.stopPropagation();
+                        event.preventDefault();
                     }
                 }
                 else {
                     const { col, row } = this.table.stateManager.select.cellPos;
-                    if (this.table.editorManager.editingEditor && (event.key === 'Enter' || event.key === 'Tab')) {
+                    if (this.table.editorManager.editingEditor &&
+                        (event.key === exports.ExcelEditCellKeyboardResponse.ENTER || event.key === exports.ExcelEditCellKeyboardResponse.TAB)) {
                         this.table.editorManager.completeEdit();
                         this.table.getElement().focus();
-                        if (event.key === 'Enter') {
+                        if (event.key === exports.ExcelEditCellKeyboardResponse.ENTER) {
                             this.table.selectCell(col, row + 1);
                         }
-                        else if (event.key === 'Tab') {
+                        else if (event.key === exports.ExcelEditCellKeyboardResponse.TAB) {
                             this.table.selectCell(col + 1, row);
                         }
                         event.stopPropagation();
                         event.preventDefault();
                     }
-                    else if (!this.table.editorManager.editingEditor && (event.key === 'Delete' || event.key === 'Backspace')) {
+                    else if (!this.table.editorManager.editingEditor &&
+                        (event.key === exports.ExcelEditCellKeyboardResponse.DELETE || event.key === exports.ExcelEditCellKeyboardResponse.BACKSPACE)) {
                         const selectCells = this.table.getSelectedCellInfos();
                         if (selectCells?.length > 0) {
                             deleteSelectRange(selectCells, this.table);
@@ -1138,12 +1160,16 @@
             }
         }
         isExcelShortcutKey(event) {
-            return (event.key === 'Enter' ||
-                event.key === 'Tab' ||
-                event.key === 'ArrowLeft' ||
-                event.key === 'ArrowRight' ||
-                event.key === 'ArrowDown' ||
-                event.key === 'ArrowUp');
+            return this.responseKeyboard.includes(event.key);
+        }
+        setResponseKeyboard(responseKeyboard) {
+            this.responseKeyboard = responseKeyboard;
+        }
+        deleteResponseKeyboard(responseKeyboard) {
+            this.responseKeyboard = this.responseKeyboard.filter(key => !responseKeyboard.includes(key));
+        }
+        addResponseKeyboard(responseKeyboard) {
+            this.responseKeyboard = [...this.responseKeyboard, ...responseKeyboard];
         }
         release() {
             document.removeEventListener('keydown', this.handleKeyDown, true);