Improve

microsoft · Nov 20, 2024 · b41ba36 · b41ba36
1 parent 928c632
commit b41ba36
Show file tree

Hide file tree

Showing 49 changed files with 632 additions and 584 deletions.
diff --git a/packages/roosterjs-content-model-api/test/publicApi/link/insertLinkTest.ts b/packages/roosterjs-content-model-api/test/publicApi/link/insertLinkTest.ts
@@ -330,7 +330,6 @@ describe('insertLink', () => {
         const editor = new Editor(div, {
             plugins: [mockedPlugin],
         });
-        const firstDiv = div.firstChild as HTMLElement;
 
         editor.focus();
 
@@ -349,8 +348,6 @@ describe('insertLink', () => {
             contentModel: jasmine.anything(),
             selection: jasmine.anything(),
             changedEntities: [],
-            addedBlockElements: [div.firstChild],
-            removedBlockElements: [firstDiv],
         });
 
         document.body.removeChild(div);

diff --git a/packages/roosterjs-content-model-core/lib/coreApi/formatContentModel/formatContentModel.ts b/packages/roosterjs-content-model-core/lib/coreApi/formatContentModel/formatContentModel.ts
@@ -7,7 +7,6 @@ import type {
     FormatContentModel,
     FormatContentModelContext,
     EditorCore,
-    DomManipulationContext,
 } from 'roosterjs-content-model-types';
 
 /**
@@ -60,15 +59,12 @@ export const formatContentModel: FormatContentModel = (
         try {
             handleImages(core, context);
 
-            const domManipulationResult: Partial<DomManipulationContext> = {};
-
             selection =
                 core.api.setContentModel(
                     core,
                     model,
                     hasFocus ? undefined : { ignoreSelection: true }, // If editor did not have focus before format, do not set focus after format
-                    onNodeCreated,
-                    domManipulationResult
+                    onNodeCreated
                 ) ?? undefined;
 
             handlePendingFormat(core, context, selection);
@@ -85,8 +81,6 @@ export const formatContentModel: FormatContentModel = (
                 data: getChangeData?.(),
                 formatApiName: options?.apiName,
                 changedEntities: getChangedEntities(context, rawEvent),
-                addedBlockElements: domManipulationResult.addedBlockElements,
-                removedBlockElements: domManipulationResult.removedBlockElements,
             };
 
             core.api.triggerEvent(core, eventData, true /*broadcast*/);

diff --git a/packages/roosterjs-content-model-core/lib/coreApi/setContentModel/setContentModel.ts b/packages/roosterjs-content-model-core/lib/coreApi/setContentModel/setContentModel.ts
@@ -12,14 +12,16 @@ import type { SetContentModel } from 'roosterjs-content-model-types';
  * @param core The editor core object
  * @param model The content model to set
  * @param option Additional options to customize the behavior of Content Model to DOM conversion
- * @param domManipulationResult Used for receiving added and removed block elements during this operation
+ * @param onNodeCreated An optional callback that will be called when a DOM node is created
+ * @param isInitializing True means editor is being initialized then it will save modification nodes onto
+ * lifecycleState instead of triggering events, false means other cases
  */
 export const setContentModel: SetContentModel = (
     core,
     model,
     option,
     onNodeCreated,
-    domManipulationResult
+    isInitializing
 ) => {
     const editorContext = core.api.createEditorContext(core, true /*saveIndex*/);
     const modelToDomContext = option
@@ -56,9 +58,19 @@ export const setContentModel: SetContentModel = (
         }
     }
 
-    if (domManipulationResult) {
-        domManipulationResult.addedBlockElements = modelToDomContext.addedBlockElements;
-        domManipulationResult.removedBlockElements = modelToDomContext.removedBlockElements;
+    if (isInitializing) {
+        // When initialize, we should not trigger event until all plugins are initialized, so put these node in lifecycle state temporarily
+        core.lifecycle.domModification = modelToDomContext.domModification;
+    } else {
+        // Otherwise, trigger DomModification event immediately
+        core.api.triggerEvent(
+            core,
+            {
+                eventType: 'domModification',
+                ...modelToDomContext.domModification,
+            },
+            true /*broadcast*/
+        );
     }
 
     return selection;

diff --git a/packages/roosterjs-content-model-core/lib/coreApi/switchShadowEdit/switchShadowEdit.ts b/packages/roosterjs-content-model-core/lib/coreApi/switchShadowEdit/switchShadowEdit.ts
@@ -1,5 +1,5 @@
-import { ChangeSource, iterateSelections, moveChildNodes } from 'roosterjs-content-model-dom';
-import type { DomManipulationContext, SwitchShadowEdit } from 'roosterjs-content-model-types';
+import { iterateSelections, moveChildNodes } from 'roosterjs-content-model-dom';
+import type { SwitchShadowEdit } from 'roosterjs-content-model-types';
 
 /**
  * @internal
@@ -48,29 +48,9 @@ export const switchShadowEdit: SwitchShadowEdit = (editorCore, isOn): void => {
                 // Force clear cached element from selected block
                 iterateSelections(core.cache.cachedModel, () => {});
 
-                const domManipulationResult: Partial<DomManipulationContext> = {};
-                const selection = core.api.setContentModel(
-                    core,
-                    core.cache.cachedModel,
-                    {
-                        ignoreSelection: true, // Do not set focus and selection when quit shadow edit, focus may remain in UI control (picker, ...)
-                    },
-                    undefined /*onNodeCreated*/,
-                    domManipulationResult
-                );
-
-                core.api.triggerEvent(
-                    core,
-                    {
-                        eventType: 'contentChanged',
-                        source: ChangeSource.LeftShadowEdit,
-                        contentModel: core.cache.cachedModel,
-                        selection: selection ?? undefined,
-                        addedBlockElements: domManipulationResult.addedBlockElements,
-                        removedBlockElements: domManipulationResult.removedBlockElements,
-                    },
-                    false /*broadcast*/
-                );
+                core.api.setContentModel(core, core.cache.cachedModel, {
+                    ignoreSelection: true, // Do not set focus and selection when quit shadow edit, focus may remain in UI control (picker, ...)
+                });
             }
         }
     }

diff --git a/packages/roosterjs-content-model-core/lib/corePlugin/lifecycle/LifecyclePlugin.ts b/packages/roosterjs-content-model-core/lib/corePlugin/lifecycle/LifecyclePlugin.ts
@@ -6,6 +6,7 @@ import type {
     PluginEvent,
     PluginWithState,
     EditorOptions,
+    DomModification,
 } from 'roosterjs-content-model-types';
 
 const ContentEditableAttributeName = 'contenteditable';
@@ -73,6 +74,15 @@ class LifecyclePlugin implements PluginWithState<LifecyclePluginState> {
         // Set editor background color for dark mode
         this.adjustColor();
 
+        // Let other plugins know that we are ready
+        const domModification: DomModification = this.state.domModification ?? {
+            addedBlockElements: [],
+            removedBlockElements: [],
+        };
+
+        this.editor.triggerEvent('editorReady', domModification, true /*broadcast*/);
+        delete this.state.domModification;
+
         // Initialize the Announce container.
         this.state.announceContainer = createAriaLiveElement(editor.getDocument());
     }

diff --git a/packages/roosterjs-content-model-core/lib/editor/Editor.ts b/packages/roosterjs-content-model-core/lib/editor/Editor.ts
@@ -32,7 +32,6 @@ import type {
     DomToModelOptionForCreateModel,
     AnnounceData,
     ExperimentalFeature,
-    DomManipulationContext,
 } from 'roosterjs-content-model-types';
 
 /**
@@ -50,26 +49,15 @@ export class Editor implements IEditor {
         this.core = createEditorCore(contentDiv, options);
 
         const initialModel = options.initialModel ?? createEmptyModel(options.defaultSegmentFormat);
-        const domManipulationResult: Partial<DomManipulationContext> = {};
 
         this.core.api.setContentModel(
             this.core,
             initialModel,
             { ignoreSelection: true },
             undefined /*onNodeCreated*/,
-            domManipulationResult
+            true /*isInitializing*/
         );
         this.core.plugins.forEach(plugin => plugin.initialize(this));
-
-        // Let other plugins know that we are ready
-        this.triggerEvent(
-            'editorReady',
-            {
-                addedBlockElements: domManipulationResult.addedBlockElements,
-                removedBlockElements: domManipulationResult.removedBlockElements,
-            },
-            true /*broadcast*/
-        );
     }
 
     /**