roosterjs-content-model-plugins 9.45.0 → 9.45.1

package/lib/customReplace/CustomReplacePlugin.js

@@ -1,87 +1,87 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
-exports.CustomReplacePlugin = void 0;
-var roosterjs_content_model_api_1 = require("roosterjs-content-model-api");
-/**
- * CustomReplacePlugin is a plugin that allows you to replace a string with another string in the editor.
- */
-var CustomReplacePlugin = /** @class */ (function () {
-    /**
-     * @param customReplacements Custom replacement rules.
-     * Ex: [{ stringToReplace: ':)', replacementString: '🙂', replacementHandler: replaceEmojis }]
-     */
-    function CustomReplacePlugin(customReplacements) {
-        this.customReplacements = customReplacements;
-        this.editor = null;
-        this.triggerKeys = [];
-    }
-    /**
-     * Get name of this plugin
-     */
-    CustomReplacePlugin.prototype.getName = function () {
-        return 'CustomReplace';
-    };
-    /**
-     * 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
-     */
-    CustomReplacePlugin.prototype.initialize = function (editor) {
-        this.editor = editor;
-        this.triggerKeys = this.customReplacements.map(function (replacement) {
-            return replacement.stringToReplace.slice(-1);
-        });
-    };
-    /**
-     * 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.
-     */
-    CustomReplacePlugin.prototype.dispose = function () {
-        this.editor = null;
-    };
-    /**
-     * 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:
-     */
-    CustomReplacePlugin.prototype.onPluginEvent = function (event) {
-        if (this.editor) {
-            switch (event.eventType) {
-                case 'input':
-                    this.handleEditorInputEvent(this.editor, event);
-                    break;
-            }
-        }
-    };
-    CustomReplacePlugin.prototype.handleEditorInputEvent = function (editor, event) {
-        var _this = this;
-        var rawEvent = event.rawEvent;
-        var selection = editor.getDOMSelection();
-        var key = rawEvent.data;
-        if (this.customReplacements.length > 0 &&
-            rawEvent.inputType === 'insertText' &&
-            selection &&
-            selection.type === 'range' &&
-            selection.range.collapsed &&
-            key &&
-            this.triggerKeys.indexOf(key) > -1) {
-            (0, roosterjs_content_model_api_1.formatTextSegmentBeforeSelectionMarker)(editor, function (_model, previousSegment, paragraph, _markerFormat, context) {
-                var replaced = _this.customReplacements.some(function (_a) {
-                    var stringToReplace = _a.stringToReplace, replacementString = _a.replacementString, replacementHandler = _a.replacementHandler;
-                    return replacementHandler(previousSegment, stringToReplace, replacementString, paragraph);
-                });
-                if (replaced) {
-                    context.canUndoByBackspace = true;
-                    return true;
-                }
-                return false;
-            });
-        }
-    };
-    return CustomReplacePlugin;
-}());
-exports.CustomReplacePlugin = CustomReplacePlugin;
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.CustomReplacePlugin = void 0;
+var roosterjs_content_model_api_1 = require("roosterjs-content-model-api");
+/**
+ * CustomReplacePlugin is a plugin that allows you to replace a string with another string in the editor.
+ */
+var CustomReplacePlugin = /** @class */ (function () {
+    /**
+     * @param customReplacements Custom replacement rules.
+     * Ex: [{ stringToReplace: ':)', replacementString: '🙂', replacementHandler: replaceEmojis }]
+     */
+    function CustomReplacePlugin(customReplacements) {
+        this.customReplacements = customReplacements;
+        this.editor = null;
+        this.triggerKeys = [];
+    }
+    /**
+     * Get name of this plugin
+     */
+    CustomReplacePlugin.prototype.getName = function () {
+        return 'CustomReplace';
+    };
+    /**
+     * 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
+     */
+    CustomReplacePlugin.prototype.initialize = function (editor) {
+        this.editor = editor;
+        this.triggerKeys = this.customReplacements.map(function (replacement) {
+            return replacement.stringToReplace.slice(-1);
+        });
+    };
+    /**
+     * 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.
+     */
+    CustomReplacePlugin.prototype.dispose = function () {
+        this.editor = null;
+    };
+    /**
+     * 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:
+     */
+    CustomReplacePlugin.prototype.onPluginEvent = function (event) {
+        if (this.editor) {
+            switch (event.eventType) {
+                case 'input':
+                    this.handleEditorInputEvent(this.editor, event);
+                    break;
+            }
+        }
+    };
+    CustomReplacePlugin.prototype.handleEditorInputEvent = function (editor, event) {
+        var _this = this;
+        var rawEvent = event.rawEvent;
+        var selection = editor.getDOMSelection();
+        var key = rawEvent.data;
+        if (this.customReplacements.length > 0 &&
+            rawEvent.inputType === 'insertText' &&
+            selection &&
+            selection.type === 'range' &&
+            selection.range.collapsed &&
+            key &&
+            this.triggerKeys.indexOf(key) > -1) {
+            (0, roosterjs_content_model_api_1.formatTextSegmentBeforeSelectionMarker)(editor, function (_model, previousSegment, paragraph, _markerFormat, context) {
+                var replaced = _this.customReplacements.some(function (_a) {
+                    var stringToReplace = _a.stringToReplace, replacementString = _a.replacementString, replacementHandler = _a.replacementHandler;
+                    return replacementHandler(previousSegment, stringToReplace, replacementString, paragraph);
+                });
+                if (replaced) {
+                    context.canUndoByBackspace = true;
+                    return true;
+                }
+                return false;
+            });
+        }
+    };
+    return CustomReplacePlugin;
+}());
+exports.CustomReplacePlugin = CustomReplacePlugin;
 //# sourceMappingURL=CustomReplacePlugin.js.map

package/lib/customReplace/CustomReplacePlugin.js.map

@@ -1 +1 @@
-{"version":3,"file":"CustomReplacePlugin.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-plugins/lib/customReplace/CustomReplacePlugin.ts"],"names":[],"mappings":";;;AAAA,2EAAqF;AAwCrF;;GAEG;AACH;IAII;;;OAGG;IACH,6BAAoB,kBAAmC;QAAnC,uBAAkB,GAAlB,kBAAkB,CAAiB;QAP/C,WAAM,GAAmB,IAAI,CAAC;QAC9B,gBAAW,GAAa,EAAE,CAAC;IAMuB,CAAC;IAE3D;;OAEG;IACH,qCAAO,GAAP;QACI,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,wCAAU,GAAV,UAAW,MAAe;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAA,WAAW;YACtD,OAAA,WAAW,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAArC,CAAqC,CACxC,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,qCAAO,GAAP;QACI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACH,2CAAa,GAAb,UAAc,KAAkB;QAC5B,IAAI,IAAI,CAAC,MAAM,EAAE;YACb,QAAQ,KAAK,CAAC,SAAS,EAAE;gBACrB,KAAK,OAAO;oBACR,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;oBAChD,MAAM;aACb;SACJ;IACL,CAAC;IAEO,oDAAsB,GAA9B,UAA+B,MAAe,EAAE,KAAuB;QAAvE,iBAkCC;QAjCG,IAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAM,SAAS,GAAG,MAAM,CAAC,eAAe,EAAE,CAAC;QAC3C,IAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC1B,IACI,IAAI,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC;YAClC,QAAQ,CAAC,SAAS,KAAK,YAAY;YACnC,SAAS;YACT,SAAS,CAAC,IAAI,KAAK,OAAO;YAC1B,SAAS,CAAC,KAAK,CAAC,SAAS;YACzB,GAAG;YACH,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EACpC;YACE,IAAA,oEAAsC,EAClC,MAAM,EACN,UAAC,MAAM,EAAE,eAAe,EAAE,SAAS,EAAE,aAAa,EAAE,OAAO;gBACvD,IAAM,QAAQ,GAAG,KAAI,CAAC,kBAAkB,CAAC,IAAI,CACzC,UAAC,EAA0D;wBAAxD,eAAe,qBAAA,EAAE,iBAAiB,uBAAA,EAAE,kBAAkB,wBAAA;oBACrD,OAAO,kBAAkB,CACrB,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,SAAS,CACZ,CAAC;gBACN,CAAC,CACJ,CAAC;gBACF,IAAI,QAAQ,EAAE;oBACV,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;oBAClC,OAAO,IAAI,CAAC;iBACf;gBACD,OAAO,KAAK,CAAC;YACjB,CAAC,CACJ,CAAC;SACL;IACL,CAAC;IACL,0BAAC;AAAD,CAAC,AA1FD,IA0FC;AA1FY,kDAAmB","sourcesContent":["import { formatTextSegmentBeforeSelectionMarker } from 'roosterjs-content-model-api';\r\nimport type {\r\n    ContentModelText,\r\n    EditorInputEvent,\r\n    EditorPlugin,\r\n    IEditor,\r\n    PluginEvent,\r\n    ShallowMutableContentModelParagraph,\r\n} from 'roosterjs-content-model-types';\r\n\r\n/**\r\n * The CustomReplace interface defines a custom replacement that can be used in CustomReplacePlugin.\r\n */\r\nexport interface CustomReplace {\r\n    /**\r\n     * The string to replace in the editor.\r\n     */\r\n    stringToReplace: string;\r\n\r\n    /**\r\n     * The string to replace with.\r\n     */\r\n    replacementString: string;\r\n\r\n    /**\r\n     * The handler to replace the string.\r\n     * @param previousSegment The text segment to replace.\r\n     * @param stringToReplace The string to replace.\r\n     * @param replacementString The string to replace with.\r\n     * @param paragraph The paragraph that contains the text segment.\r\n     * @returns True if the string is replaced successfully, otherwise false.\r\n     */\r\n    replacementHandler: (\r\n        previousSegment: ContentModelText,\r\n        stringToReplace: string,\r\n        replacementString: string,\r\n        paragraph?: ShallowMutableContentModelParagraph\r\n    ) => boolean;\r\n}\r\n\r\n/**\r\n * CustomReplacePlugin is a plugin that allows you to replace a string with another string in the editor.\r\n */\r\nexport class CustomReplacePlugin implements EditorPlugin {\r\n    private editor: IEditor | null = null;\r\n    private triggerKeys: string[] = [];\r\n\r\n    /**\r\n     * @param customReplacements Custom replacement rules.\r\n     * Ex: [{ stringToReplace: ':)', replacementString: '🙂', replacementHandler: replaceEmojis }]\r\n     */\r\n    constructor(private customReplacements: CustomReplace[]) {}\r\n\r\n    /**\r\n     * Get name of this plugin\r\n     */\r\n    getName() {\r\n        return 'CustomReplace';\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.triggerKeys = this.customReplacements.map(replacement =>\r\n            replacement.stringToReplace.slice(-1)\r\n        );\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     * 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) {\r\n            switch (event.eventType) {\r\n                case 'input':\r\n                    this.handleEditorInputEvent(this.editor, event);\r\n                    break;\r\n            }\r\n        }\r\n    }\r\n\r\n    private handleEditorInputEvent(editor: IEditor, event: EditorInputEvent) {\r\n        const rawEvent = event.rawEvent;\r\n        const selection = editor.getDOMSelection();\r\n        const key = rawEvent.data;\r\n        if (\r\n            this.customReplacements.length > 0 &&\r\n            rawEvent.inputType === 'insertText' &&\r\n            selection &&\r\n            selection.type === 'range' &&\r\n            selection.range.collapsed &&\r\n            key &&\r\n            this.triggerKeys.indexOf(key) > -1\r\n        ) {\r\n            formatTextSegmentBeforeSelectionMarker(\r\n                editor,\r\n                (_model, previousSegment, paragraph, _markerFormat, context) => {\r\n                    const replaced = this.customReplacements.some(\r\n                        ({ stringToReplace, replacementString, replacementHandler }) => {\r\n                            return replacementHandler(\r\n                                previousSegment,\r\n                                stringToReplace,\r\n                                replacementString,\r\n                                paragraph\r\n                            );\r\n                        }\r\n                    );\r\n                    if (replaced) {\r\n                        context.canUndoByBackspace = true;\r\n                        return true;\r\n                    }\r\n                    return false;\r\n                }\r\n            );\r\n        }\r\n    }\r\n}\r\n"]}
+{"version":3,"file":"CustomReplacePlugin.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-plugins/lib/customReplace/CustomReplacePlugin.ts"],"names":[],"mappings":";;;AAAA,2EAAqF;AAwCrF;;GAEG;AACH;IAII;;;OAGG;IACH,6BAAoB,kBAAmC;QAAnC,uBAAkB,GAAlB,kBAAkB,CAAiB;QAP/C,WAAM,GAAmB,IAAI,CAAC;QAC9B,gBAAW,GAAa,EAAE,CAAC;IAMuB,CAAC;IAE3D;;OAEG;IACH,qCAAO,GAAP;QACI,OAAO,eAAe,CAAC;IAC3B,CAAC;IAED;;;;;OAKG;IACH,wCAAU,GAAV,UAAW,MAAe;QACtB,IAAI,CAAC,MAAM,GAAG,MAAM,CAAC;QACrB,IAAI,CAAC,WAAW,GAAG,IAAI,CAAC,kBAAkB,CAAC,GAAG,CAAC,UAAA,WAAW;YACtD,OAAA,WAAW,CAAC,eAAe,CAAC,KAAK,CAAC,CAAC,CAAC,CAAC;QAArC,CAAqC,CACxC,CAAC;IACN,CAAC;IAED;;;;OAIG;IACH,qCAAO,GAAP;QACI,IAAI,CAAC,MAAM,GAAG,IAAI,CAAC;IACvB,CAAC;IAED;;;;;OAKG;IACH,2CAAa,GAAb,UAAc,KAAkB;QAC5B,IAAI,IAAI,CAAC,MAAM,EAAE;YACb,QAAQ,KAAK,CAAC,SAAS,EAAE;gBACrB,KAAK,OAAO;oBACR,IAAI,CAAC,sBAAsB,CAAC,IAAI,CAAC,MAAM,EAAE,KAAK,CAAC,CAAC;oBAChD,MAAM;aACb;SACJ;IACL,CAAC;IAEO,oDAAsB,GAA9B,UAA+B,MAAe,EAAE,KAAuB;QAAvE,iBAkCC;QAjCG,IAAM,QAAQ,GAAG,KAAK,CAAC,QAAQ,CAAC;QAChC,IAAM,SAAS,GAAG,MAAM,CAAC,eAAe,EAAE,CAAC;QAC3C,IAAM,GAAG,GAAG,QAAQ,CAAC,IAAI,CAAC;QAC1B,IACI,IAAI,CAAC,kBAAkB,CAAC,MAAM,GAAG,CAAC;YAClC,QAAQ,CAAC,SAAS,KAAK,YAAY;YACnC,SAAS;YACT,SAAS,CAAC,IAAI,KAAK,OAAO;YAC1B,SAAS,CAAC,KAAK,CAAC,SAAS;YACzB,GAAG;YACH,IAAI,CAAC,WAAW,CAAC,OAAO,CAAC,GAAG,CAAC,GAAG,CAAC,CAAC,EACpC;YACE,IAAA,oEAAsC,EAClC,MAAM,EACN,UAAC,MAAM,EAAE,eAAe,EAAE,SAAS,EAAE,aAAa,EAAE,OAAO;gBACvD,IAAM,QAAQ,GAAG,KAAI,CAAC,kBAAkB,CAAC,IAAI,CACzC,UAAC,EAA0D;wBAAxD,eAAe,qBAAA,EAAE,iBAAiB,uBAAA,EAAE,kBAAkB,wBAAA;oBACrD,OAAO,kBAAkB,CACrB,eAAe,EACf,eAAe,EACf,iBAAiB,EACjB,SAAS,CACZ,CAAC;gBACN,CAAC,CACJ,CAAC;gBACF,IAAI,QAAQ,EAAE;oBACV,OAAO,CAAC,kBAAkB,GAAG,IAAI,CAAC;oBAClC,OAAO,IAAI,CAAC;iBACf;gBACD,OAAO,KAAK,CAAC;YACjB,CAAC,CACJ,CAAC;SACL;IACL,CAAC;IACL,0BAAC;AAAD,CAAC,AA1FD,IA0FC;AA1FY,kDAAmB","sourcesContent":["import { formatTextSegmentBeforeSelectionMarker } from 'roosterjs-content-model-api';\nimport type {\n    ContentModelText,\n    EditorInputEvent,\n    EditorPlugin,\n    IEditor,\n    PluginEvent,\n    ShallowMutableContentModelParagraph,\n} from 'roosterjs-content-model-types';\n\n/**\n * The CustomReplace interface defines a custom replacement that can be used in CustomReplacePlugin.\n */\nexport interface CustomReplace {\n    /**\n     * The string to replace in the editor.\n     */\n    stringToReplace: string;\n\n    /**\n     * The string to replace with.\n     */\n    replacementString: string;\n\n    /**\n     * The handler to replace the string.\n     * @param previousSegment The text segment to replace.\n     * @param stringToReplace The string to replace.\n     * @param replacementString The string to replace with.\n     * @param paragraph The paragraph that contains the text segment.\n     * @returns True if the string is replaced successfully, otherwise false.\n     */\n    replacementHandler: (\n        previousSegment: ContentModelText,\n        stringToReplace: string,\n        replacementString: string,\n        paragraph?: ShallowMutableContentModelParagraph\n    ) => boolean;\n}\n\n/**\n * CustomReplacePlugin is a plugin that allows you to replace a string with another string in the editor.\n */\nexport class CustomReplacePlugin implements EditorPlugin {\n    private editor: IEditor | null = null;\n    private triggerKeys: string[] = [];\n\n    /**\n     * @param customReplacements Custom replacement rules.\n     * Ex: [{ stringToReplace: ':)', replacementString: '🙂', replacementHandler: replaceEmojis }]\n     */\n    constructor(private customReplacements: CustomReplace[]) {}\n\n    /**\n     * Get name of this plugin\n     */\n    getName() {\n        return 'CustomReplace';\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.triggerKeys = this.customReplacements.map(replacement =>\n            replacement.stringToReplace.slice(-1)\n        );\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     * 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) {\n            switch (event.eventType) {\n                case 'input':\n                    this.handleEditorInputEvent(this.editor, event);\n                    break;\n            }\n        }\n    }\n\n    private handleEditorInputEvent(editor: IEditor, event: EditorInputEvent) {\n        const rawEvent = event.rawEvent;\n        const selection = editor.getDOMSelection();\n        const key = rawEvent.data;\n        if (\n            this.customReplacements.length > 0 &&\n            rawEvent.inputType === 'insertText' &&\n            selection &&\n            selection.type === 'range' &&\n            selection.range.collapsed &&\n            key &&\n            this.triggerKeys.indexOf(key) > -1\n        ) {\n            formatTextSegmentBeforeSelectionMarker(\n                editor,\n                (_model, previousSegment, paragraph, _markerFormat, context) => {\n                    const replaced = this.customReplacements.some(\n                        ({ stringToReplace, replacementString, replacementHandler }) => {\n                            return replacementHandler(\n                                previousSegment,\n                                stringToReplace,\n                                replacementString,\n                                paragraph\n                            );\n                        }\n                    );\n                    if (replaced) {\n                        context.canUndoByBackspace = true;\n                        return true;\n                    }\n                    return false;\n                }\n            );\n        }\n    }\n}\n"]}

package/lib/edit/EditOptions.d.ts

@@ -1,78 +1,78 @@
-import type { IEditor } from 'roosterjs-content-model-types';
-/**
- * Options for handling Tab key in Edit plugin
- */
-export interface HandleTabOptions {
-    /**
-     * Whether to indent/outdent multiple selected blocks when Tab/Shift+Tab is pressed and multiple blocks are selected.
-     * @default true
-     */
-    indentMultipleBlocks?: boolean;
-    /**
-     * Whether to indent/outdent table cells when Tab key is pressed and a table is selected
-     * @default true
-     */
-    indentTable?: boolean;
-    /**
-     * Whether to append a new row when Tab key is pressed in the last cell of a table
-     * @default true
-     */
-    appendTableRow?: boolean;
-    /**
-     * Whether to indent/outdent list items when Tab key is pressed
-     * @default true
-     */
-    indentList?: boolean;
-    /**
-     * Whether to indent/outdent paragraph when Tab key is pressed
-     * @default true
-     */
-    indentParagraph?: boolean;
-}
-/**
- * Options to customize the keyboard handling behavior of Edit plugin
- */
-export declare type EditOptions = {
-    /**
-     * Whether to handle Tab key in keyboard, or an object to control specific Tab key behaviors.
-     * When true, all Tab features are enabled. When false, all are disabled.
-     * When an object, individual features can be controlled via HandleTabOptions.
-     * @default true
-     */
-    handleTabKey?: HandleTabOptions | boolean;
-    /**
-     * Whether expanded selection within a text node should be handled by CM when pressing Backspace/Delete key.
-     * @default true
-     */
-    handleExpandedSelectionOnDelete?: boolean;
-    /**
-     * Callback function to determine whether the Rooster should handle the Enter key press.
-     * If the function returns true, the Rooster will handle the Enter key press instead of the browser.
-     * @param editor - The editor instance.
-     * @returns A boolean
-     */
-    shouldHandleEnterKey?: ((editor: IEditor) => boolean) | boolean;
-    /**
-     * Callback or boolean to determine whether the browser (not Content Model) should handle the Backspace key press.
-     * If the value/callback returns true, Rooster will NOT handle Backspace and will defer to the browser's native behavior.
-     * @param editor - The editor instance (when using callback).
-     * @returns A boolean
-     */
-    shouldHandleBackspaceKey?: ((editor: IEditor) => boolean) | boolean;
-    /**
-     * An array of format property names that should be preserved when merging paragraphs
-     * during editing operations such as pressing Enter, Backspace, or Delete keys.
-     * This ensures consistent formatting is maintained across paragraph operations.
-     *
-     * @example
-     * // Preserve font family and class name during paragraph operations
-     * formatsToPreserveOnMerge: ['fontFamily', 'className']
-     *
-     * // When pressing Enter in a paragraph with fontFamily='Arial' and className='highlight',
-     * // the new paragraph will inherit both properties: fontFamily='Arial' and className='highlight'
-     *
-     * // When pressing Backspace to merge two paragraphs, the preserved formats from the first
-     * // paragraph will be applied to the merged result
-     */
-    formatsToPreserveOnMerge?: string[];
-};
+import type { IEditor } from 'roosterjs-content-model-types';
+/**
+ * Options for handling Tab key in Edit plugin
+ */
+export interface HandleTabOptions {
+    /**
+     * Whether to indent/outdent multiple selected blocks when Tab/Shift+Tab is pressed and multiple blocks are selected.
+     * @default true
+     */
+    indentMultipleBlocks?: boolean;
+    /**
+     * Whether to indent/outdent table cells when Tab key is pressed and a table is selected
+     * @default true
+     */
+    indentTable?: boolean;
+    /**
+     * Whether to append a new row when Tab key is pressed in the last cell of a table
+     * @default true
+     */
+    appendTableRow?: boolean;
+    /**
+     * Whether to indent/outdent list items when Tab key is pressed
+     * @default true
+     */
+    indentList?: boolean;
+    /**
+     * Whether to indent/outdent paragraph when Tab key is pressed
+     * @default true
+     */
+    indentParagraph?: boolean;
+}
+/**
+ * Options to customize the keyboard handling behavior of Edit plugin
+ */
+export declare type EditOptions = {
+    /**
+     * Whether to handle Tab key in keyboard, or an object to control specific Tab key behaviors.
+     * When true, all Tab features are enabled. When false, all are disabled.
+     * When an object, individual features can be controlled via HandleTabOptions.
+     * @default true
+     */
+    handleTabKey?: HandleTabOptions | boolean;
+    /**
+     * Whether expanded selection within a text node should be handled by CM when pressing Backspace/Delete key.
+     * @default true
+     */
+    handleExpandedSelectionOnDelete?: boolean;
+    /**
+     * Callback function to determine whether the Rooster should handle the Enter key press.
+     * If the function returns true, the Rooster will handle the Enter key press instead of the browser.
+     * @param editor - The editor instance.
+     * @returns A boolean
+     */
+    shouldHandleEnterKey?: ((editor: IEditor) => boolean) | boolean;
+    /**
+     * Callback or boolean to determine whether the browser (not Content Model) should handle the Backspace key press.
+     * If the value/callback returns true, Rooster will NOT handle Backspace and will defer to the browser's native behavior.
+     * @param editor - The editor instance (when using callback).
+     * @returns A boolean
+     */
+    shouldHandleBackspaceKey?: ((editor: IEditor) => boolean) | boolean;
+    /**
+     * An array of format property names that should be preserved when merging paragraphs
+     * during editing operations such as pressing Enter, Backspace, or Delete keys.
+     * This ensures consistent formatting is maintained across paragraph operations.
+     *
+     * @example
+     * // Preserve font family and class name during paragraph operations
+     * formatsToPreserveOnMerge: ['fontFamily', 'className']
+     *
+     * // When pressing Enter in a paragraph with fontFamily='Arial' and className='highlight',
+     * // the new paragraph will inherit both properties: fontFamily='Arial' and className='highlight'
+     *
+     * // When pressing Backspace to merge two paragraphs, the preserved formats from the first
+     * // paragraph will be applied to the merged result
+     */
+    formatsToPreserveOnMerge?: string[];
+};

package/lib/edit/EditOptions.js

@@ -1,3 +1,3 @@
-"use strict";
-Object.defineProperty(exports, "__esModule", { value: true });
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
 //# sourceMappingURL=EditOptions.js.map

package/lib/edit/EditOptions.js.map

@@ -1 +1 @@
-{"version":3,"file":"EditOptions.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-plugins/lib/edit/EditOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { IEditor } from 'roosterjs-content-model-types';\r\n\r\n/**\r\n * Options for handling Tab key in Edit plugin\r\n */\r\nexport interface HandleTabOptions {\r\n    /**\r\n     * Whether to indent/outdent multiple selected blocks when Tab/Shift+Tab is pressed and multiple blocks are selected.\r\n     * @default true\r\n     */\r\n    indentMultipleBlocks?: boolean;\r\n\r\n    /**\r\n     * Whether to indent/outdent table cells when Tab key is pressed and a table is selected\r\n     * @default true\r\n     */\r\n    indentTable?: boolean;\r\n\r\n    /**\r\n     * Whether to append a new row when Tab key is pressed in the last cell of a table\r\n     * @default true\r\n     */\r\n    appendTableRow?: boolean;\r\n\r\n    /**\r\n     * Whether to indent/outdent list items when Tab key is pressed\r\n     * @default true\r\n     */\r\n    indentList?: boolean;\r\n\r\n    /**\r\n     * Whether to indent/outdent paragraph when Tab key is pressed\r\n     * @default true\r\n     */\r\n    indentParagraph?: boolean;\r\n}\r\n\r\n/**\r\n * Options to customize the keyboard handling behavior of Edit plugin\r\n */\r\n\r\nexport type EditOptions = {\r\n    /**\r\n     * Whether to handle Tab key in keyboard, or an object to control specific Tab key behaviors.\r\n     * When true, all Tab features are enabled. When false, all are disabled.\r\n     * When an object, individual features can be controlled via HandleTabOptions.\r\n     * @default true\r\n     */\r\n    handleTabKey?: HandleTabOptions | boolean;\r\n\r\n    /**\r\n     * Whether expanded selection within a text node should be handled by CM when pressing Backspace/Delete key.\r\n     * @default true\r\n     */\r\n    handleExpandedSelectionOnDelete?: boolean;\r\n\r\n    /**\r\n     * Callback function to determine whether the Rooster should handle the Enter key press.\r\n     * If the function returns true, the Rooster will handle the Enter key press instead of the browser.\r\n     * @param editor - The editor instance.\r\n     * @returns A boolean\r\n     */\r\n    shouldHandleEnterKey?: ((editor: IEditor) => boolean) | boolean;\r\n\r\n    /**\r\n     * Callback or boolean to determine whether the browser (not Content Model) should handle the Backspace key press.\r\n     * If the value/callback returns true, Rooster will NOT handle Backspace and will defer to the browser's native behavior.\r\n     * @param editor - The editor instance (when using callback).\r\n     * @returns A boolean\r\n     */\r\n    shouldHandleBackspaceKey?: ((editor: IEditor) => boolean) | boolean;\r\n\r\n    /**\r\n     * An array of format property names that should be preserved when merging paragraphs\r\n     * during editing operations such as pressing Enter, Backspace, or Delete keys.\r\n     * This ensures consistent formatting is maintained across paragraph operations.\r\n     *\r\n     * @example\r\n     * // Preserve font family and class name during paragraph operations\r\n     * formatsToPreserveOnMerge: ['fontFamily', 'className']\r\n     *\r\n     * // When pressing Enter in a paragraph with fontFamily='Arial' and className='highlight',\r\n     * // the new paragraph will inherit both properties: fontFamily='Arial' and className='highlight'\r\n     *\r\n     * // When pressing Backspace to merge two paragraphs, the preserved formats from the first\r\n     * // paragraph will be applied to the merged result\r\n     */\r\n    formatsToPreserveOnMerge?: string[];\r\n};\r\n"]}
+{"version":3,"file":"EditOptions.js","sourceRoot":"","sources":["../../../../packages/roosterjs-content-model-plugins/lib/edit/EditOptions.ts"],"names":[],"mappings":"","sourcesContent":["import type { IEditor } from 'roosterjs-content-model-types';\n\n/**\n * Options for handling Tab key in Edit plugin\n */\nexport interface HandleTabOptions {\n    /**\n     * Whether to indent/outdent multiple selected blocks when Tab/Shift+Tab is pressed and multiple blocks are selected.\n     * @default true\n     */\n    indentMultipleBlocks?: boolean;\n\n    /**\n     * Whether to indent/outdent table cells when Tab key is pressed and a table is selected\n     * @default true\n     */\n    indentTable?: boolean;\n\n    /**\n     * Whether to append a new row when Tab key is pressed in the last cell of a table\n     * @default true\n     */\n    appendTableRow?: boolean;\n\n    /**\n     * Whether to indent/outdent list items when Tab key is pressed\n     * @default true\n     */\n    indentList?: boolean;\n\n    /**\n     * Whether to indent/outdent paragraph when Tab key is pressed\n     * @default true\n     */\n    indentParagraph?: boolean;\n}\n\n/**\n * Options to customize the keyboard handling behavior of Edit plugin\n */\n\nexport type EditOptions = {\n    /**\n     * Whether to handle Tab key in keyboard, or an object to control specific Tab key behaviors.\n     * When true, all Tab features are enabled. When false, all are disabled.\n     * When an object, individual features can be controlled via HandleTabOptions.\n     * @default true\n     */\n    handleTabKey?: HandleTabOptions | boolean;\n\n    /**\n     * Whether expanded selection within a text node should be handled by CM when pressing Backspace/Delete key.\n     * @default true\n     */\n    handleExpandedSelectionOnDelete?: boolean;\n\n    /**\n     * Callback function to determine whether the Rooster should handle the Enter key press.\n     * If the function returns true, the Rooster will handle the Enter key press instead of the browser.\n     * @param editor - The editor instance.\n     * @returns A boolean\n     */\n    shouldHandleEnterKey?: ((editor: IEditor) => boolean) | boolean;\n\n    /**\n     * Callback or boolean to determine whether the browser (not Content Model) should handle the Backspace key press.\n     * If the value/callback returns true, Rooster will NOT handle Backspace and will defer to the browser's native behavior.\n     * @param editor - The editor instance (when using callback).\n     * @returns A boolean\n     */\n    shouldHandleBackspaceKey?: ((editor: IEditor) => boolean) | boolean;\n\n    /**\n     * An array of format property names that should be preserved when merging paragraphs\n     * during editing operations such as pressing Enter, Backspace, or Delete keys.\n     * This ensures consistent formatting is maintained across paragraph operations.\n     *\n     * @example\n     * // Preserve font family and class name during paragraph operations\n     * formatsToPreserveOnMerge: ['fontFamily', 'className']\n     *\n     * // When pressing Enter in a paragraph with fontFamily='Arial' and className='highlight',\n     * // the new paragraph will inherit both properties: fontFamily='Arial' and className='highlight'\n     *\n     * // When pressing Backspace to merge two paragraphs, the preserved formats from the first\n     * // paragraph will be applied to the merged result\n     */\n    formatsToPreserveOnMerge?: string[];\n};\n"]}

package/lib/edit/EditPlugin.d.ts

@@ -1,60 +1,60 @@
-import type { EditOptions } from './EditOptions';
-import type { EditorPlugin, IEditor, PluginEvent } from 'roosterjs-content-model-types';
-/**
- * Edit plugins helps editor to do editing operation on top of content model.
- * This includes:
- * 1. Delete Key
- * 2. Backspace Key
- * 3. Tab Key
- */
-export declare class EditPlugin implements EditorPlugin {
-    private editor;
-    private disposer;
-    private shouldHandleNextInputEvent;
-    private selectionAfterDelete;
-    private handleNormalEnter;
-    private options;
-    /**
-     * @param options An optional parameter that takes in an object of type EditOptions, which includes the following properties:
-     * handleTabKey: A boolean or HandleTabOptions object that controls Tab key handling. When a boolean, true enables all features and false disables all. When an object, individual features can be controlled. Defaults to all enabled.
-     */
-    constructor(options?: EditOptions);
-    private createNormalEnterChecker;
-    private getHandleNormalEnter;
-    /**
-     * 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;
-    /**
-     * 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;
-    /**
-     * 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;
-    private handleKeyDownEvent;
-    private handleBeforeInputEvent;
-    private shouldBrowserHandleBackspace;
-}
+import type { EditOptions } from './EditOptions';
+import type { EditorPlugin, IEditor, PluginEvent } from 'roosterjs-content-model-types';
+/**
+ * Edit plugins helps editor to do editing operation on top of content model.
+ * This includes:
+ * 1. Delete Key
+ * 2. Backspace Key
+ * 3. Tab Key
+ */
+export declare class EditPlugin implements EditorPlugin {
+    private editor;
+    private disposer;
+    private shouldHandleNextInputEvent;
+    private selectionAfterDelete;
+    private handleNormalEnter;
+    private options;
+    /**
+     * @param options An optional parameter that takes in an object of type EditOptions, which includes the following properties:
+     * handleTabKey: A boolean or HandleTabOptions object that controls Tab key handling. When a boolean, true enables all features and false disables all. When an object, individual features can be controlled. Defaults to all enabled.
+     */
+    constructor(options?: EditOptions);
+    private createNormalEnterChecker;
+    private getHandleNormalEnter;
+    /**
+     * 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;
+    /**
+     * 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;
+    /**
+     * 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;
+    private handleKeyDownEvent;
+    private handleBeforeInputEvent;
+    private shouldBrowserHandleBackspace;
+}