@atlaskit/editor-plugin-caption 1.6.0 → 1.6.2

package/CHANGELOG.md

@@ -1,5 +1,19 @@
 # @atlaskit/editor-plugin-caption
 
+## 1.6.2
+
+### Patch Changes
+
+- [#121438](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/pull-requests/121438)
+  [`35e0addb19a19`](https://stash.atlassian.com/projects/CONFCLOUD/repos/confluence-frontend/commits/35e0addb19a19) -
+  [ux] Fixing media caption to stop them infinitely re-rendering in react 18 when using createRoot
+
+## 1.6.1
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 1.6.0
 
 ### Minor Changes

package/dist/cjs/nodeviews/index.js

@@ -55,6 +55,20 @@ var CaptionNodeView = exports.CaptionNodeView = /*#__PURE__*/function (_Selectio
         dom: dom
       };
     }
+
+    // ED-24114: We need to ignore mutations that are not related to the caption node
+    // since these mutations can cause an infinite loop in React 18 when using createRoot
+  }, {
+    key: "ignoreMutation",
+    value: function ignoreMutation(mutation) {
+      if (!(0, _platformFeatureFlags.fg)('react_18_caption_concurrent_mode')) {
+        return false;
+      }
+      if (!this.contentDOM) {
+        return true;
+      }
+      return !this.contentDOM.contains(mutation.target) && mutation.type !== 'selection';
+    }
   }, {
     key: "handleEditorDisabledChanged",
     value: function handleEditorDisabledChanged() {

package/dist/es2019/nodeviews/index.js

@@ -30,6 +30,18 @@ export class CaptionNodeView extends SelectionBasedNodeView {
       dom
     };
   }
+
+  // ED-24114: We need to ignore mutations that are not related to the caption node
+  // since these mutations can cause an infinite loop in React 18 when using createRoot
+  ignoreMutation(mutation) {
+    if (!fg('react_18_caption_concurrent_mode')) {
+      return false;
+    }
+    if (!this.contentDOM) {
+      return true;
+    }
+    return !this.contentDOM.contains(mutation.target) && mutation.type !== 'selection';
+  }
   handleEditorDisabledChanged() {
     var _this$pluginInjection4;
     if ((_this$pluginInjection4 = this.pluginInjectionApi) !== null && _this$pluginInjection4 !== void 0 && _this$pluginInjection4.editorDisabled) {

package/dist/esm/nodeviews/index.js

@@ -47,6 +47,20 @@ export var CaptionNodeView = /*#__PURE__*/function (_SelectionBasedNodeVi) {
         dom: dom
       };
     }
+
+    // ED-24114: We need to ignore mutations that are not related to the caption node
+    // since these mutations can cause an infinite loop in React 18 when using createRoot
+  }, {
+    key: "ignoreMutation",
+    value: function ignoreMutation(mutation) {
+      if (!fg('react_18_caption_concurrent_mode')) {
+        return false;
+      }
+      if (!this.contentDOM) {
+        return true;
+      }
+      return !this.contentDOM.contains(mutation.target) && mutation.type !== 'selection';
+    }
   }, {
     key: "handleEditorDisabledChanged",
     value: function handleEditorDisabledChanged() {

package/dist/types/nodeviews/index.d.ts

@@ -16,6 +16,10 @@ export declare class CaptionNodeView extends SelectionBasedNodeView {
     getContentDOM(): {
         dom: HTMLDivElement;
     };
+    ignoreMutation(mutation: MutationRecord | {
+        type: 'selection';
+        target: Element;
+    }): boolean;
     handleEditorDisabledChanged(): void;
     render(_props: never, forwardRef: ForwardRef): JSX.Element;
     viewShouldUpdate(nextNode: PMNode): boolean;

package/dist/types-ts4.5/nodeviews/index.d.ts

@@ -16,6 +16,10 @@ export declare class CaptionNodeView extends SelectionBasedNodeView {
     getContentDOM(): {
         dom: HTMLDivElement;
     };
+    ignoreMutation(mutation: MutationRecord | {
+        type: 'selection';
+        target: Element;
+    }): boolean;
     handleEditorDisabledChanged(): void;
     render(_props: never, forwardRef: ForwardRef): JSX.Element;
     viewShouldUpdate(nextNode: PMNode): boolean;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-caption",
-	"version": "1.6.0",
+	"version": "1.6.2",
 	"description": "Caption plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -33,7 +33,7 @@
 	},
 	"dependencies": {
 		"@atlaskit/adf-schema": "^39.0.3",
-		"@atlaskit/editor-common": "^85.0.0",
+		"@atlaskit/editor-common": "^86.2.0",
 		"@atlaskit/editor-plugin-analytics": "^1.4.0",
 		"@atlaskit/editor-plugin-editor-disabled": "^1.1.0",
 		"@atlaskit/editor-prosemirror": "4.0.1",
@@ -88,6 +88,9 @@
 	"platform-feature-flags": {
 		"platform.editor.live-view.disable-editing-in-view-mode_fi1rx": {
 			"type": "boolean"
+		},
+		"react_18_caption_concurrent_mode": {
+			"type": "boolean"
 		}
 	}
 }