@atlaskit/editor-plugin-block-controls 17.3.4 → 17.3.6

package/CHANGELOG.md

@@ -1,5 +1,21 @@
 # @atlaskit/editor-plugin-block-controls
 
+## 17.3.6
+
+### Patch Changes
+
+- Updated dependencies
+
+## 17.3.5
+
+### Patch Changes
+
+- [`68c9e797f649f`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/68c9e797f649f) -
+  EDITOR-8771: Registry-backed left and right block-controls surfaces now stay sticky within the
+  target node while scrolling long tables, panels, expands, etc., matching the legacy decoration
+  controls' sticky behavior. Also fix legacy registerNodeDecoration consumers that were missing due
+  to incorrect gating behind the quick insert button flag.
+
 ## 17.3.4
 
 ### Patch Changes

package/dist/cjs/pm-plugins/main.js

@@ -467,11 +467,16 @@ var _apply = exports.apply = function apply(api, formatMessage, tr, currentState
       var oldActiveQuickInsertDec = (0, _decorationsQuickInsertButton.findActiveQuickInsertNodeDec)(decorations, 0, newState.doc.content.size);
       decorations = decorations.remove(oldActiveQuickInsertDec);
     }
-    // platform_editor_controls note: enables quick insert
-    if (flags.toolbarFlagsEnabled && quickInsertButtonEnabled) {
-      var _activeNode7, _activeNode8;
-      var oldQuickInsertButton = (0, _decorationsQuickInsertButton.findQuickInsertInsertButtonDecoration)(decorations, (_activeNode7 = activeNode) === null || _activeNode7 === void 0 ? void 0 : _activeNode7.rootPos, (_activeNode8 = activeNode) === null || _activeNode8 === void 0 ? void 0 : _activeNode8.rootPos);
-      decorations = decorations.remove(oldQuickInsertButton);
+    // nodeDecorationRegistry cleanup (e.g. the legacy Remix button) is independent of the legacy
+    // quick-insert button, so this must not be gated by quickInsertButtonEnabled — otherwise a
+    // stale decoration is left behind whenever platform_editor_block_control_migration is on.
+    if (flags.toolbarFlagsEnabled) {
+      // platform_editor_controls note: enables quick insert
+      if (quickInsertButtonEnabled) {
+        var _activeNode7, _activeNode8;
+        var oldQuickInsertButton = (0, _decorationsQuickInsertButton.findQuickInsertInsertButtonDecoration)(decorations, (_activeNode7 = activeNode) === null || _activeNode7 === void 0 ? void 0 : _activeNode7.rootPos, (_activeNode8 = activeNode) === null || _activeNode8 === void 0 ? void 0 : _activeNode8.rootPos);
+        decorations = decorations.remove(oldQuickInsertButton);
+      }
       var _iterator = _createForOfIteratorHelper(nodeDecorationRegistry),
         _step;
       try {
@@ -535,7 +540,11 @@ var _apply = exports.apply = function apply(api, formatMessage, tr, currentState
       });
       decorations = decorations.add(newState.doc, [handleDec]);
     }
-    if (flags.legacyDragHandleEnabled && (0, _expValEquals.expValEquals)('platform_editor_controls_reliable_anchor', 'isEnabled', true) && latestActiveNode) {
+    if ((flags.legacyDragHandleEnabled ||
+    // nodeDecorationRegistry consumers (e.g. the legacy Remix button) rely
+    // on that same anchor-name for their own CSS anchor() positioning, so this must still run
+    // when such a consumer exists even if the legacy drag handle itself is disabled.
+    nodeDecorationRegistry.length > 0) && (0, _expValEquals.expValEquals)('platform_editor_controls_reliable_anchor', 'isEnabled', true) && latestActiveNode) {
       // Recreate the drag handle node decoration when the active node changed,
       // its content was modified, or the document changed (e.g. Enter splits a node).
       // This runs independently of shouldRecreateHandle so that doc changes (like pressing
@@ -585,23 +594,26 @@ var _apply = exports.apply = function apply(api, formatMessage, tr, currentState
     }
     if (shouldRecreateQuickInsertButton && ((_latestActiveNode5 = latestActiveNode) === null || _latestActiveNode5 === void 0 ? void 0 : _latestActiveNode5.rootPos) !== undefined &&
     // platform_editor_controls note: enables quick insert
-    flags.toolbarFlagsEnabled && quickInsertButtonEnabled && (!rightSideControlsEnabled || !isViewMode)) {
-      var _activeNode13, _activeNode14, _latestActiveNode6, _latestActiveNode7, _latestActiveNode8, _latestActiveNode9, _latestActiveNode0, _latestActiveNode1;
-      var _oldQuickInsertButton = (0, _decorationsQuickInsertButton.findQuickInsertInsertButtonDecoration)(decorations, (_activeNode13 = activeNode) === null || _activeNode13 === void 0 ? void 0 : _activeNode13.rootPos, (_activeNode14 = activeNode) === null || _activeNode14 === void 0 ? void 0 : _activeNode14.rootPos);
-      decorations = decorations.remove(_oldQuickInsertButton);
-      var quickInsertButton = (0, _decorationsQuickInsertButton.quickInsertButtonDecoration)({
-        api: api,
-        formatMessage: formatMessage,
-        anchorName: (_latestActiveNode6 = latestActiveNode) === null || _latestActiveNode6 === void 0 ? void 0 : _latestActiveNode6.anchorName,
-        nodeType: (_latestActiveNode7 = latestActiveNode) === null || _latestActiveNode7 === void 0 ? void 0 : _latestActiveNode7.nodeType,
-        nodeViewPortalProviderAPI: nodeViewPortalProviderAPI,
-        rootPos: (_latestActiveNode8 = latestActiveNode) === null || _latestActiveNode8 === void 0 ? void 0 : _latestActiveNode8.rootPos,
-        rootAnchorName: (_latestActiveNode9 = latestActiveNode) === null || _latestActiveNode9 === void 0 ? void 0 : _latestActiveNode9.rootAnchorName,
-        rootNodeType: (_latestActiveNode0 = latestActiveNode) === null || _latestActiveNode0 === void 0 ? void 0 : _latestActiveNode0.rootNodeType,
-        anchorRectCache: anchorRectCache,
-        editorState: newState
-      });
-      decorations = decorations.add(newState.doc, [quickInsertButton]);
+    flags.toolbarFlagsEnabled && (!rightSideControlsEnabled || !isViewMode)) {
+      var _latestActiveNode1;
+      if (quickInsertButtonEnabled) {
+        var _activeNode13, _activeNode14, _latestActiveNode6, _latestActiveNode7, _latestActiveNode8, _latestActiveNode9, _latestActiveNode0;
+        var _oldQuickInsertButton = (0, _decorationsQuickInsertButton.findQuickInsertInsertButtonDecoration)(decorations, (_activeNode13 = activeNode) === null || _activeNode13 === void 0 ? void 0 : _activeNode13.rootPos, (_activeNode14 = activeNode) === null || _activeNode14 === void 0 ? void 0 : _activeNode14.rootPos);
+        decorations = decorations.remove(_oldQuickInsertButton);
+        var quickInsertButton = (0, _decorationsQuickInsertButton.quickInsertButtonDecoration)({
+          api: api,
+          formatMessage: formatMessage,
+          anchorName: (_latestActiveNode6 = latestActiveNode) === null || _latestActiveNode6 === void 0 ? void 0 : _latestActiveNode6.anchorName,
+          nodeType: (_latestActiveNode7 = latestActiveNode) === null || _latestActiveNode7 === void 0 ? void 0 : _latestActiveNode7.nodeType,
+          nodeViewPortalProviderAPI: nodeViewPortalProviderAPI,
+          rootPos: (_latestActiveNode8 = latestActiveNode) === null || _latestActiveNode8 === void 0 ? void 0 : _latestActiveNode8.rootPos,
+          rootAnchorName: (_latestActiveNode9 = latestActiveNode) === null || _latestActiveNode9 === void 0 ? void 0 : _latestActiveNode9.rootAnchorName,
+          rootNodeType: (_latestActiveNode0 = latestActiveNode) === null || _latestActiveNode0 === void 0 ? void 0 : _latestActiveNode0.rootNodeType,
+          anchorRectCache: anchorRectCache,
+          editorState: newState
+        });
+        decorations = decorations.add(newState.doc, [quickInsertButton]);
+      }
 
       // Update quick insert node decoration when the quick insert button is recreated but
       // the drag handle was NOT recreated (shouldRecreateHandle was false). When

package/dist/cjs/ui/block-controls-left-surface.compiled.css

@@ -1,4 +1,6 @@
-._zulpv77o{gap:var(--ds-space-025,2px)}._1e0c1txw{display:flex}
+._zulpv77o{gap:var(--ds-space-025,2px)}._154iu2gc{top:var(--ds-space-100,8px)}
+._1e0c1txw{display:flex}
 ._1pbyb4wl{z-index:100}
 ._4cvr1h6o{align-items:center}
+._kqsw1if8{position:sticky}
 ._kqswstnw{position:absolute}

package/dist/cjs/ui/block-controls-left-surface.js

@@ -12,7 +12,14 @@ var _react = _interopRequireDefault(require("react"));
 var _surfaceKeys = require("@atlaskit/editor-common/block-controls/surface-keys");
 var _surfaceRenderer = require("@atlaskit/editor-ui-control-model/surface-renderer");
 var _visibilityContainer = require("./visibility-container");
-var leftSurfaceStyles = null;
+var leftSurfaceOuterStyles = null;
+var leftSurfaceRowStyles = null;
+
+// Applied in addition to leftSurfaceRowStyles when the target node is sticky-eligible (e.g. long
+// tables): the outer wrapper spans the node's full height (see `placement.height`), so the content
+// can stick near the top of the viewport instead of scrolling off with the node's top edge.
+// Keep in sync with STICKY_CONTROLS_TOP_MARGIN in ./consts (must be a static literal here).
+var leftSurfaceStickyStyles = null;
 /** Renders one left block-controls surface at a document position. */
 var BlockControlsLeftSurface = exports.BlockControlsLeftSurface = function BlockControlsLeftSurface(_ref) {
   var api = _ref.api,
@@ -29,17 +36,20 @@ var BlockControlsLeftSurface = exports.BlockControlsLeftSurface = function Block
     surface: _surfaceKeys.BLOCK_CONTROLS_LEFT_SURFACE,
     surfaceContext: surfaceContext
   });
+  var isSticky = placement.height !== undefined;
   return /*#__PURE__*/_react.default.createElement("div", {
     "data-editor-block-controls-surface": true,
     "data-testid": source === 'stored' ? 'block-controls-left-surface-stored' : source === 'active' ? 'block-controls-left-surface-active' : 'block-controls-left-surface'
     // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Placement is resolved from the target node's runtime DOM geometry.
     ,
     style: placement,
-    className: (0, _runtime.ax)(["_zulpv77o _4cvr1h6o _1e0c1txw _kqswstnw _1pbyb4wl"])
+    className: (0, _runtime.ax)(["_kqswstnw _1pbyb4wl"])
+  }, /*#__PURE__*/_react.default.createElement("div", {
+    className: (0, _runtime.ax)(["_zulpv77o _4cvr1h6o _1e0c1txw", isSticky && "_kqsw1if8 _154iu2gc"])
   }, /*#__PURE__*/_react.default.createElement(_visibilityContainer.VisibilityContainer, {
     api: api,
     controlSide: "left",
     forceVisibleOnMouseOut: forceVisibleOnMouseOut,
     shouldUseDisplayContents: true
-  }, surface));
+  }, surface)));
 };

package/dist/cjs/ui/block-controls-right-surface.compiled.css

@@ -1,4 +1,6 @@
-._zulpv77o{gap:var(--ds-space-025,2px)}._1e0c1txw{display:flex}
+._zulpv77o{gap:var(--ds-space-025,2px)}._154iu2gc{top:var(--ds-space-100,8px)}
+._1e0c1txw{display:flex}
 ._1pbyb4wl{z-index:100}
 ._4cvr1h6o{align-items:center}
+._kqsw1if8{position:sticky}
 ._kqswstnw{position:absolute}

package/dist/cjs/ui/block-controls-right-surface.js

@@ -12,7 +12,14 @@ var _react = _interopRequireDefault(require("react"));
 var _surfaceKeys = require("@atlaskit/editor-common/block-controls/surface-keys");
 var _surfaceRenderer = require("@atlaskit/editor-ui-control-model/surface-renderer");
 var _visibilityContainer = require("./visibility-container");
-var rightSurfaceStyles = null;
+var rightSurfaceOuterStyles = null;
+var rightSurfaceRowStyles = null;
+
+// Applied in addition to rightSurfaceRowStyles when the target node is sticky-eligible (e.g. long
+// tables): the outer wrapper spans the node's full height (see `placement.height`), so the content
+// can stick near the top of the viewport instead of scrolling off with the node's top edge.
+// Keep in sync with STICKY_CONTROLS_TOP_MARGIN in ./consts (must be a static literal here).
+var rightSurfaceStickyStyles = null;
 /** Renders one right block-controls surface at a document position. */
 var BlockControlsRightSurface = exports.BlockControlsRightSurface = function BlockControlsRightSurface(_ref) {
   var api = _ref.api,
@@ -29,17 +36,20 @@ var BlockControlsRightSurface = exports.BlockControlsRightSurface = function Blo
     surface: _surfaceKeys.BLOCK_CONTROLS_RIGHT_SURFACE,
     surfaceContext: surfaceContext
   });
+  var isSticky = placement.height !== undefined;
   return /*#__PURE__*/_react.default.createElement("div", {
     "data-editor-block-controls-surface": true,
     "data-testid": source === 'stored' ? 'block-controls-right-surface-stored' : source === 'active' ? 'block-controls-right-surface-active' : 'block-controls-right-surface'
     // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Placement is resolved from the target node's runtime DOM geometry.
     ,
     style: placement,
-    className: (0, _runtime.ax)(["_zulpv77o _4cvr1h6o _1e0c1txw _kqswstnw _1pbyb4wl"])
+    className: (0, _runtime.ax)(["_kqswstnw _1pbyb4wl"])
+  }, /*#__PURE__*/_react.default.createElement("div", {
+    className: (0, _runtime.ax)(["_zulpv77o _4cvr1h6o _1e0c1txw", isSticky && "_kqsw1if8 _154iu2gc"])
   }, /*#__PURE__*/_react.default.createElement(_visibilityContainer.VisibilityContainer, {
     api: api,
     controlSide: "right",
     forceVisibleOnMouseOut: forceVisibleOnMouseOut,
     shouldUseDisplayContents: true
-  }, surface));
+  }, surface)));
 };

package/dist/cjs/ui/utils/get-surface-placement.js

@@ -6,6 +6,7 @@ Object.defineProperty(exports, "__esModule", {
 });
 exports.getSurfacePlacement = exports.getAbsoluteSurfacePlacement = void 0;
 var _defineProperty2 = _interopRequireDefault(require("@babel/runtime/helpers/defineProperty"));
+var _dragHandlePositions = require("../../pm-plugins/utils/drag-handle-positions");
 var _consts = require("../consts");
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { (0, _defineProperty2.default)(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
@@ -48,13 +49,16 @@ var getSurfacePlacement = exports.getSurfacePlacement = function getSurfacePlace
   }
   var gap = (0, _consts.dragHandleGap)(nodeType, parentNodeType);
   var top = nodeRect.top + (0, _consts.topPositionAdjustment)(nodeTypeWithLevel, layout);
+  var height = (0, _dragHandlePositions.shouldBeSticky)(nodeType) ? nodeRect.height : undefined;
   return side === 'right' ? {
     left: nodeRect.right + gap,
     top: top,
-    transform: ''
+    transform: '',
+    height: height
   } : {
     left: nodeRect.left,
     top: top,
-    transform: "translateX(calc(-100% - ".concat(gap, "px))")
+    transform: "translateX(calc(-100% - ".concat(gap, "px))"),
+    height: height
   };
 };

package/dist/es2019/pm-plugins/main.js

@@ -455,11 +455,16 @@ export const apply = (api, formatMessage, tr, currentState, newState, flags, nod
       const oldActiveQuickInsertDec = findActiveQuickInsertNodeDec(decorations, 0, newState.doc.content.size);
       decorations = decorations.remove(oldActiveQuickInsertDec);
     }
-    // platform_editor_controls note: enables quick insert
-    if (flags.toolbarFlagsEnabled && quickInsertButtonEnabled) {
-      var _activeNode7, _activeNode8;
-      const oldQuickInsertButton = findQuickInsertInsertButtonDecoration(decorations, (_activeNode7 = activeNode) === null || _activeNode7 === void 0 ? void 0 : _activeNode7.rootPos, (_activeNode8 = activeNode) === null || _activeNode8 === void 0 ? void 0 : _activeNode8.rootPos);
-      decorations = decorations.remove(oldQuickInsertButton);
+    // nodeDecorationRegistry cleanup (e.g. the legacy Remix button) is independent of the legacy
+    // quick-insert button, so this must not be gated by quickInsertButtonEnabled — otherwise a
+    // stale decoration is left behind whenever platform_editor_block_control_migration is on.
+    if (flags.toolbarFlagsEnabled) {
+      // platform_editor_controls note: enables quick insert
+      if (quickInsertButtonEnabled) {
+        var _activeNode7, _activeNode8;
+        const oldQuickInsertButton = findQuickInsertInsertButtonDecoration(decorations, (_activeNode7 = activeNode) === null || _activeNode7 === void 0 ? void 0 : _activeNode7.rootPos, (_activeNode8 = activeNode) === null || _activeNode8 === void 0 ? void 0 : _activeNode8.rootPos);
+        decorations = decorations.remove(oldQuickInsertButton);
+      }
       for (const factory of nodeDecorationRegistry) {
         var _activeNode9, _activeNode0;
         const old = decorations.find((_activeNode9 = activeNode) === null || _activeNode9 === void 0 ? void 0 : _activeNode9.rootPos, (_activeNode0 = activeNode) === null || _activeNode0 === void 0 ? void 0 : _activeNode0.rootPos, spec => spec.type === factory.type);
@@ -495,7 +500,11 @@ export const apply = (api, formatMessage, tr, currentState, newState, flags, nod
       });
       decorations = decorations.add(newState.doc, [handleDec]);
     }
-    if (flags.legacyDragHandleEnabled && expValEquals('platform_editor_controls_reliable_anchor', 'isEnabled', true) && latestActiveNode) {
+    if ((flags.legacyDragHandleEnabled ||
+    // nodeDecorationRegistry consumers (e.g. the legacy Remix button) rely
+    // on that same anchor-name for their own CSS anchor() positioning, so this must still run
+    // when such a consumer exists even if the legacy drag handle itself is disabled.
+    nodeDecorationRegistry.length > 0) && expValEquals('platform_editor_controls_reliable_anchor', 'isEnabled', true) && latestActiveNode) {
       // Recreate the drag handle node decoration when the active node changed,
       // its content was modified, or the document changed (e.g. Enter splits a node).
       // This runs independently of shouldRecreateHandle so that doc changes (like pressing
@@ -545,23 +554,26 @@ export const apply = (api, formatMessage, tr, currentState, newState, flags, nod
     }
     if (shouldRecreateQuickInsertButton && ((_latestActiveNode5 = latestActiveNode) === null || _latestActiveNode5 === void 0 ? void 0 : _latestActiveNode5.rootPos) !== undefined &&
     // platform_editor_controls note: enables quick insert
-    flags.toolbarFlagsEnabled && quickInsertButtonEnabled && (!rightSideControlsEnabled || !isViewMode)) {
-      var _activeNode13, _activeNode14, _latestActiveNode6, _latestActiveNode7, _latestActiveNode8, _latestActiveNode9, _latestActiveNode0, _latestActiveNode1;
-      const oldQuickInsertButton = findQuickInsertInsertButtonDecoration(decorations, (_activeNode13 = activeNode) === null || _activeNode13 === void 0 ? void 0 : _activeNode13.rootPos, (_activeNode14 = activeNode) === null || _activeNode14 === void 0 ? void 0 : _activeNode14.rootPos);
-      decorations = decorations.remove(oldQuickInsertButton);
-      const quickInsertButton = quickInsertButtonDecoration({
-        api,
-        formatMessage,
-        anchorName: (_latestActiveNode6 = latestActiveNode) === null || _latestActiveNode6 === void 0 ? void 0 : _latestActiveNode6.anchorName,
-        nodeType: (_latestActiveNode7 = latestActiveNode) === null || _latestActiveNode7 === void 0 ? void 0 : _latestActiveNode7.nodeType,
-        nodeViewPortalProviderAPI,
-        rootPos: (_latestActiveNode8 = latestActiveNode) === null || _latestActiveNode8 === void 0 ? void 0 : _latestActiveNode8.rootPos,
-        rootAnchorName: (_latestActiveNode9 = latestActiveNode) === null || _latestActiveNode9 === void 0 ? void 0 : _latestActiveNode9.rootAnchorName,
-        rootNodeType: (_latestActiveNode0 = latestActiveNode) === null || _latestActiveNode0 === void 0 ? void 0 : _latestActiveNode0.rootNodeType,
-        anchorRectCache,
-        editorState: newState
-      });
-      decorations = decorations.add(newState.doc, [quickInsertButton]);
+    flags.toolbarFlagsEnabled && (!rightSideControlsEnabled || !isViewMode)) {
+      var _latestActiveNode1;
+      if (quickInsertButtonEnabled) {
+        var _activeNode13, _activeNode14, _latestActiveNode6, _latestActiveNode7, _latestActiveNode8, _latestActiveNode9, _latestActiveNode0;
+        const oldQuickInsertButton = findQuickInsertInsertButtonDecoration(decorations, (_activeNode13 = activeNode) === null || _activeNode13 === void 0 ? void 0 : _activeNode13.rootPos, (_activeNode14 = activeNode) === null || _activeNode14 === void 0 ? void 0 : _activeNode14.rootPos);
+        decorations = decorations.remove(oldQuickInsertButton);
+        const quickInsertButton = quickInsertButtonDecoration({
+          api,
+          formatMessage,
+          anchorName: (_latestActiveNode6 = latestActiveNode) === null || _latestActiveNode6 === void 0 ? void 0 : _latestActiveNode6.anchorName,
+          nodeType: (_latestActiveNode7 = latestActiveNode) === null || _latestActiveNode7 === void 0 ? void 0 : _latestActiveNode7.nodeType,
+          nodeViewPortalProviderAPI,
+          rootPos: (_latestActiveNode8 = latestActiveNode) === null || _latestActiveNode8 === void 0 ? void 0 : _latestActiveNode8.rootPos,
+          rootAnchorName: (_latestActiveNode9 = latestActiveNode) === null || _latestActiveNode9 === void 0 ? void 0 : _latestActiveNode9.rootAnchorName,
+          rootNodeType: (_latestActiveNode0 = latestActiveNode) === null || _latestActiveNode0 === void 0 ? void 0 : _latestActiveNode0.rootNodeType,
+          anchorRectCache,
+          editorState: newState
+        });
+        decorations = decorations.add(newState.doc, [quickInsertButton]);
+      }
 
       // Update quick insert node decoration when the quick insert button is recreated but
       // the drag handle was NOT recreated (shouldRecreateHandle was false). When

package/dist/es2019/ui/block-controls-left-surface.compiled.css

@@ -1,4 +1,6 @@
-._zulpv77o{gap:var(--ds-space-025,2px)}._1e0c1txw{display:flex}
+._zulpv77o{gap:var(--ds-space-025,2px)}._154iu2gc{top:var(--ds-space-100,8px)}
+._1e0c1txw{display:flex}
 ._1pbyb4wl{z-index:100}
 ._4cvr1h6o{align-items:center}
+._kqsw1if8{position:sticky}
 ._kqswstnw{position:absolute}

package/dist/es2019/ui/block-controls-left-surface.js

@@ -5,7 +5,14 @@ import React from 'react';
 import { BLOCK_CONTROLS_LEFT_SURFACE } from '@atlaskit/editor-common/block-controls/surface-keys';
 import { SurfaceRenderer, willSurfaceRender } from '@atlaskit/editor-ui-control-model/surface-renderer';
 import { VisibilityContainer } from './visibility-container';
-const leftSurfaceStyles = null;
+const leftSurfaceOuterStyles = null;
+const leftSurfaceRowStyles = null;
+
+// Applied in addition to leftSurfaceRowStyles when the target node is sticky-eligible (e.g. long
+// tables): the outer wrapper spans the node's full height (see `placement.height`), so the content
+// can stick near the top of the viewport instead of scrolling off with the node's top edge.
+// Keep in sync with STICKY_CONTROLS_TOP_MARGIN in ./consts (must be a static literal here).
+const leftSurfaceStickyStyles = null;
 /** Renders one left block-controls surface at a document position. */
 export const BlockControlsLeftSurface = ({
   api,
@@ -23,17 +30,20 @@ export const BlockControlsLeftSurface = ({
     surface: BLOCK_CONTROLS_LEFT_SURFACE,
     surfaceContext: surfaceContext
   });
+  const isSticky = placement.height !== undefined;
   return /*#__PURE__*/React.createElement("div", {
     "data-editor-block-controls-surface": true,
     "data-testid": source === 'stored' ? 'block-controls-left-surface-stored' : source === 'active' ? 'block-controls-left-surface-active' : 'block-controls-left-surface'
     // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Placement is resolved from the target node's runtime DOM geometry.
     ,
     style: placement,
-    className: ax(["_zulpv77o _4cvr1h6o _1e0c1txw _kqswstnw _1pbyb4wl"])
+    className: ax(["_kqswstnw _1pbyb4wl"])
+  }, /*#__PURE__*/React.createElement("div", {
+    className: ax(["_zulpv77o _4cvr1h6o _1e0c1txw", isSticky && "_kqsw1if8 _154iu2gc"])
   }, /*#__PURE__*/React.createElement(VisibilityContainer, {
     api: api,
     controlSide: "left",
     forceVisibleOnMouseOut: forceVisibleOnMouseOut,
     shouldUseDisplayContents: true
-  }, surface));
+  }, surface)));
 };

package/dist/es2019/ui/block-controls-right-surface.compiled.css

@@ -1,4 +1,6 @@
-._zulpv77o{gap:var(--ds-space-025,2px)}._1e0c1txw{display:flex}
+._zulpv77o{gap:var(--ds-space-025,2px)}._154iu2gc{top:var(--ds-space-100,8px)}
+._1e0c1txw{display:flex}
 ._1pbyb4wl{z-index:100}
 ._4cvr1h6o{align-items:center}
+._kqsw1if8{position:sticky}
 ._kqswstnw{position:absolute}

package/dist/es2019/ui/block-controls-right-surface.js

@@ -5,7 +5,14 @@ import React from 'react';
 import { BLOCK_CONTROLS_RIGHT_SURFACE } from '@atlaskit/editor-common/block-controls/surface-keys';
 import { SurfaceRenderer, willSurfaceRender } from '@atlaskit/editor-ui-control-model/surface-renderer';
 import { VisibilityContainer } from './visibility-container';
-const rightSurfaceStyles = null;
+const rightSurfaceOuterStyles = null;
+const rightSurfaceRowStyles = null;
+
+// Applied in addition to rightSurfaceRowStyles when the target node is sticky-eligible (e.g. long
+// tables): the outer wrapper spans the node's full height (see `placement.height`), so the content
+// can stick near the top of the viewport instead of scrolling off with the node's top edge.
+// Keep in sync with STICKY_CONTROLS_TOP_MARGIN in ./consts (must be a static literal here).
+const rightSurfaceStickyStyles = null;
 /** Renders one right block-controls surface at a document position. */
 export const BlockControlsRightSurface = ({
   api,
@@ -23,17 +30,20 @@ export const BlockControlsRightSurface = ({
     surface: BLOCK_CONTROLS_RIGHT_SURFACE,
     surfaceContext: surfaceContext
   });
+  const isSticky = placement.height !== undefined;
   return /*#__PURE__*/React.createElement("div", {
     "data-editor-block-controls-surface": true,
     "data-testid": source === 'stored' ? 'block-controls-right-surface-stored' : source === 'active' ? 'block-controls-right-surface-active' : 'block-controls-right-surface'
     // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Placement is resolved from the target node's runtime DOM geometry.
     ,
     style: placement,
-    className: ax(["_zulpv77o _4cvr1h6o _1e0c1txw _kqswstnw _1pbyb4wl"])
+    className: ax(["_kqswstnw _1pbyb4wl"])
+  }, /*#__PURE__*/React.createElement("div", {
+    className: ax(["_zulpv77o _4cvr1h6o _1e0c1txw", isSticky && "_kqsw1if8 _154iu2gc"])
   }, /*#__PURE__*/React.createElement(VisibilityContainer, {
     api: api,
     controlSide: "right",
     forceVisibleOnMouseOut: forceVisibleOnMouseOut,
     shouldUseDisplayContents: true
-  }, surface));
+  }, surface)));
 };

package/dist/es2019/ui/utils/get-surface-placement.js

@@ -1,3 +1,4 @@
+import { shouldBeSticky } from '../../pm-plugins/utils/drag-handle-positions';
 import { dragHandleGap, topPositionAdjustment } from '../consts';
 export const getAbsoluteSurfacePlacement = ({
   offsetParentRect,
@@ -41,13 +42,16 @@ export const getSurfacePlacement = ({
   }
   const gap = dragHandleGap(nodeType, parentNodeType);
   const top = nodeRect.top + topPositionAdjustment(nodeTypeWithLevel, layout);
+  const height = shouldBeSticky(nodeType) ? nodeRect.height : undefined;
   return side === 'right' ? {
     left: nodeRect.right + gap,
     top,
-    transform: ''
+    transform: '',
+    height
   } : {
     left: nodeRect.left,
     top,
-    transform: `translateX(calc(-100% - ${gap}px))`
+    transform: `translateX(calc(-100% - ${gap}px))`,
+    height
   };
 };

package/dist/esm/pm-plugins/main.js

@@ -460,11 +460,16 @@ var _apply = function apply(api, formatMessage, tr, currentState, newState, flag
       var oldActiveQuickInsertDec = findActiveQuickInsertNodeDec(decorations, 0, newState.doc.content.size);
       decorations = decorations.remove(oldActiveQuickInsertDec);
     }
-    // platform_editor_controls note: enables quick insert
-    if (flags.toolbarFlagsEnabled && quickInsertButtonEnabled) {
-      var _activeNode7, _activeNode8;
-      var oldQuickInsertButton = findQuickInsertInsertButtonDecoration(decorations, (_activeNode7 = activeNode) === null || _activeNode7 === void 0 ? void 0 : _activeNode7.rootPos, (_activeNode8 = activeNode) === null || _activeNode8 === void 0 ? void 0 : _activeNode8.rootPos);
-      decorations = decorations.remove(oldQuickInsertButton);
+    // nodeDecorationRegistry cleanup (e.g. the legacy Remix button) is independent of the legacy
+    // quick-insert button, so this must not be gated by quickInsertButtonEnabled — otherwise a
+    // stale decoration is left behind whenever platform_editor_block_control_migration is on.
+    if (flags.toolbarFlagsEnabled) {
+      // platform_editor_controls note: enables quick insert
+      if (quickInsertButtonEnabled) {
+        var _activeNode7, _activeNode8;
+        var oldQuickInsertButton = findQuickInsertInsertButtonDecoration(decorations, (_activeNode7 = activeNode) === null || _activeNode7 === void 0 ? void 0 : _activeNode7.rootPos, (_activeNode8 = activeNode) === null || _activeNode8 === void 0 ? void 0 : _activeNode8.rootPos);
+        decorations = decorations.remove(oldQuickInsertButton);
+      }
       var _iterator = _createForOfIteratorHelper(nodeDecorationRegistry),
         _step;
       try {
@@ -528,7 +533,11 @@ var _apply = function apply(api, formatMessage, tr, currentState, newState, flag
       });
       decorations = decorations.add(newState.doc, [handleDec]);
     }
-    if (flags.legacyDragHandleEnabled && expValEquals('platform_editor_controls_reliable_anchor', 'isEnabled', true) && latestActiveNode) {
+    if ((flags.legacyDragHandleEnabled ||
+    // nodeDecorationRegistry consumers (e.g. the legacy Remix button) rely
+    // on that same anchor-name for their own CSS anchor() positioning, so this must still run
+    // when such a consumer exists even if the legacy drag handle itself is disabled.
+    nodeDecorationRegistry.length > 0) && expValEquals('platform_editor_controls_reliable_anchor', 'isEnabled', true) && latestActiveNode) {
       // Recreate the drag handle node decoration when the active node changed,
       // its content was modified, or the document changed (e.g. Enter splits a node).
       // This runs independently of shouldRecreateHandle so that doc changes (like pressing
@@ -578,23 +587,26 @@ var _apply = function apply(api, formatMessage, tr, currentState, newState, flag
     }
     if (shouldRecreateQuickInsertButton && ((_latestActiveNode5 = latestActiveNode) === null || _latestActiveNode5 === void 0 ? void 0 : _latestActiveNode5.rootPos) !== undefined &&
     // platform_editor_controls note: enables quick insert
-    flags.toolbarFlagsEnabled && quickInsertButtonEnabled && (!rightSideControlsEnabled || !isViewMode)) {
-      var _activeNode13, _activeNode14, _latestActiveNode6, _latestActiveNode7, _latestActiveNode8, _latestActiveNode9, _latestActiveNode0, _latestActiveNode1;
-      var _oldQuickInsertButton = findQuickInsertInsertButtonDecoration(decorations, (_activeNode13 = activeNode) === null || _activeNode13 === void 0 ? void 0 : _activeNode13.rootPos, (_activeNode14 = activeNode) === null || _activeNode14 === void 0 ? void 0 : _activeNode14.rootPos);
-      decorations = decorations.remove(_oldQuickInsertButton);
-      var quickInsertButton = quickInsertButtonDecoration({
-        api: api,
-        formatMessage: formatMessage,
-        anchorName: (_latestActiveNode6 = latestActiveNode) === null || _latestActiveNode6 === void 0 ? void 0 : _latestActiveNode6.anchorName,
-        nodeType: (_latestActiveNode7 = latestActiveNode) === null || _latestActiveNode7 === void 0 ? void 0 : _latestActiveNode7.nodeType,
-        nodeViewPortalProviderAPI: nodeViewPortalProviderAPI,
-        rootPos: (_latestActiveNode8 = latestActiveNode) === null || _latestActiveNode8 === void 0 ? void 0 : _latestActiveNode8.rootPos,
-        rootAnchorName: (_latestActiveNode9 = latestActiveNode) === null || _latestActiveNode9 === void 0 ? void 0 : _latestActiveNode9.rootAnchorName,
-        rootNodeType: (_latestActiveNode0 = latestActiveNode) === null || _latestActiveNode0 === void 0 ? void 0 : _latestActiveNode0.rootNodeType,
-        anchorRectCache: anchorRectCache,
-        editorState: newState
-      });
-      decorations = decorations.add(newState.doc, [quickInsertButton]);
+    flags.toolbarFlagsEnabled && (!rightSideControlsEnabled || !isViewMode)) {
+      var _latestActiveNode1;
+      if (quickInsertButtonEnabled) {
+        var _activeNode13, _activeNode14, _latestActiveNode6, _latestActiveNode7, _latestActiveNode8, _latestActiveNode9, _latestActiveNode0;
+        var _oldQuickInsertButton = findQuickInsertInsertButtonDecoration(decorations, (_activeNode13 = activeNode) === null || _activeNode13 === void 0 ? void 0 : _activeNode13.rootPos, (_activeNode14 = activeNode) === null || _activeNode14 === void 0 ? void 0 : _activeNode14.rootPos);
+        decorations = decorations.remove(_oldQuickInsertButton);
+        var quickInsertButton = quickInsertButtonDecoration({
+          api: api,
+          formatMessage: formatMessage,
+          anchorName: (_latestActiveNode6 = latestActiveNode) === null || _latestActiveNode6 === void 0 ? void 0 : _latestActiveNode6.anchorName,
+          nodeType: (_latestActiveNode7 = latestActiveNode) === null || _latestActiveNode7 === void 0 ? void 0 : _latestActiveNode7.nodeType,
+          nodeViewPortalProviderAPI: nodeViewPortalProviderAPI,
+          rootPos: (_latestActiveNode8 = latestActiveNode) === null || _latestActiveNode8 === void 0 ? void 0 : _latestActiveNode8.rootPos,
+          rootAnchorName: (_latestActiveNode9 = latestActiveNode) === null || _latestActiveNode9 === void 0 ? void 0 : _latestActiveNode9.rootAnchorName,
+          rootNodeType: (_latestActiveNode0 = latestActiveNode) === null || _latestActiveNode0 === void 0 ? void 0 : _latestActiveNode0.rootNodeType,
+          anchorRectCache: anchorRectCache,
+          editorState: newState
+        });
+        decorations = decorations.add(newState.doc, [quickInsertButton]);
+      }
 
       // Update quick insert node decoration when the quick insert button is recreated but
       // the drag handle was NOT recreated (shouldRecreateHandle was false). When

package/dist/esm/ui/block-controls-left-surface.compiled.css

@@ -1,4 +1,6 @@
-._zulpv77o{gap:var(--ds-space-025,2px)}._1e0c1txw{display:flex}
+._zulpv77o{gap:var(--ds-space-025,2px)}._154iu2gc{top:var(--ds-space-100,8px)}
+._1e0c1txw{display:flex}
 ._1pbyb4wl{z-index:100}
 ._4cvr1h6o{align-items:center}
+._kqsw1if8{position:sticky}
 ._kqswstnw{position:absolute}

package/dist/esm/ui/block-controls-left-surface.js

@@ -5,7 +5,14 @@ import React from 'react';
 import { BLOCK_CONTROLS_LEFT_SURFACE } from '@atlaskit/editor-common/block-controls/surface-keys';
 import { SurfaceRenderer, willSurfaceRender } from '@atlaskit/editor-ui-control-model/surface-renderer';
 import { VisibilityContainer } from './visibility-container';
-var leftSurfaceStyles = null;
+var leftSurfaceOuterStyles = null;
+var leftSurfaceRowStyles = null;
+
+// Applied in addition to leftSurfaceRowStyles when the target node is sticky-eligible (e.g. long
+// tables): the outer wrapper spans the node's full height (see `placement.height`), so the content
+// can stick near the top of the viewport instead of scrolling off with the node's top edge.
+// Keep in sync with STICKY_CONTROLS_TOP_MARGIN in ./consts (must be a static literal here).
+var leftSurfaceStickyStyles = null;
 /** Renders one left block-controls surface at a document position. */
 export var BlockControlsLeftSurface = function BlockControlsLeftSurface(_ref) {
   var api = _ref.api,
@@ -22,17 +29,20 @@ export var BlockControlsLeftSurface = function BlockControlsLeftSurface(_ref) {
     surface: BLOCK_CONTROLS_LEFT_SURFACE,
     surfaceContext: surfaceContext
   });
+  var isSticky = placement.height !== undefined;
   return /*#__PURE__*/React.createElement("div", {
     "data-editor-block-controls-surface": true,
     "data-testid": source === 'stored' ? 'block-controls-left-surface-stored' : source === 'active' ? 'block-controls-left-surface-active' : 'block-controls-left-surface'
     // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Placement is resolved from the target node's runtime DOM geometry.
     ,
     style: placement,
-    className: ax(["_zulpv77o _4cvr1h6o _1e0c1txw _kqswstnw _1pbyb4wl"])
+    className: ax(["_kqswstnw _1pbyb4wl"])
+  }, /*#__PURE__*/React.createElement("div", {
+    className: ax(["_zulpv77o _4cvr1h6o _1e0c1txw", isSticky && "_kqsw1if8 _154iu2gc"])
   }, /*#__PURE__*/React.createElement(VisibilityContainer, {
     api: api,
     controlSide: "left",
     forceVisibleOnMouseOut: forceVisibleOnMouseOut,
     shouldUseDisplayContents: true
-  }, surface));
+  }, surface)));
 };

package/dist/esm/ui/block-controls-right-surface.compiled.css

@@ -1,4 +1,6 @@
-._zulpv77o{gap:var(--ds-space-025,2px)}._1e0c1txw{display:flex}
+._zulpv77o{gap:var(--ds-space-025,2px)}._154iu2gc{top:var(--ds-space-100,8px)}
+._1e0c1txw{display:flex}
 ._1pbyb4wl{z-index:100}
 ._4cvr1h6o{align-items:center}
+._kqsw1if8{position:sticky}
 ._kqswstnw{position:absolute}

package/dist/esm/ui/block-controls-right-surface.js

@@ -5,7 +5,14 @@ import React from 'react';
 import { BLOCK_CONTROLS_RIGHT_SURFACE } from '@atlaskit/editor-common/block-controls/surface-keys';
 import { SurfaceRenderer, willSurfaceRender } from '@atlaskit/editor-ui-control-model/surface-renderer';
 import { VisibilityContainer } from './visibility-container';
-var rightSurfaceStyles = null;
+var rightSurfaceOuterStyles = null;
+var rightSurfaceRowStyles = null;
+
+// Applied in addition to rightSurfaceRowStyles when the target node is sticky-eligible (e.g. long
+// tables): the outer wrapper spans the node's full height (see `placement.height`), so the content
+// can stick near the top of the viewport instead of scrolling off with the node's top edge.
+// Keep in sync with STICKY_CONTROLS_TOP_MARGIN in ./consts (must be a static literal here).
+var rightSurfaceStickyStyles = null;
 /** Renders one right block-controls surface at a document position. */
 export var BlockControlsRightSurface = function BlockControlsRightSurface(_ref) {
   var api = _ref.api,
@@ -22,17 +29,20 @@ export var BlockControlsRightSurface = function BlockControlsRightSurface(_ref)
     surface: BLOCK_CONTROLS_RIGHT_SURFACE,
     surfaceContext: surfaceContext
   });
+  var isSticky = placement.height !== undefined;
   return /*#__PURE__*/React.createElement("div", {
     "data-editor-block-controls-surface": true,
     "data-testid": source === 'stored' ? 'block-controls-right-surface-stored' : source === 'active' ? 'block-controls-right-surface-active' : 'block-controls-right-surface'
     // eslint-disable-next-line @atlaskit/ui-styling-standard/enforce-style-prop -- Placement is resolved from the target node's runtime DOM geometry.
     ,
     style: placement,
-    className: ax(["_zulpv77o _4cvr1h6o _1e0c1txw _kqswstnw _1pbyb4wl"])
+    className: ax(["_kqswstnw _1pbyb4wl"])
+  }, /*#__PURE__*/React.createElement("div", {
+    className: ax(["_zulpv77o _4cvr1h6o _1e0c1txw", isSticky && "_kqsw1if8 _154iu2gc"])
   }, /*#__PURE__*/React.createElement(VisibilityContainer, {
     api: api,
     controlSide: "right",
     forceVisibleOnMouseOut: forceVisibleOnMouseOut,
     shouldUseDisplayContents: true
-  }, surface));
+  }, surface)));
 };

package/dist/esm/ui/utils/get-surface-placement.js

@@ -1,6 +1,7 @@
 import _defineProperty from "@babel/runtime/helpers/defineProperty";
 function ownKeys(e, r) { var t = Object.keys(e); if (Object.getOwnPropertySymbols) { var o = Object.getOwnPropertySymbols(e); r && (o = o.filter(function (r) { return Object.getOwnPropertyDescriptor(e, r).enumerable; })), t.push.apply(t, o); } return t; }
 function _objectSpread(e) { for (var r = 1; r < arguments.length; r++) { var t = null != arguments[r] ? arguments[r] : {}; r % 2 ? ownKeys(Object(t), !0).forEach(function (r) { _defineProperty(e, r, t[r]); }) : Object.getOwnPropertyDescriptors ? Object.defineProperties(e, Object.getOwnPropertyDescriptors(t)) : ownKeys(Object(t)).forEach(function (r) { Object.defineProperty(e, r, Object.getOwnPropertyDescriptor(t, r)); }); } return e; }
+import { shouldBeSticky } from '../../pm-plugins/utils/drag-handle-positions';
 import { dragHandleGap, topPositionAdjustment } from '../consts';
 export var getAbsoluteSurfacePlacement = function getAbsoluteSurfacePlacement(_ref) {
   var _offsetParentRect$lef, _offsetParentRect$top;
@@ -41,13 +42,16 @@ export var getSurfacePlacement = function getSurfacePlacement(_ref2) {
   }
   var gap = dragHandleGap(nodeType, parentNodeType);
   var top = nodeRect.top + topPositionAdjustment(nodeTypeWithLevel, layout);
+  var height = shouldBeSticky(nodeType) ? nodeRect.height : undefined;
   return side === 'right' ? {
     left: nodeRect.right + gap,
     top: top,
-    transform: ''
+    transform: '',
+    height: height
   } : {
     left: nodeRect.left,
     top: top,
-    transform: "translateX(calc(-100% - ".concat(gap, "px))")
+    transform: "translateX(calc(-100% - ".concat(gap, "px))"),
+    height: height
   };
 };

package/dist/types/ui/utils/get-surface-placement.d.ts

@@ -1,4 +1,11 @@
 export type SurfacePlacement = {
+    /**
+     * Set only for sticky-eligible node types (long tables, panels, expands, etc.): the target
+     * node's full height. Lets the surface wrapper span the node so its content can use
+     * `position: sticky` to stay in view while the node scrolls, instead of scrolling off-screen
+     * with the node's top edge.
+     */
+    height?: number;
     left: number;
     top: number;
     transform: string;
@@ -6,7 +13,7 @@ export type SurfacePlacement = {
 export type SurfaceSide = 'left' | 'right';
 export type SurfacePlacementOptions = {
     layout: string;
-    nodeRect: Pick<DOMRect, 'left' | 'right' | 'top' | 'width'>;
+    nodeRect: Pick<DOMRect, 'height' | 'left' | 'right' | 'top' | 'width'>;
     nodeType: string;
     nodeTypeWithLevel: string;
     parentNodeType?: string;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-block-controls",
-	"version": "17.3.4",
+	"version": "17.3.6",
 	"description": "Block controls plugin for @atlaskit/editor-core",
 	"author": "Atlassian Pty Ltd",
 	"license": "Apache-2.0",
@@ -55,7 +55,7 @@
 		"@atlaskit/primitives": "^22.5.0",
 		"@atlaskit/section-message": "^10.2.0",
 		"@atlaskit/theme": "^28.2.0",
-		"@atlaskit/tmp-editor-statsig": "^171.0.0",
+		"@atlaskit/tmp-editor-statsig": "^172.0.0",
 		"@atlaskit/tokens": "^16.11.0",
 		"@atlaskit/tooltip": "^24.3.0",
 		"@babel/runtime": "^7.0.0",
@@ -67,7 +67,7 @@
 		"uuid": "^3.1.0"
 	},
 	"peerDependencies": {
-		"@atlaskit/editor-common": "^120.10.0",
+		"@atlaskit/editor-common": "^120.11.0",
 		"react": "^18.2.0 || ^19.2.0",
 		"react-dom": "^18.2.0 || ^19.2.0",
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"