roosterjs-content-model-plugins 9.45.0 → 9.45.2

package/lib/shortcut/ShortcutPlugin.d.ts

@@ -1,51 +1,51 @@
-import type { ShortcutCommand } from './ShortcutCommand';
-import type { EditorPlugin, IEditor, PluginEvent } from 'roosterjs-content-model-types';
-/**
- * Shortcut plugin hook on the specified shortcut keys and trigger related format API
- */
-export declare class ShortcutPlugin implements EditorPlugin {
-    private shortcuts;
-    private editor;
-    private isMac;
-    /**
-     * Create a new instance of ShortcutPlugin
-     * @param [shortcuts=defaultShortcuts] Allowed commands
-     */
-    constructor(shortcuts?: ShortcutCommand[]);
-    /**
-     * Get name of this plugin
-     */
-    getName(): string;
-    /**
-     * The first method that editor will call to a plugin when editor is initializing.
-     * It will pass in the editor instance, plugin should take this chance to save the
-     * editor reference so that it can call to any editor method or format API later.
-     * @param editor The editor object
-     */
-    initialize(editor: IEditor): void;
-    /**
-     * The last method that editor will call to a plugin before it is disposed.
-     * Plugin can take this chance to clear the reference to editor. After this method is
-     * called, plugin should not call to any editor method since it will result in error.
-     */
-    dispose(): void;
-    /**
-     * Check if the plugin should handle the given event exclusively.
-     * Handle an event exclusively means other plugin will not receive this event in
-     * onPluginEvent method.
-     * If two plugins will return true in willHandleEventExclusively() for the same event,
-     * the final result depends on the order of the plugins are added into editor
-     * @param event The event to check:
-     */
-    willHandleEventExclusively(event: PluginEvent): boolean;
-    /**
-     * Core method for a plugin. Once an event happens in editor, editor will call this
-     * method of each plugin to handle the event as long as the event is not handled
-     * exclusively by another plugin.
-     * @param event The event to handle:
-     */
-    onPluginEvent(event: PluginEvent): void;
-    private cacheGetCommand;
-    private matchOS;
-    private matchShortcut;
-}
+import type { ShortcutCommand } from './ShortcutCommand';
+import type { EditorPlugin, IEditor, PluginEvent } from 'roosterjs-content-model-types';
+/**
+ * Shortcut plugin hook on the specified shortcut keys and trigger related format API
+ */
+export declare class ShortcutPlugin implements EditorPlugin {
+    private shortcuts;
+    private editor;
+    private isMac;
+    /**
+     * Create a new instance of ShortcutPlugin
+     * @param [shortcuts=defaultShortcuts] Allowed commands
+     */
+    constructor(shortcuts?: ShortcutCommand[]);
+    /**
+     * Get name of this plugin
+     */
+    getName(): string;
+    /**
+     * The first method that editor will call to a plugin when editor is initializing.
+     * It will pass in the editor instance, plugin should take this chance to save the
+     * editor reference so that it can call to any editor method or format API later.
+     * @param editor The editor object
+     */
+    initialize(editor: IEditor): void;
+    /**
+     * The last method that editor will call to a plugin before it is disposed.
+     * Plugin can take this chance to clear the reference to editor. After this method is
+     * called, plugin should not call to any editor method since it will result in error.
+     */
+    dispose(): void;
+    /**
+     * Check if the plugin should handle the given event exclusively.
+     * Handle an event exclusively means other plugin will not receive this event in
+     * onPluginEvent method.
+     * If two plugins will return true in willHandleEventExclusively() for the same event,
+     * the final result depends on the order of the plugins are added into editor
+     * @param event The event to check:
+     */
+    willHandleEventExclusively(event: PluginEvent): boolean;
+    /**
+     * Core method for a plugin. Once an event happens in editor, editor will call this
+     * method of each plugin to handle the event as long as the event is not handled
+     * exclusively by another plugin.
+     * @param event The event to handle:
+     */
+    onPluginEvent(event: PluginEvent): void;
+    private cacheGetCommand;
+    private matchOS;
+    private matchShortcut;
+}

package/lib/shortcut/ShortcutPlugin.js

@@ -1,126 +1,126 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.ShortcutPlugin = void 0;
-var roosterjs_content_model_dom_1 = require("roosterjs-content-model-dom");
-var shortcuts_1 = require("./shortcuts");
-var defaultShortcuts = [
-    shortcuts_1.ShortcutBold,
-    shortcuts_1.ShortcutItalic,
-    shortcuts_1.ShortcutUnderline,
-    shortcuts_1.ShortcutClearFormat,
-    shortcuts_1.ShortcutUndo,
-    shortcuts_1.ShortcutUndo2,
-    shortcuts_1.ShortcutRedo,
-    shortcuts_1.ShortcutRedoAlt,
-    shortcuts_1.ShortcutRedoMacOS,
-    shortcuts_1.ShortcutBullet,
-    shortcuts_1.ShortcutNumbering,
-    shortcuts_1.ShortcutIncreaseFont,
-    shortcuts_1.ShortcutDecreaseFont,
-    shortcuts_1.ShortcutIndentList,
-    shortcuts_1.ShortcutOutdentList,
-];
-var CommandCacheKey = '__ShortcutCommandCache';
-/**
- * Shortcut plugin hook on the specified shortcut keys and trigger related format API
- */
-var ShortcutPlugin = /** @class */ (function () {
-    /**
-     * Create a new instance of ShortcutPlugin
-     * @param [shortcuts=defaultShortcuts] Allowed commands
-     */
-    function ShortcutPlugin(shortcuts) {
-        if (shortcuts === void 0) { shortcuts = defaultShortcuts; }
-        this.shortcuts = shortcuts;
-        this.editor = null;
-        this.isMac = false;
-    }
-    /**
-     * Get name of this plugin
-     */
-    ShortcutPlugin.prototype.getName = function () {
-        return 'Shortcut';
-    };
-    /**
-     * The first method that editor will call to a plugin when editor is initializing.
-     * It will pass in the editor instance, plugin should take this chance to save the
-     * editor reference so that it can call to any editor method or format API later.
-     * @param editor The editor object
-     */
-    ShortcutPlugin.prototype.initialize = function (editor) {
-        this.editor = editor;
-        this.isMac = !!this.editor.getEnvironment().isMac;
-    };
-    /**
-     * The last method that editor will call to a plugin before it is disposed.
-     * Plugin can take this chance to clear the reference to editor. After this method is
-     * called, plugin should not call to any editor method since it will result in error.
-     */
-    ShortcutPlugin.prototype.dispose = function () {
-        this.editor = null;
-    };
-    /**
-     * Check if the plugin should handle the given event exclusively.
-     * Handle an event exclusively means other plugin will not receive this event in
-     * onPluginEvent method.
-     * If two plugins will return true in willHandleEventExclusively() for the same event,
-     * the final result depends on the order of the plugins are added into editor
-     * @param event The event to check:
-     */
-    ShortcutPlugin.prototype.willHandleEventExclusively = function (event) {
-        return (event.eventType == 'keyDown' &&
-            (event.rawEvent.ctrlKey || event.rawEvent.altKey || event.rawEvent.metaKey) &&
-            !!this.cacheGetCommand(event));
-    };
-    /**
-     * Core method for a plugin. Once an event happens in editor, editor will call this
-     * method of each plugin to handle the event as long as the event is not handled
-     * exclusively by another plugin.
-     * @param event The event to handle:
-     */
-    ShortcutPlugin.prototype.onPluginEvent = function (event) {
-        if (this.editor && event.eventType == 'keyDown') {
-            var command = this.cacheGetCommand(event);
-            if (command) {
-                command.onClick(this.editor);
-                event.rawEvent.preventDefault();
-            }
-        }
-    };
-    ShortcutPlugin.prototype.cacheGetCommand = function (event) {
-        var _this = this;
-        return (0, roosterjs_content_model_dom_1.cacheGetEventData)(event, CommandCacheKey, function (event) {
-            var editor = _this.editor;
-            var _a = event.rawEvent, ctrlKey = _a.ctrlKey, metaKey = _a.metaKey;
-            if (ctrlKey && metaKey) {
-                // We don't support both Ctrl and Meta key pressed at the same time.
-                return null;
-            }
-            return (editor &&
-                _this.shortcuts.filter(function (command) {
-                    return _this.matchOS(command.environment) &&
-                        _this.matchShortcut(command.shortcutKey, event.rawEvent);
-                })[0]);
-        });
-    };
-    ShortcutPlugin.prototype.matchOS = function (environment) {
-        switch (environment) {
-            case 'mac':
-                return this.isMac;
-            case 'nonMac':
-                return !this.isMac;
-            default:
-                return true;
-        }
-    };
-    ShortcutPlugin.prototype.matchShortcut = function (shortcutKey, event) {
-        var ctrlKey = event.ctrlKey, altKey = event.altKey, shiftKey = event.shiftKey, which = event.which, metaKey = event.metaKey;
-        var ctrlOrMeta = this.isMac ? metaKey : ctrlKey;
-        var matchModifier = (shortcutKey.modifierKey == 'ctrl' && ctrlOrMeta && !altKey) ||
-            (shortcutKey.modifierKey == 'alt' && altKey && !ctrlOrMeta);
-        return matchModifier && shiftKey == shortcutKey.shiftKey && shortcutKey.which == which;
-    };
-    return ShortcutPlugin;
-}());
-exports.ShortcutPlugin = ShortcutPlugin;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.ShortcutPlugin = void 0;
+var roosterjs_content_model_dom_1 = require("roosterjs-content-model-dom");
+var shortcuts_1 = require("./shortcuts");
+var defaultShortcuts = [
+    shortcuts_1.ShortcutBold,
+    shortcuts_1.ShortcutItalic,
+    shortcuts_1.ShortcutUnderline,
+    shortcuts_1.ShortcutClearFormat,
+    shortcuts_1.ShortcutUndo,
+    shortcuts_1.ShortcutUndo2,
+    shortcuts_1.ShortcutRedo,
+    shortcuts_1.ShortcutRedoAlt,
+    shortcuts_1.ShortcutRedoMacOS,
+    shortcuts_1.ShortcutBullet,
+    shortcuts_1.ShortcutNumbering,
+    shortcuts_1.ShortcutIncreaseFont,
+    shortcuts_1.ShortcutDecreaseFont,
+    shortcuts_1.ShortcutIndentList,
+    shortcuts_1.ShortcutOutdentList,
+];
+var CommandCacheKey = '__ShortcutCommandCache';
+/**
+ * Shortcut plugin hook on the specified shortcut keys and trigger related format API
+ */
+var ShortcutPlugin = /** @class */ (function () {
+    /**
+     * Create a new instance of ShortcutPlugin
+     * @param [shortcuts=defaultShortcuts] Allowed commands
+     */
+    function ShortcutPlugin(shortcuts) {
+        if (shortcuts === void 0) { shortcuts = defaultShortcuts; }
+        this.shortcuts = shortcuts;
+        this.editor = null;
+        this.isMac = false;
+    }
+    /**
+     * Get name of this plugin
+     */
+    ShortcutPlugin.prototype.getName = function () {
+        return 'Shortcut';
+    };
+    /**
+     * The first method that editor will call to a plugin when editor is initializing.
+     * It will pass in the editor instance, plugin should take this chance to save the
+     * editor reference so that it can call to any editor method or format API later.
+     * @param editor The editor object
+     */
+    ShortcutPlugin.prototype.initialize = function (editor) {
+        this.editor = editor;
+        this.isMac = !!this.editor.getEnvironment().isMac;
+    };
+    /**
+     * The last method that editor will call to a plugin before it is disposed.
+     * Plugin can take this chance to clear the reference to editor. After this method is
+     * called, plugin should not call to any editor method since it will result in error.
+     */
+    ShortcutPlugin.prototype.dispose = function () {
+        this.editor = null;
+    };
+    /**
+     * Check if the plugin should handle the given event exclusively.
+     * Handle an event exclusively means other plugin will not receive this event in
+     * onPluginEvent method.
+     * If two plugins will return true in willHandleEventExclusively() for the same event,
+     * the final result depends on the order of the plugins are added into editor
+     * @param event The event to check:
+     */
+    ShortcutPlugin.prototype.willHandleEventExclusively = function (event) {
+        return (event.eventType == 'keyDown' &&
+            (event.rawEvent.ctrlKey || event.rawEvent.altKey || event.rawEvent.metaKey) &&
+            !!this.cacheGetCommand(event));
+    };
+    /**
+     * Core method for a plugin. Once an event happens in editor, editor will call this
+     * method of each plugin to handle the event as long as the event is not handled
+     * exclusively by another plugin.
+     * @param event The event to handle:
+     */
+    ShortcutPlugin.prototype.onPluginEvent = function (event) {
+        if (this.editor && event.eventType == 'keyDown') {
+            var command = this.cacheGetCommand(event);
+            if (command) {
+                command.onClick(this.editor);
+                event.rawEvent.preventDefault();
+            }
+        }
+    };
+    ShortcutPlugin.prototype.cacheGetCommand = function (event) {
+        var _this = this;
+        return (0, roosterjs_content_model_dom_1.cacheGetEventData)(event, CommandCacheKey, function (event) {
+            var editor = _this.editor;
+            var _a = event.rawEvent, ctrlKey = _a.ctrlKey, metaKey = _a.metaKey;
+            if (ctrlKey && metaKey) {
+                // We don't support both Ctrl and Meta key pressed at the same time.
+                return null;
+            }
+            return (editor &&
+                _this.shortcuts.filter(function (command) {
+                    return _this.matchOS(command.environment) &&
+                        _this.matchShortcut(command.shortcutKey, event.rawEvent);
+                })[0]);
+        });
+    };
+    ShortcutPlugin.prototype.matchOS = function (environment) {
+        switch (environment) {
+            case 'mac':
+                return this.isMac;
+            case 'nonMac':
+                return !this.isMac;
+            default:
+                return true;
+        }
+    };
+    ShortcutPlugin.prototype.matchShortcut = function (shortcutKey, event) {
+        var ctrlKey = event.ctrlKey, altKey = event.altKey, shiftKey = event.shiftKey, which = event.which, metaKey = event.metaKey;
+        var ctrlOrMeta = this.isMac ? metaKey : ctrlKey;
+        var matchModifier = (shortcutKey.modifierKey == 'ctrl' && ctrlOrMeta && !altKey) ||
+            (shortcutKey.modifierKey == 'alt' && altKey && !ctrlOrMeta);
+        return matchModifier && shiftKey == shortcutKey.shiftKey && shortcutKey.which == which;
+    };
+    return ShortcutPlugin;
+}());
+exports.ShortcutPlugin = ShortcutPlugin;
 //# sourceMappingURL=ShortcutPlugin.js.map

package/lib/shortcut/ShortcutPlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"ShortcutPlugin.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-plugins/lib/shortcut/ShortcutPlugin.ts"],"names":[],"mappings":";;;AAAA,2EAAgE;AAEhE,yCAgBqB;AAQrB,IAAM,gBAAgB,GAAsB;IACxC,wBAAY;IACZ,0BAAc;IACd,6BAAiB;IACjB,+BAAmB;IACnB,wBAAY;IACZ,yBAAa;IACb,wBAAY;IACZ,2BAAe;IACf,6BAAiB;IACjB,0BAAc;IACd,6BAAiB;IACjB,gCAAoB;IACpB,gCAAoB;IACpB,8BAAkB;IAClB,+BAAmB;CACtB,CAAC;AACF,IAAM,eAAe,GAAG,wBAAwB,CAAC;AAEjD;;GAEG;AACH;IAII;;;OAGG;IACH,wBAAoB,SAA+C;QAA/C,0BAAA,EAAA,4BAA+C;QAA/C,cAAS,GAAT,SAAS,CAAsC;QAP3D,WAAM,GAAmB,IAAI,CAAC;QAC9B,UAAK,GAAG,KAAK,CAAC;IAMgD,CAAC;IAEvE;;OAEG;IACH,gCAAO,GAAP;QACI,OAAO,UAAU,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,mCAAU,GAAV,UAAW,MAAe;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,KAAK,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACH,gCAAO,GAAP;QACI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACH,mDAA0B,GAA1B,UAA2B,KAAkB;QACzC,OAAO,CACH,KAAK,CAAC,SAAS,IAAI,SAAS;YAC5B,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC;YAC3E,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAChC,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,sCAAa,GAAb,UAAc,KAAkB;QAC5B,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,SAAS,EAAE;YAC7C,IAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YAE5C,IAAI,OAAO,EAAE;gBACT,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC7B,KAAK,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;aACnC;SACJ;IACL,CAAC;IAEO,wCAAe,GAAvB,UAAwB,KAAmB;QAA3C,iBAiBC;QAhBG,OAAO,IAAA,+CAAiB,EAAC,KAAK,EAAE,eAAe,EAAE,UAAA,KAAK;YAClD,IAAM,MAAM,GAAG,KAAI,CAAC,MAAM,CAAC;YACrB,IAAA,KAAuB,KAAK,CAAC,QAAQ,EAAnC,OAAO,aAAA,EAAE,OAAO,aAAmB,CAAC;YAC5C,IAAI,OAAO,IAAI,OAAO,EAAE;gBACpB,oEAAoE;gBACpE,OAAO,IAAI,CAAC;aACf;YACD,OAAO,CACH,MAAM;gBACN,KAAI,CAAC,SAAS,CAAC,MAAM,CACjB,UAAA,OAAO;oBACH,OAAA,KAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;wBACjC,KAAI,CAAC,aAAa,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,QAAQ,CAAC;gBADvD,CACuD,CAC9D,CAAC,CAAC,CAAC,CACP,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,gCAAO,GAAf,UAAgB,WAAsC;QAClD,QAAQ,WAAW,EAAE;YACjB,KAAK,KAAK;gBACN,OAAO,IAAI,CAAC,KAAK,CAAC;YAEtB,KAAK,QAAQ;gBACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;YAEvB;gBACI,OAAO,IAAI,CAAC;SACnB;IACL,CAAC;IAEO,sCAAa,GAArB,UAAsB,WAAkC,EAAE,KAAoB;QAClE,IAAA,OAAO,GAAuC,KAAK,QAA5C,EAAE,MAAM,GAA+B,KAAK,OAApC,EAAE,QAAQ,GAAqB,KAAK,SAA1B,EAAE,KAAK,GAAc,KAAK,MAAnB,EAAE,OAAO,GAAK,KAAK,QAAV,CAAW;QAC5D,IAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;QAClD,IAAM,aAAa,GACf,CAAC,WAAW,CAAC,WAAW,IAAI,MAAM,IAAI,UAAU,IAAI,CAAC,MAAM,CAAC;YAC5D,CAAC,WAAW,CAAC,WAAW,IAAI,KAAK,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;QAEhE,OAAO,aAAa,IAAI,QAAQ,IAAI,WAAW,CAAC,QAAQ,IAAI,WAAW,CAAC,KAAK,IAAI,KAAK,CAAC;IAC3F,CAAC;IACL,qBAAC;AAAD,CAAC,AA/GD,IA+GC;AA/GY,wCAAc","sourcesContent":["import { cacheGetEventData } from 'roosterjs-content-model-dom';\r\nimport type { ShortcutCommand, ShortcutKeyDefinition } from './ShortcutCommand';\r\nimport {\r\n    ShortcutBold,\r\n    ShortcutBullet,\r\n    ShortcutClearFormat,\r\n    ShortcutDecreaseFont,\r\n    ShortcutIncreaseFont,\r\n    ShortcutIndentList,\r\n    ShortcutItalic,\r\n    ShortcutNumbering,\r\n    ShortcutOutdentList,\r\n    ShortcutRedo,\r\n    ShortcutRedoAlt,\r\n    ShortcutRedoMacOS,\r\n    ShortcutUnderline,\r\n    ShortcutUndo,\r\n    ShortcutUndo2,\r\n} from './shortcuts';\r\nimport type {\r\n    EditorPlugin,\r\n    IEditor,\r\n    KeyDownEvent,\r\n    PluginEvent,\r\n} from 'roosterjs-content-model-types';\r\n\r\nconst defaultShortcuts: ShortcutCommand[] = [\r\n    ShortcutBold,\r\n    ShortcutItalic,\r\n    ShortcutUnderline,\r\n    ShortcutClearFormat,\r\n    ShortcutUndo,\r\n    ShortcutUndo2,\r\n    ShortcutRedo,\r\n    ShortcutRedoAlt,\r\n    ShortcutRedoMacOS,\r\n    ShortcutBullet,\r\n    ShortcutNumbering,\r\n    ShortcutIncreaseFont,\r\n    ShortcutDecreaseFont,\r\n    ShortcutIndentList,\r\n    ShortcutOutdentList,\r\n];\r\nconst CommandCacheKey = '__ShortcutCommandCache';\r\n\r\n/**\r\n * Shortcut plugin hook on the specified shortcut keys and trigger related format API\r\n */\r\nexport class ShortcutPlugin implements EditorPlugin {\r\n    private editor: IEditor | null = null;\r\n    private isMac = false;\r\n\r\n    /**\r\n     * Create a new instance of ShortcutPlugin\r\n     * @param [shortcuts=defaultShortcuts] Allowed commands\r\n     */\r\n    constructor(private shortcuts: ShortcutCommand[] = defaultShortcuts) {}\r\n\r\n    /**\r\n     * Get name of this plugin\r\n     */\r\n    getName() {\r\n        return 'Shortcut';\r\n    }\r\n\r\n    /**\r\n     * The first method that editor will call to a plugin when editor is initializing.\r\n     * It will pass in the editor instance, plugin should take this chance to save the\r\n     * editor reference so that it can call to any editor method or format API later.\r\n     * @param editor The editor object\r\n     */\r\n    initialize(editor: IEditor) {\r\n        this.editor = editor;\r\n        this.isMac = !!this.editor.getEnvironment().isMac;\r\n    }\r\n\r\n    /**\r\n     * The last method that editor will call to a plugin before it is disposed.\r\n     * Plugin can take this chance to clear the reference to editor. After this method is\r\n     * called, plugin should not call to any editor method since it will result in error.\r\n     */\r\n    dispose() {\r\n        this.editor = null;\r\n    }\r\n\r\n    /**\r\n     * Check if the plugin should handle the given event exclusively.\r\n     * Handle an event exclusively means other plugin will not receive this event in\r\n     * onPluginEvent method.\r\n     * If two plugins will return true in willHandleEventExclusively() for the same event,\r\n     * the final result depends on the order of the plugins are added into editor\r\n     * @param event The event to check:\r\n     */\r\n    willHandleEventExclusively(event: PluginEvent) {\r\n        return (\r\n            event.eventType == 'keyDown' &&\r\n            (event.rawEvent.ctrlKey || event.rawEvent.altKey || event.rawEvent.metaKey) &&\r\n            !!this.cacheGetCommand(event)\r\n        );\r\n    }\r\n\r\n    /**\r\n     * Core method for a plugin. Once an event happens in editor, editor will call this\r\n     * method of each plugin to handle the event as long as the event is not handled\r\n     * exclusively by another plugin.\r\n     * @param event The event to handle:\r\n     */\r\n    onPluginEvent(event: PluginEvent) {\r\n        if (this.editor && event.eventType == 'keyDown') {\r\n            const command = this.cacheGetCommand(event);\r\n\r\n            if (command) {\r\n                command.onClick(this.editor);\r\n                event.rawEvent.preventDefault();\r\n            }\r\n        }\r\n    }\r\n\r\n    private cacheGetCommand(event: KeyDownEvent) {\r\n        return cacheGetEventData(event, CommandCacheKey, event => {\r\n            const editor = this.editor;\r\n            const { ctrlKey, metaKey } = event.rawEvent;\r\n            if (ctrlKey && metaKey) {\r\n                // We don't support both Ctrl and Meta key pressed at the same time.\r\n                return null;\r\n            }\r\n            return (\r\n                editor &&\r\n                this.shortcuts.filter(\r\n                    command =>\r\n                        this.matchOS(command.environment) &&\r\n                        this.matchShortcut(command.shortcutKey, event.rawEvent)\r\n                )[0]\r\n            );\r\n        });\r\n    }\r\n\r\n    private matchOS(environment?: 'all' | 'mac' | 'nonMac') {\r\n        switch (environment) {\r\n            case 'mac':\r\n                return this.isMac;\r\n\r\n            case 'nonMac':\r\n                return !this.isMac;\r\n\r\n            default:\r\n                return true;\r\n        }\r\n    }\r\n\r\n    private matchShortcut(shortcutKey: ShortcutKeyDefinition, event: KeyboardEvent) {\r\n        const { ctrlKey, altKey, shiftKey, which, metaKey } = event;\r\n        const ctrlOrMeta = this.isMac ? metaKey : ctrlKey;\r\n        const matchModifier =\r\n            (shortcutKey.modifierKey == 'ctrl' && ctrlOrMeta && !altKey) ||\r\n            (shortcutKey.modifierKey == 'alt' && altKey && !ctrlOrMeta);\r\n\r\n        return matchModifier && shiftKey == shortcutKey.shiftKey && shortcutKey.which == which;\r\n    }\r\n}\r\n"]}
+{"version":3,"file":"ShortcutPlugin.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-plugins/lib/shortcut/ShortcutPlugin.ts"],"names":[],"mappings":";;;AAAA,2EAAgE;AAEhE,yCAgBqB;AAQrB,IAAM,gBAAgB,GAAsB;IACxC,wBAAY;IACZ,0BAAc;IACd,6BAAiB;IACjB,+BAAmB;IACnB,wBAAY;IACZ,yBAAa;IACb,wBAAY;IACZ,2BAAe;IACf,6BAAiB;IACjB,0BAAc;IACd,6BAAiB;IACjB,gCAAoB;IACpB,gCAAoB;IACpB,8BAAkB;IAClB,+BAAmB;CACtB,CAAC;AACF,IAAM,eAAe,GAAG,wBAAwB,CAAC;AAEjD;;GAEG;AACH;IAII;;;OAGG;IACH,wBAAoB,SAA+C;QAA/C,0BAAA,EAAA,4BAA+C;QAA/C,cAAS,GAAT,SAAS,CAAsC;QAP3D,WAAM,GAAmB,IAAI,CAAC;QAC9B,UAAK,GAAG,KAAK,CAAC;IAMgD,CAAC;IAEvE;;OAEG;IACH,gCAAO,GAAP;QACI,OAAO,UAAU,CAAC;IACtB,CAAC;IAED;;;;;OAKG;IACH,mCAAU,GAAV,UAAW,MAAe;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,KAAK,GAAG,CAAC,CAAC,IAAI,CAAC,MAAM,CAAC,cAAc,EAAE,CAAC,KAAK,CAAC;IACtD,CAAC;IAED;;;;OAIG;IACH,gCAAO,GAAP;QACI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACvB,CAAC;IAED;;;;;;;OAOG;IACH,mDAA0B,GAA1B,UAA2B,KAAkB;QACzC,OAAO,CACH,KAAK,CAAC,SAAS,IAAI,SAAS;YAC5B,CAAC,KAAK,CAAC,QAAQ,CAAC,OAAO,IAAI,KAAK,CAAC,QAAQ,CAAC,MAAM,IAAI,KAAK,CAAC,QAAQ,CAAC,OAAO,CAAC;YAC3E,CAAC,CAAC,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAChC,CAAC;IACN,CAAC;IAED;;;;;OAKG;IACH,sCAAa,GAAb,UAAc,KAAkB;QAC5B,IAAI,IAAI,CAAC,MAAM,IAAI,KAAK,CAAC,SAAS,IAAI,SAAS,EAAE;YAC7C,IAAM,OAAO,GAAG,IAAI,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC;YAE5C,IAAI,OAAO,EAAE;gBACT,OAAO,CAAC,OAAO,CAAC,IAAI,CAAC,MAAM,CAAC,CAAC;gBAC7B,KAAK,CAAC,QAAQ,CAAC,cAAc,EAAE,CAAC;aACnC;SACJ;IACL,CAAC;IAEO,wCAAe,GAAvB,UAAwB,KAAmB;QAA3C,iBAiBC;QAhBG,OAAO,IAAA,+CAAiB,EAAC,KAAK,EAAE,eAAe,EAAE,UAAA,KAAK;YAClD,IAAM,MAAM,GAAG,KAAI,CAAC,MAAM,CAAC;YACrB,IAAA,KAAuB,KAAK,CAAC,QAAQ,EAAnC,OAAO,aAAA,EAAE,OAAO,aAAmB,CAAC;YAC5C,IAAI,OAAO,IAAI,OAAO,EAAE;gBACpB,oEAAoE;gBACpE,OAAO,IAAI,CAAC;aACf;YACD,OAAO,CACH,MAAM;gBACN,KAAI,CAAC,SAAS,CAAC,MAAM,CACjB,UAAA,OAAO;oBACH,OAAA,KAAI,CAAC,OAAO,CAAC,OAAO,CAAC,WAAW,CAAC;wBACjC,KAAI,CAAC,aAAa,CAAC,OAAO,CAAC,WAAW,EAAE,KAAK,CAAC,QAAQ,CAAC;gBADvD,CACuD,CAC9D,CAAC,CAAC,CAAC,CACP,CAAC;QACN,CAAC,CAAC,CAAC;IACP,CAAC;IAEO,gCAAO,GAAf,UAAgB,WAAsC;QAClD,QAAQ,WAAW,EAAE;YACjB,KAAK,KAAK;gBACN,OAAO,IAAI,CAAC,KAAK,CAAC;YAEtB,KAAK,QAAQ;gBACT,OAAO,CAAC,IAAI,CAAC,KAAK,CAAC;YAEvB;gBACI,OAAO,IAAI,CAAC;SACnB;IACL,CAAC;IAEO,sCAAa,GAArB,UAAsB,WAAkC,EAAE,KAAoB;QAClE,IAAA,OAAO,GAAuC,KAAK,QAA5C,EAAE,MAAM,GAA+B,KAAK,OAApC,EAAE,QAAQ,GAAqB,KAAK,SAA1B,EAAE,KAAK,GAAc,KAAK,MAAnB,EAAE,OAAO,GAAK,KAAK,QAAV,CAAW;QAC5D,IAAM,UAAU,GAAG,IAAI,CAAC,KAAK,CAAC,CAAC,CAAC,OAAO,CAAC,CAAC,CAAC,OAAO,CAAC;QAClD,IAAM,aAAa,GACf,CAAC,WAAW,CAAC,WAAW,IAAI,MAAM,IAAI,UAAU,IAAI,CAAC,MAAM,CAAC;YAC5D,CAAC,WAAW,CAAC,WAAW,IAAI,KAAK,IAAI,MAAM,IAAI,CAAC,UAAU,CAAC,CAAC;QAEhE,OAAO,aAAa,IAAI,QAAQ,IAAI,WAAW,CAAC,QAAQ,IAAI,WAAW,CAAC,KAAK,IAAI,KAAK,CAAC;IAC3F,CAAC;IACL,qBAAC;AAAD,CAAC,AA/GD,IA+GC;AA/GY,wCAAc","sourcesContent":["import { cacheGetEventData } from 'roosterjs-content-model-dom';\nimport type { ShortcutCommand, ShortcutKeyDefinition } from './ShortcutCommand';\nimport {\n    ShortcutBold,\n    ShortcutBullet,\n    ShortcutClearFormat,\n    ShortcutDecreaseFont,\n    ShortcutIncreaseFont,\n    ShortcutIndentList,\n    ShortcutItalic,\n    ShortcutNumbering,\n    ShortcutOutdentList,\n    ShortcutRedo,\n    ShortcutRedoAlt,\n    ShortcutRedoMacOS,\n    ShortcutUnderline,\n    ShortcutUndo,\n    ShortcutUndo2,\n} from './shortcuts';\nimport type {\n    EditorPlugin,\n    IEditor,\n    KeyDownEvent,\n    PluginEvent,\n} from 'roosterjs-content-model-types';\n\nconst defaultShortcuts: ShortcutCommand[] = [\n    ShortcutBold,\n    ShortcutItalic,\n    ShortcutUnderline,\n    ShortcutClearFormat,\n    ShortcutUndo,\n    ShortcutUndo2,\n    ShortcutRedo,\n    ShortcutRedoAlt,\n    ShortcutRedoMacOS,\n    ShortcutBullet,\n    ShortcutNumbering,\n    ShortcutIncreaseFont,\n    ShortcutDecreaseFont,\n    ShortcutIndentList,\n    ShortcutOutdentList,\n];\nconst CommandCacheKey = '__ShortcutCommandCache';\n\n/**\n * Shortcut plugin hook on the specified shortcut keys and trigger related format API\n */\nexport class ShortcutPlugin implements EditorPlugin {\n    private editor: IEditor | null = null;\n    private isMac = false;\n\n    /**\n     * Create a new instance of ShortcutPlugin\n     * @param [shortcuts=defaultShortcuts] Allowed commands\n     */\n    constructor(private shortcuts: ShortcutCommand[] = defaultShortcuts) {}\n\n    /**\n     * Get name of this plugin\n     */\n    getName() {\n        return 'Shortcut';\n    }\n\n    /**\n     * The first method that editor will call to a plugin when editor is initializing.\n     * It will pass in the editor instance, plugin should take this chance to save the\n     * editor reference so that it can call to any editor method or format API later.\n     * @param editor The editor object\n     */\n    initialize(editor: IEditor) {\n        this.editor = editor;\n        this.isMac = !!this.editor.getEnvironment().isMac;\n    }\n\n    /**\n     * The last method that editor will call to a plugin before it is disposed.\n     * Plugin can take this chance to clear the reference to editor. After this method is\n     * called, plugin should not call to any editor method since it will result in error.\n     */\n    dispose() {\n        this.editor = null;\n    }\n\n    /**\n     * Check if the plugin should handle the given event exclusively.\n     * Handle an event exclusively means other plugin will not receive this event in\n     * onPluginEvent method.\n     * If two plugins will return true in willHandleEventExclusively() for the same event,\n     * the final result depends on the order of the plugins are added into editor\n     * @param event The event to check:\n     */\n    willHandleEventExclusively(event: PluginEvent) {\n        return (\n            event.eventType == 'keyDown' &&\n            (event.rawEvent.ctrlKey || event.rawEvent.altKey || event.rawEvent.metaKey) &&\n            !!this.cacheGetCommand(event)\n        );\n    }\n\n    /**\n     * Core method for a plugin. Once an event happens in editor, editor will call this\n     * method of each plugin to handle the event as long as the event is not handled\n     * exclusively by another plugin.\n     * @param event The event to handle:\n     */\n    onPluginEvent(event: PluginEvent) {\n        if (this.editor && event.eventType == 'keyDown') {\n            const command = this.cacheGetCommand(event);\n\n            if (command) {\n                command.onClick(this.editor);\n                event.rawEvent.preventDefault();\n            }\n        }\n    }\n\n    private cacheGetCommand(event: KeyDownEvent) {\n        return cacheGetEventData(event, CommandCacheKey, event => {\n            const editor = this.editor;\n            const { ctrlKey, metaKey } = event.rawEvent;\n            if (ctrlKey && metaKey) {\n                // We don't support both Ctrl and Meta key pressed at the same time.\n                return null;\n            }\n            return (\n                editor &&\n                this.shortcuts.filter(\n                    command =>\n                        this.matchOS(command.environment) &&\n                        this.matchShortcut(command.shortcutKey, event.rawEvent)\n                )[0]\n            );\n        });\n    }\n\n    private matchOS(environment?: 'all' | 'mac' | 'nonMac') {\n        switch (environment) {\n            case 'mac':\n                return this.isMac;\n\n            case 'nonMac':\n                return !this.isMac;\n\n            default:\n                return true;\n        }\n    }\n\n    private matchShortcut(shortcutKey: ShortcutKeyDefinition, event: KeyboardEvent) {\n        const { ctrlKey, altKey, shiftKey, which, metaKey } = event;\n        const ctrlOrMeta = this.isMac ? metaKey : ctrlKey;\n        const matchModifier =\n            (shortcutKey.modifierKey == 'ctrl' && ctrlOrMeta && !altKey) ||\n            (shortcutKey.modifierKey == 'alt' && altKey && !ctrlOrMeta);\n\n        return matchModifier && shiftKey == shortcutKey.shiftKey && shortcutKey.which == which;\n    }\n}\n"]}

package/lib/shortcut/shortcuts.d.ts

@@ -1,92 +1,92 @@
-import type { ShortcutCommand } from './ShortcutCommand';
-/**
- * Shortcut command for Bold
- * Windows: Ctrl + B
- * MacOS: Meta + B
- */
-export declare const ShortcutBold: ShortcutCommand;
-/**
- * Shortcut command for Italic
- * Windows: Ctrl + I
- * MacOS: Meta + I
- */
-export declare const ShortcutItalic: ShortcutCommand;
-/**
- * Shortcut command for Underline
- * Windows: Ctrl + U
- * MacOS: Meta + U
- */
-export declare const ShortcutUnderline: ShortcutCommand;
-/**
- * Shortcut command for Clear Format
- * Windows: Ctrl + Space
- * MacOS: Meta + Space, this shortcut is the same as the default global spotlight shortcut, so it is invalid if the user keeps spotlight‘s.
- */
-export declare const ShortcutClearFormat: ShortcutCommand;
-/**
- * Shortcut command for Undo 1
- * Windows: Ctrl + Z
- * MacOS: Meta + Z
- */
-export declare const ShortcutUndo: ShortcutCommand;
-/**
- * Shortcut command for Undo 2
- * Windows: Alt + Backspace
- * MacOS: N/A
- */
-export declare const ShortcutUndo2: ShortcutCommand;
-/**
- * Shortcut command for Redo 1
- * Windows: Ctrl + Y
- * MacOS: N/A
- */
-export declare const ShortcutRedo: ShortcutCommand;
-/**
- * @deprecated
- * Shortcut command for Redo 2
- * Windows: N/A
- * MacOS: Meta + Shift + Z
- */
-export declare const ShortcutRedoMacOS: ShortcutCommand;
-/**
- * Shortcut command for Redo 3
- * Windows: Ctrl + Shift + Z
- * MacOS: Meta + Shift + Z
- */
-export declare const ShortcutRedoAlt: ShortcutCommand;
-/**
- * Shortcut command for Bullet List
- * Windows: Ctrl + . (Period)
- * MacOS: Meta + . (Period)
- */
-export declare const ShortcutBullet: ShortcutCommand;
-/**
- * Shortcut command for Numbering List
- * Windows: Ctrl + / (Forward slash)
- * MacOS: Meta + / (Forward slash)
- */
-export declare const ShortcutNumbering: ShortcutCommand;
-/**
- * Shortcut command for Increase Font
- * Windows: Ctrl + Shift + . (Period)
- * MacOS: Meta + Shift + . (Period)
- */
-export declare const ShortcutIncreaseFont: ShortcutCommand;
-/**
- * Shortcut command for Decrease Font
- * Windows: Ctrl + Shift + , (Comma)
- * MacOS: Meta + Shift + , (Comma)
- */
-export declare const ShortcutDecreaseFont: ShortcutCommand;
-/**
- * Shortcut command for Intent list
- * Windows: Alt + Shift + Arrow Right
- * MacOS: N/A
- */
-export declare const ShortcutIndentList: ShortcutCommand;
-/**
- * Shortcut command for Outdent list
- * Windows: Alt + Shift + Arrow Left
- * MacOS: N/A
- */
-export declare const ShortcutOutdentList: ShortcutCommand;
+import type { ShortcutCommand } from './ShortcutCommand';
+/**
+ * Shortcut command for Bold
+ * Windows: Ctrl + B
+ * MacOS: Meta + B
+ */
+export declare const ShortcutBold: ShortcutCommand;
+/**
+ * Shortcut command for Italic
+ * Windows: Ctrl + I
+ * MacOS: Meta + I
+ */
+export declare const ShortcutItalic: ShortcutCommand;
+/**
+ * Shortcut command for Underline
+ * Windows: Ctrl + U
+ * MacOS: Meta + U
+ */
+export declare const ShortcutUnderline: ShortcutCommand;
+/**
+ * Shortcut command for Clear Format
+ * Windows: Ctrl + Space
+ * MacOS: Meta + Space, this shortcut is the same as the default global spotlight shortcut, so it is invalid if the user keeps spotlight‘s.
+ */
+export declare const ShortcutClearFormat: ShortcutCommand;
+/**
+ * Shortcut command for Undo 1
+ * Windows: Ctrl + Z
+ * MacOS: Meta + Z
+ */
+export declare const ShortcutUndo: ShortcutCommand;
+/**
+ * Shortcut command for Undo 2
+ * Windows: Alt + Backspace
+ * MacOS: N/A
+ */
+export declare const ShortcutUndo2: ShortcutCommand;
+/**
+ * Shortcut command for Redo 1
+ * Windows: Ctrl + Y
+ * MacOS: N/A
+ */
+export declare const ShortcutRedo: ShortcutCommand;
+/**
+ * @deprecated
+ * Shortcut command for Redo 2
+ * Windows: N/A
+ * MacOS: Meta + Shift + Z
+ */
+export declare const ShortcutRedoMacOS: ShortcutCommand;
+/**
+ * Shortcut command for Redo 3
+ * Windows: Ctrl + Shift + Z
+ * MacOS: Meta + Shift + Z
+ */
+export declare const ShortcutRedoAlt: ShortcutCommand;
+/**
+ * Shortcut command for Bullet List
+ * Windows: Ctrl + . (Period)
+ * MacOS: Meta + . (Period)
+ */
+export declare const ShortcutBullet: ShortcutCommand;
+/**
+ * Shortcut command for Numbering List
+ * Windows: Ctrl + / (Forward slash)
+ * MacOS: Meta + / (Forward slash)
+ */
+export declare const ShortcutNumbering: ShortcutCommand;
+/**
+ * Shortcut command for Increase Font
+ * Windows: Ctrl + Shift + . (Period)
+ * MacOS: Meta + Shift + . (Period)
+ */
+export declare const ShortcutIncreaseFont: ShortcutCommand;
+/**
+ * Shortcut command for Decrease Font
+ * Windows: Ctrl + Shift + , (Comma)
+ * MacOS: Meta + Shift + , (Comma)
+ */
+export declare const ShortcutDecreaseFont: ShortcutCommand;
+/**
+ * Shortcut command for Intent list
+ * Windows: Alt + Shift + Arrow Right
+ * MacOS: N/A
+ */
+export declare const ShortcutIndentList: ShortcutCommand;
+/**
+ * Shortcut command for Outdent list
+ * Windows: Alt + Shift + Arrow Left
+ * MacOS: N/A
+ */
+export declare const ShortcutOutdentList: ShortcutCommand;