@atlaskit/editor-plugin-table 42.2.9 → 42.3.0

package/CHANGELOG.md

@@ -1,5 +1,18 @@
 # @atlaskit/editor-plugin-table
 
+## 42.3.0
+
+### Minor Changes
+
+- [`e495ce10dcb71`](https://bitbucket.org/atlassian/atlassian-frontend-monorepo/commits/e495ce10dcb71) -
+  [EDITOR-9904] Keep the table cell options button on its header cell when the editor width or the
+  table's column widths change, with the header stuck or not, behind
+  platform_editor_sticky_cell_options_position
+
+### Patch Changes
+
+- Updated dependencies
+
 ## 42.2.9
 
 ### Patch Changes

package/dist/cjs/ui/FloatingContextualButton/FixedButton.js

@@ -28,7 +28,9 @@ var calcObserverTargetMargin = exports.calcObserverTargetMargin = function calcO
   return fixedButtonRect.left - tableWrapperRect.left + scrollLeft;
 };
 var FixedButton = exports.FixedButton = function FixedButton(_ref2) {
-  var children = _ref2.children,
+  var _ref2$cellLayoutVersi = _ref2.cellLayoutVersion,
+    cellLayoutVersion = _ref2$cellLayoutVersi === void 0 ? 0 : _ref2$cellLayoutVersi,
+    children = _ref2.children,
     isContextualMenuOpen = _ref2.isContextualMenuOpen,
     mountTo = _ref2.mountTo,
     offset = _ref2.offset,
@@ -92,10 +94,24 @@ var FixedButton = exports.FixedButton = function FixedButton(_ref2) {
     }
   }, [fixedButtonRef, observerTargetRef, tableWrapper, targetCellPosition, targetCellRef, isContextualMenuOpen]);
   var fixedButtonTop = 0;
+
+  // The left position below is read from the cell's current rect, which already includes the
+  // table's horizontal scroll, so the scroll translation accumulated so far must start again.
+  (0, _react.useLayoutEffect)(function () {
+    var fixedButtonRefCurrent = fixedButtonRef.current;
+    var observerTargetRefCurrent = observerTargetRef.current;
+    if (cellLayoutVersion === 0 || !fixedButtonRefCurrent || !observerTargetRefCurrent) {
+      return;
+    }
+    fixedButtonRefCurrent.style.transform = '';
+    scrollDataRef.current = tableWrapper.scrollLeft;
+    leftPosDataRef.current = 0;
+    observerTargetRefCurrent.style.marginLeft = "".concat(calcObserverTargetMargin(tableWrapper, fixedButtonRefCurrent), "px");
+  }, [cellLayoutVersion, tableWrapper]);
   var containerLeft = (0, _react.useMemo)(function () {
     var container = targetCellRef.closest('[data-editor-container="true"]');
     return (container === null || container === void 0 ? void 0 : container.getBoundingClientRect().left) || 0;
-  }, [targetCellRef]);
+  }, [targetCellRef, cellLayoutVersion]);
   var left = (0, _react.useMemo)(function () {
     var targetCellRect = targetCellRef.getBoundingClientRect();
     var baseLeft = calcLeftPos({
@@ -105,7 +121,7 @@ var FixedButton = exports.FixedButton = function FixedButton(_ref2) {
       offset: offset
     });
     return baseLeft - containerLeft;
-  }, [containerLeft, targetCellRef, offset]);
+  }, [containerLeft, targetCellRef, offset, cellLayoutVersion]);
 
   // Using a portal here to ensure wrapperRef has the tableWrapper as an
   // ancestor. This is required to make the Intersection Observer work.

package/dist/cjs/ui/FloatingContextualButton/index.js

@@ -29,6 +29,7 @@ var _types = require("../../types");
 var _stickyHeaderZIndex = require("../sticky-header-z-index");
 var _FixedButton = _interopRequireDefault(require("./FixedButton"));
 var _styles = require("./styles");
+var _useCellLayoutVersion = require("./useCellLayoutVersion");
 function _interopRequireWildcard(e, t) { if ("function" == typeof WeakMap) var r = new WeakMap(), n = new WeakMap(); return (_interopRequireWildcard = function _interopRequireWildcard(e, t) { if (!t && e && e.__esModule) return e; var o, i, f = { __proto__: null, default: e }; if (null === e || "object" != _typeof(e) && "function" != typeof e) return f; if (o = t ? n : r) { if (o.has(e)) return o.get(e); o.set(e, f); } for (var _t in e) "default" !== _t && {}.hasOwnProperty.call(e, _t) && ((i = (o = Object.defineProperty) && Object.getOwnPropertyDescriptor(e, _t)) && (i.get || i.set) ? o(f, _t, i) : f[_t] = e[_t]); return f; })(e, t); }
 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; } /**
@@ -96,6 +97,9 @@ var FloatingContextualButtonInner = /*#__PURE__*/_react.default.memo(function (p
   };
   var domAtPos = editorView.domAtPos.bind(editorView);
   var targetCellRef = (0, _utils.findDomRefAtPos)(targetCellPosition, domAtPos);
+  // Re-renders this component when the cell may have moved, so both FixedButton and Popup
+  // reposition: Popup recalculates its position whenever it receives new props.
+  var cellLayoutVersion = (0, _useCellLayoutVersion.useCellLayoutVersion)(targetCellRef);
   (0, _react.useEffect)(function () {
     if (isCellMenuOpenByKeyboard && !isCellMenuOpen) {
       var state = editorView.state,
@@ -188,6 +192,7 @@ var FloatingContextualButtonInner = /*#__PURE__*/_react.default.memo(function (p
   }
   if (stickyHeader && parentSticky && tableWrapper) {
     return (0, _react2.jsx)(_FixedButton.default, {
+      cellLayoutVersion: cellLayoutVersion,
       offset: BUTTON_OFFSET,
       stickyHeader: stickyHeader,
       tableWrapper: tableWrapper,

package/dist/cjs/ui/FloatingContextualButton/useCellLayoutVersion.js

@@ -0,0 +1,58 @@
+"use strict";
+
+var _interopRequireDefault = require("@babel/runtime/helpers/interopRequireDefault");
+Object.defineProperty(exports, "__esModule", {
+  value: true
+});
+exports.useCellLayoutVersion = void 0;
+var _slicedToArray2 = _interopRequireDefault(require("@babel/runtime/helpers/slicedToArray"));
+var _react = require("react");
+var _rafSchd = _interopRequireDefault(require("raf-schd"));
+var _fg = require("@atlaskit/platform-feature-flags/fg");
+/**
+ * Counts layout changes that can move the target cell without re-rendering the cell options
+ * button: the editor container resizing (window resize, side panel, product sidebar) or the table
+ * resizing (column scaling). Changing the count re-renders the button so it repositions on its
+ * cell. Stays 0 when the gate is off.
+ */
+var useCellLayoutVersion = exports.useCellLayoutVersion = function useCellLayoutVersion(targetCellRef) {
+  var _useState = (0, _react.useState)(0),
+    _useState2 = (0, _slicedToArray2.default)(_useState, 2),
+    layoutVersion = _useState2[0],
+    setLayoutVersion = _useState2[1];
+  (0, _react.useEffect)(function () {
+    if (!(0, _fg.fg)('platform_editor_sticky_cell_options_position')) {
+      return;
+    }
+    if (!(targetCellRef instanceof HTMLElement)) {
+      return;
+    }
+    var container = targetCellRef.closest('[data-editor-container="true"]');
+    var table = targetCellRef.closest('table');
+    var bumpLayoutVersion = (0, _rafSchd.default)(function () {
+      return setLayoutVersion(function (version) {
+        return version + 1;
+      });
+    });
+    var hasReceivedInitialEntries = false;
+    var observer = new ResizeObserver(function () {
+      // ResizeObserver reports every observed element once on observe(); that is not a move.
+      if (!hasReceivedInitialEntries) {
+        hasReceivedInitialEntries = true;
+        return;
+      }
+      bumpLayoutVersion();
+    });
+    if (container) {
+      observer.observe(container);
+    }
+    if (table) {
+      observer.observe(table);
+    }
+    return function () {
+      observer.disconnect();
+      bumpLayoutVersion.cancel();
+    };
+  }, [targetCellRef]);
+  return layoutVersion;
+};

package/dist/es2019/ui/FloatingContextualButton/FixedButton.js

@@ -1,4 +1,4 @@
-import React, { useEffect, useMemo, useRef } from 'react';
+import React, { useEffect, useLayoutEffect, useMemo, useRef } from 'react';
 import { createPortal } from 'react-dom';
 import rafSchedule from 'raf-schd';
 import { TableCssClassName as ClassName } from '../../types';
@@ -20,6 +20,7 @@ export const calcObserverTargetMargin = (tableWrapper, fixedButtonRefCurrent) =>
   return fixedButtonRect.left - tableWrapperRect.left + scrollLeft;
 };
 export const FixedButton = ({
+  cellLayoutVersion = 0,
   children,
   isContextualMenuOpen,
   mountTo,
@@ -85,10 +86,24 @@ export const FixedButton = ({
     }
   }, [fixedButtonRef, observerTargetRef, tableWrapper, targetCellPosition, targetCellRef, isContextualMenuOpen]);
   const fixedButtonTop = 0;
+
+  // The left position below is read from the cell's current rect, which already includes the
+  // table's horizontal scroll, so the scroll translation accumulated so far must start again.
+  useLayoutEffect(() => {
+    const fixedButtonRefCurrent = fixedButtonRef.current;
+    const observerTargetRefCurrent = observerTargetRef.current;
+    if (cellLayoutVersion === 0 || !fixedButtonRefCurrent || !observerTargetRefCurrent) {
+      return;
+    }
+    fixedButtonRefCurrent.style.transform = '';
+    scrollDataRef.current = tableWrapper.scrollLeft;
+    leftPosDataRef.current = 0;
+    observerTargetRefCurrent.style.marginLeft = `${calcObserverTargetMargin(tableWrapper, fixedButtonRefCurrent)}px`;
+  }, [cellLayoutVersion, tableWrapper]);
   const containerLeft = useMemo(() => {
     const container = targetCellRef.closest('[data-editor-container="true"]');
     return (container === null || container === void 0 ? void 0 : container.getBoundingClientRect().left) || 0;
-  }, [targetCellRef]);
+  }, [targetCellRef, cellLayoutVersion]);
   const left = useMemo(() => {
     const targetCellRect = targetCellRef.getBoundingClientRect();
     const baseLeft = calcLeftPos({
@@ -98,7 +113,7 @@ export const FixedButton = ({
       offset
     });
     return baseLeft - containerLeft;
-  }, [containerLeft, targetCellRef, offset]);
+  }, [containerLeft, targetCellRef, offset, cellLayoutVersion]);
 
   // Using a portal here to ensure wrapperRef has the tableWrapper as an
   // ancestor. This is required to make the Intersection Observer work.

package/dist/es2019/ui/FloatingContextualButton/index.js

@@ -27,6 +27,7 @@ import { getTableZIndexes } from '../sticky-header-z-index';
 // eslint-disable-next-line import/no-named-as-default
 import FixedButton from './FixedButton';
 import { tableFloatingCellButtonSelectedStyles, tableFloatingCellButtonStyles } from './styles';
+import { useCellLayoutVersion } from './useCellLayoutVersion';
 const BUTTON_OFFSET = 3;
 const CONTEXTUAL_MENU_BUTTON_Z_INDEX = 2;
 const anchorStyles = css({
@@ -95,6 +96,9 @@ const FloatingContextualButtonInner = /*#__PURE__*/React.memo(props => {
   };
   const domAtPos = editorView.domAtPos.bind(editorView);
   const targetCellRef = findDomRefAtPos(targetCellPosition, domAtPos);
+  // Re-renders this component when the cell may have moved, so both FixedButton and Popup
+  // reposition: Popup recalculates its position whenever it receives new props.
+  const cellLayoutVersion = useCellLayoutVersion(targetCellRef);
   useEffect(() => {
     if (isCellMenuOpenByKeyboard && !isCellMenuOpen) {
       const {
@@ -194,6 +198,7 @@ const FloatingContextualButtonInner = /*#__PURE__*/React.memo(props => {
   }
   if (stickyHeader && parentSticky && tableWrapper) {
     return jsx(FixedButton, {
+      cellLayoutVersion: cellLayoutVersion,
       offset: BUTTON_OFFSET,
       stickyHeader: stickyHeader,
       tableWrapper: tableWrapper,

package/dist/es2019/ui/FloatingContextualButton/useCellLayoutVersion.js

@@ -0,0 +1,44 @@
+import { useEffect, useState } from 'react';
+import rafSchedule from 'raf-schd';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
+
+/**
+ * Counts layout changes that can move the target cell without re-rendering the cell options
+ * button: the editor container resizing (window resize, side panel, product sidebar) or the table
+ * resizing (column scaling). Changing the count re-renders the button so it repositions on its
+ * cell. Stays 0 when the gate is off.
+ */
+export const useCellLayoutVersion = targetCellRef => {
+  const [layoutVersion, setLayoutVersion] = useState(0);
+  useEffect(() => {
+    if (!fg('platform_editor_sticky_cell_options_position')) {
+      return;
+    }
+    if (!(targetCellRef instanceof HTMLElement)) {
+      return;
+    }
+    const container = targetCellRef.closest('[data-editor-container="true"]');
+    const table = targetCellRef.closest('table');
+    const bumpLayoutVersion = rafSchedule(() => setLayoutVersion(version => version + 1));
+    let hasReceivedInitialEntries = false;
+    const observer = new ResizeObserver(() => {
+      // ResizeObserver reports every observed element once on observe(); that is not a move.
+      if (!hasReceivedInitialEntries) {
+        hasReceivedInitialEntries = true;
+        return;
+      }
+      bumpLayoutVersion();
+    });
+    if (container) {
+      observer.observe(container);
+    }
+    if (table) {
+      observer.observe(table);
+    }
+    return () => {
+      observer.disconnect();
+      bumpLayoutVersion.cancel();
+    };
+  }, [targetCellRef]);
+  return layoutVersion;
+};

package/dist/esm/ui/FloatingContextualButton/FixedButton.js

@@ -1,4 +1,4 @@
-import React, { useEffect, useMemo, useRef } from 'react';
+import React, { useEffect, useLayoutEffect, useMemo, useRef } from 'react';
 import { createPortal } from 'react-dom';
 import rafSchedule from 'raf-schd';
 import { TableCssClassName as ClassName } from '../../types';
@@ -19,7 +19,9 @@ export var calcObserverTargetMargin = function calcObserverTargetMargin(tableWra
   return fixedButtonRect.left - tableWrapperRect.left + scrollLeft;
 };
 export var FixedButton = function FixedButton(_ref2) {
-  var children = _ref2.children,
+  var _ref2$cellLayoutVersi = _ref2.cellLayoutVersion,
+    cellLayoutVersion = _ref2$cellLayoutVersi === void 0 ? 0 : _ref2$cellLayoutVersi,
+    children = _ref2.children,
     isContextualMenuOpen = _ref2.isContextualMenuOpen,
     mountTo = _ref2.mountTo,
     offset = _ref2.offset,
@@ -83,10 +85,24 @@ export var FixedButton = function FixedButton(_ref2) {
     }
   }, [fixedButtonRef, observerTargetRef, tableWrapper, targetCellPosition, targetCellRef, isContextualMenuOpen]);
   var fixedButtonTop = 0;
+
+  // The left position below is read from the cell's current rect, which already includes the
+  // table's horizontal scroll, so the scroll translation accumulated so far must start again.
+  useLayoutEffect(function () {
+    var fixedButtonRefCurrent = fixedButtonRef.current;
+    var observerTargetRefCurrent = observerTargetRef.current;
+    if (cellLayoutVersion === 0 || !fixedButtonRefCurrent || !observerTargetRefCurrent) {
+      return;
+    }
+    fixedButtonRefCurrent.style.transform = '';
+    scrollDataRef.current = tableWrapper.scrollLeft;
+    leftPosDataRef.current = 0;
+    observerTargetRefCurrent.style.marginLeft = "".concat(calcObserverTargetMargin(tableWrapper, fixedButtonRefCurrent), "px");
+  }, [cellLayoutVersion, tableWrapper]);
   var containerLeft = useMemo(function () {
     var container = targetCellRef.closest('[data-editor-container="true"]');
     return (container === null || container === void 0 ? void 0 : container.getBoundingClientRect().left) || 0;
-  }, [targetCellRef]);
+  }, [targetCellRef, cellLayoutVersion]);
   var left = useMemo(function () {
     var targetCellRect = targetCellRef.getBoundingClientRect();
     var baseLeft = calcLeftPos({
@@ -96,7 +112,7 @@ export var FixedButton = function FixedButton(_ref2) {
       offset: offset
     });
     return baseLeft - containerLeft;
-  }, [containerLeft, targetCellRef, offset]);
+  }, [containerLeft, targetCellRef, offset, cellLayoutVersion]);
 
   // Using a portal here to ensure wrapperRef has the tableWrapper as an
   // ancestor. This is required to make the Intersection Observer work.

package/dist/esm/ui/FloatingContextualButton/index.js

@@ -30,6 +30,7 @@ import { getTableZIndexes } from '../sticky-header-z-index';
 // eslint-disable-next-line import/no-named-as-default
 import FixedButton from './FixedButton';
 import { tableFloatingCellButtonSelectedStyles, tableFloatingCellButtonStyles } from './styles';
+import { useCellLayoutVersion } from './useCellLayoutVersion';
 var BUTTON_OFFSET = 3;
 var CONTEXTUAL_MENU_BUTTON_Z_INDEX = 2;
 var anchorStyles = css({
@@ -89,6 +90,9 @@ var FloatingContextualButtonInner = /*#__PURE__*/React.memo(function (props) {
   };
   var domAtPos = editorView.domAtPos.bind(editorView);
   var targetCellRef = findDomRefAtPos(targetCellPosition, domAtPos);
+  // Re-renders this component when the cell may have moved, so both FixedButton and Popup
+  // reposition: Popup recalculates its position whenever it receives new props.
+  var cellLayoutVersion = useCellLayoutVersion(targetCellRef);
   useEffect(function () {
     if (isCellMenuOpenByKeyboard && !isCellMenuOpen) {
       var state = editorView.state,
@@ -181,6 +185,7 @@ var FloatingContextualButtonInner = /*#__PURE__*/React.memo(function (props) {
   }
   if (stickyHeader && parentSticky && tableWrapper) {
     return jsx(FixedButton, {
+      cellLayoutVersion: cellLayoutVersion,
       offset: BUTTON_OFFSET,
       stickyHeader: stickyHeader,
       tableWrapper: tableWrapper,

package/dist/esm/ui/FloatingContextualButton/useCellLayoutVersion.js

@@ -0,0 +1,52 @@
+import _slicedToArray from "@babel/runtime/helpers/slicedToArray";
+import { useEffect, useState } from 'react';
+import rafSchedule from 'raf-schd';
+import { fg } from '@atlaskit/platform-feature-flags/fg';
+
+/**
+ * Counts layout changes that can move the target cell without re-rendering the cell options
+ * button: the editor container resizing (window resize, side panel, product sidebar) or the table
+ * resizing (column scaling). Changing the count re-renders the button so it repositions on its
+ * cell. Stays 0 when the gate is off.
+ */
+export var useCellLayoutVersion = function useCellLayoutVersion(targetCellRef) {
+  var _useState = useState(0),
+    _useState2 = _slicedToArray(_useState, 2),
+    layoutVersion = _useState2[0],
+    setLayoutVersion = _useState2[1];
+  useEffect(function () {
+    if (!fg('platform_editor_sticky_cell_options_position')) {
+      return;
+    }
+    if (!(targetCellRef instanceof HTMLElement)) {
+      return;
+    }
+    var container = targetCellRef.closest('[data-editor-container="true"]');
+    var table = targetCellRef.closest('table');
+    var bumpLayoutVersion = rafSchedule(function () {
+      return setLayoutVersion(function (version) {
+        return version + 1;
+      });
+    });
+    var hasReceivedInitialEntries = false;
+    var observer = new ResizeObserver(function () {
+      // ResizeObserver reports every observed element once on observe(); that is not a move.
+      if (!hasReceivedInitialEntries) {
+        hasReceivedInitialEntries = true;
+        return;
+      }
+      bumpLayoutVersion();
+    });
+    if (container) {
+      observer.observe(container);
+    }
+    if (table) {
+      observer.observe(table);
+    }
+    return function () {
+      observer.disconnect();
+      bumpLayoutVersion.cancel();
+    };
+  }, [targetCellRef]);
+  return layoutVersion;
+};

package/dist/types/ui/FloatingContextualButton/FixedButton.d.ts

@@ -1,6 +1,8 @@
 import React from 'react';
 import type { RowStickyState } from '../../pm-plugins/sticky-headers/types';
 interface Props {
+    /** Changes when the cell may have moved without a re-render; see `useCellLayoutVersion`. */
+    cellLayoutVersion?: number;
     children: React.ReactNode;
     isContextualMenuOpen: boolean | undefined;
     mountTo: HTMLElement;
@@ -18,5 +20,5 @@ interface CalcLeftPosData {
 }
 export declare const calcLeftPos: ({ buttonWidth, cellRectLeft, cellRefWidth, offset, }: CalcLeftPosData) => number;
 export declare const calcObserverTargetMargin: (tableWrapper: HTMLElement, fixedButtonRefCurrent: HTMLElement) => number;
-export declare const FixedButton: ({ children, isContextualMenuOpen, mountTo, offset, stickyHeader, tableWrapper, targetCellPosition, targetCellRef, }: Props) => React.ReactPortal;
+export declare const FixedButton: ({ cellLayoutVersion, children, isContextualMenuOpen, mountTo, offset, stickyHeader, tableWrapper, targetCellPosition, targetCellRef, }: Props) => React.ReactPortal;
 export default FixedButton;

package/dist/types/ui/FloatingContextualButton/useCellLayoutVersion.d.ts

@@ -0,0 +1,7 @@
+/**
+ * Counts layout changes that can move the target cell without re-rendering the cell options
+ * button: the editor container resizing (window resize, side panel, product sidebar) or the table
+ * resizing (column scaling). Changing the count re-renders the button so it repositions on its
+ * cell. Stays 0 when the gate is off.
+ */
+export declare const useCellLayoutVersion: (targetCellRef: Node | undefined) => number;

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@atlaskit/editor-plugin-table",
-	"version": "42.2.9",
+	"version": "42.3.0",
 	"description": "Table plugin for the @atlaskit/editor",
 	"publishConfig": {
 		"registry": "https://registry.npmjs.org/"
@@ -74,6 +74,9 @@
 		"react-intl": "^5.25.1 || ^6.0.0 || ^7.0.0"
 	},
 	"platform-feature-flags": {
+		"platform_editor_sticky_cell_options_position": {
+			"type": "boolean"
+		},
 		"platform_editor_ai_suggestion_table_scroll_fix": {
 			"type": "boolean"
 		},