@atlaskit/editor-plugin-table 5.3.8 → 5.3.10

package/dist/types-ts4.5/plugins/table/ui/TableFloatingControls/index.d.ts

@@ -3,7 +3,7 @@ import type { TableColumnOrdering } from '@atlaskit/custom-steps';
 import type { Selection } from '@atlaskit/editor-prosemirror/state';
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { RowStickyState } from '../../pm-plugins/sticky-headers';
-import type { CellHoverCoordinates } from '../../types';
+import type { CellHoverMeta } from '../../types';
 export interface Props {
     editorView: EditorView;
     selection?: Selection;
@@ -18,7 +18,7 @@ export interface Props {
     hasHeaderRow?: boolean;
     headerRowHeight?: number;
     hoveredRows?: number[];
-    hoveredCell?: CellHoverCoordinates;
+    hoveredCell?: CellHoverMeta;
     ordering?: TableColumnOrdering;
     stickyHeader?: RowStickyState;
 }

package/dist/types-ts4.5/plugins/table/ui/icons/index.d.ts

@@ -0,0 +1,2 @@
+export { DragHandleIcon } from './DragHandleIcon';
+export { DragInMotionIcon } from './DragInMotionIcon';

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@atlaskit/editor-plugin-table",
-  "version": "5.3.8",
+  "version": "5.3.10",
   "description": "Table plugin for the @atlaskit/editor",
   "publishConfig": {
     "registry": "https://registry.npmjs.org/"
@@ -70,6 +70,7 @@
     "@atlaskit/webdriver-runner": "*",
     "@atlassian/atlassian-frontend-prettier-config-1.0.1": "npm:@atlassian/atlassian-frontend-prettier-config@1.0.1",
     "@atlassian/feature-flags-test-utils": "^0.1.2",
+    "@testing-library/dom": "^8.17.1",
     "@testing-library/react": "^12.1.5",
     "@testing-library/react-hooks": "^8.0.1",
     "raf-stub": "^2.0.1",

package/src/__tests__/unit/event-handlers.ts

@@ -301,7 +301,10 @@ describe('withCellTracking', () => {
       withCellTracking(jest.fn())(editorView, event as any);
 
       const pluginState = getPluginState(editorView.state);
-      expect(pluginState.hoveredCell).toEqual({ colIndex: 0, rowIndex: 0 });
+      expect(pluginState.hoveredCell).toEqual({
+        colIndex: undefined,
+        rowIndex: undefined,
+      });
     });
   });
 });

package/src/__tests__/unit/ui/TableFloatingColumnControls.tsx

@@ -1,9 +1,10 @@
 import React from 'react';
 
+import { fireEvent } from '@testing-library/dom';
 import { render, screen } from '@testing-library/react';
 import { IntlProvider } from 'react-intl-next';
 
-import type { DocBuilder } from '@atlaskit/editor-common/types';
+import type { DocBuilder, Refs } from '@atlaskit/editor-common/types';
 // eslint-disable-next-line import/no-extraneous-dependencies -- Removed import for fixing circular dependencies
 import { analyticsPlugin } from '@atlaskit/editor-plugin-analytics';
 import { contentInsertionPlugin } from '@atlaskit/editor-plugin-content-insertion';
@@ -12,6 +13,7 @@ import { guidelinePlugin } from '@atlaskit/editor-plugin-guideline';
 import { selectionPlugin } from '@atlaskit/editor-plugin-selection';
 import { widthPlugin } from '@atlaskit/editor-plugin-width';
 import type { PluginKey } from '@atlaskit/editor-prosemirror/state';
+import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 import type { LightEditorPlugin } from '@atlaskit/editor-test-helpers/create-prosemirror-editor';
 // eslint-disable-next-line import/no-extraneous-dependencies -- Removed import for fixing circular dependencies
 import {
@@ -56,13 +58,28 @@ describe('TableFloatingColumnControls', () => {
     });
   };
 
+  const getNodeFunc = (view: EditorView, refs: Refs) => () =>
+    view.state.doc.nodeAt(refs['<node>'])!;
+
+  afterEach(async () => {
+    // cleanup any pending drags
+    fireEvent.dragEnd(window);
+    // Optional: unwind a post-drop browser bug fix
+    // tick forward a micro task to flush a post-drag bug fix
+    await 1;
+    // this will trigger the fix to be released
+    fireEvent.pointerMove(window);
+  });
+
   it('should not render floating column controls when tableRef undefined and drag and drop is not enabled', () => {
-    const { editorView } = editor(
-      doc(p('text'), table()(tr(tdEmpty, tdEmpty, tdEmpty))),
+    const { editorView, refs } = editor(
+      doc(p('text'), '{<node>}', table()(tr(tdEmpty, tdEmpty, tdEmpty))),
     );
+
     const { container } = render(
       <TableFloatingColumnControls
         editorView={editorView}
+        getNode={getNodeFunc(editorView, refs)}
         getEditorFeatureFlags={fakeGetEditorFeatureFlags}
       />,
     );
@@ -70,8 +87,8 @@ describe('TableFloatingColumnControls', () => {
   });
 
   it('should not render floating column controls when tableRef undefined and drag and drop is enabled', () => {
-    const { editorView } = editor(
-      doc(p('text'), table()(tr(tdEmpty, tdEmpty, tdEmpty))),
+    const { editorView, refs } = editor(
+      doc(p('text'), '{<node>}', table()(tr(tdEmpty, tdEmpty, tdEmpty))),
       {
         dragAndDropEnabled: true,
       },
@@ -79,16 +96,23 @@ describe('TableFloatingColumnControls', () => {
     const { container } = render(
       <TableFloatingColumnControls
         editorView={editorView}
+        getNode={getNodeFunc(editorView, refs)}
         getEditorFeatureFlags={fakeGetEditorFeatureFlags}
       />,
     );
     expect(container.innerHTML).toEqual('');
   });
 
-  // FIXME and unskip: presumably doesn't work becuase TableFloatingColumnControls are now mounted via ReactDOM.createPortal
-  it.skip('should render a drop target per column', () => {
-    const { editorView } = editor(
-      doc(p('text'), table()(tr(tdEmpty, tdEmpty, tdEmpty, tdEmpty, tdEmpty))),
+  it.todo('should not render drop target when no drag is active');
+
+  it.todo(
+    'should render a drop target per column when dragging' /*, () => {
+    const { editorView, refs } = editor(
+      doc(
+        p('text'),
+        '{<node>}',
+        table()(tr(tdEmpty, tdCursor, tdEmpty, tdEmpty, tdEmpty)),
+      ),
       {
         dragAndDropEnabled: true,
       },
@@ -98,25 +122,44 @@ describe('TableFloatingColumnControls', () => {
     render(
       <IntlProvider locale="en">
         <TableFloatingColumnControls
+          getNode={getNodeFunc(editorView, refs)}
           tableRef={ref}
           tableActive={true}
+          hoveredCell={{ colIndex: 1, rowIndex: 0}}
           editorView={editorView}
           getEditorFeatureFlags={fakeGetEditorFeatureFlags}
         />
       </IntlProvider>,
     );
 
+    screen.debug();
+
+    const dragHandle = screen.getByTestId(
+      'table-floating-column-controls-drag-handle',
+    );
+
+    fireEvent.dragStart(dragHandle);
+
+     // ticking forward an animation frame will complete the lift
+    // @ts-expect-error
+    requestAnimationFrame.step();
+
     const dropTargets = screen.getAllByTestId(
       'table-floating-column-controls-drop-target',
     );
 
     expect(dropTargets).toHaveLength(5);
-  });
+  }*/,
+  );
 
   // FIXME and unskp: presumably doesn't work becuase TableFloatingColumnControls are now mounted via ReactDOM.createPortal
   it.skip('should render a drop target per column regardless of row count', () => {
-    const { editorView } = editor(
-      doc(p('text'), table()(tr(tdEmpty), tr(tdEmpty), tr(tdEmpty))),
+    const { editorView, refs } = editor(
+      doc(
+        p('text'),
+        '{<node>}',
+        table()(tr(tdEmpty), tr(tdEmpty), tr(tdEmpty)),
+      ),
       {
         dragAndDropEnabled: true,
       },
@@ -126,6 +169,7 @@ describe('TableFloatingColumnControls', () => {
     render(
       <IntlProvider locale="en">
         <TableFloatingColumnControls
+          getNode={getNodeFunc(editorView, refs)}
           tableRef={ref}
           tableActive={true}
           editorView={editorView}
@@ -139,4 +183,6 @@ describe('TableFloatingColumnControls', () => {
     );
     expect(dropTargets).toHaveLength(1);
   });
+
+  it.todo('should remove column drop targets when dragging ends');
 });

package/src/plugins/table/commands/hover.ts

@@ -191,13 +191,18 @@ export const hideResizeHandleLine = () =>
     },
   }));
 
-export const hoverCell = (rowIndex?: number, colIndex?: number) =>
+export const hoverCell = (
+  rowIndex?: number,
+  colIndex?: number,
+  colWidth?: number,
+  colHeight?: number,
+) =>
   createCommand(
     () => {
       return {
         type: 'HOVER_CELL',
         data: {
-          hoveredCell: { rowIndex, colIndex },
+          hoveredCell: { rowIndex, colIndex, colWidth, colHeight },
         },
       };
     },

package/src/plugins/table/event-handlers.ts

@@ -288,7 +288,7 @@ export const handleMouseLeave = (view: EditorView, event: Event): boolean => {
   }
 
   if (isDragAndDropEnabled) {
-    hoverCell(undefined, undefined)(state, dispatch);
+    hoverCell()(state, dispatch);
   }
 
   if (
@@ -512,8 +512,9 @@ const trackCellLocation = (view: EditorView, mouseEvent: Event) => {
   const maybeTableCell = isElementInTableCell(
     target as HTMLElement,
   ) as HTMLTableCellElement | null;
+  const tableRef = getPluginState(view.state).tableRef;
 
-  if (!maybeTableCell) {
+  if (!maybeTableCell || !tableRef) {
     return;
   }
 
@@ -525,8 +526,21 @@ const trackCellLocation = (view: EditorView, mouseEvent: Event) => {
   const rowIndex = rowElement && rowElement.rowIndex;
   const { hoveredCell } = getPluginState(view.state);
 
-  if (hoveredCell.colIndex !== colIndex || hoveredCell.rowIndex !== rowIndex) {
-    hoverCell(rowIndex, colIndex)(view.state, view.dispatch);
+  const colHeight = tableRef.offsetHeight;
+  const colWidth = maybeTableCell.offsetWidth;
+
+  if (
+    hoveredCell.colIndex !== colIndex ||
+    hoveredCell.rowIndex !== rowIndex ||
+    hoveredCell.colWidth !== colWidth ||
+    hoveredCell.colHeight !== colHeight
+  ) {
+    hoverCell(
+      rowIndex,
+      colIndex,
+      colWidth,
+      colHeight,
+    )(view.state, view.dispatch);
   }
 };
 

package/src/plugins/table/nodeviews/TableComponent.tsx

@@ -439,13 +439,14 @@ class TableComponent extends React.Component<ComponentProps, TableState> {
       <TableFloatingColumnControls
         editorView={view}
         tableRef={tableRef}
+        getNode={getNode}
         tableActive={tableActive}
         hoveredRows={hoveredRows}
         hoveredCell={hoveredCell}
         isResizing={isResizing}
         ordering={ordering}
         hasHeaderRow={hasHeaderRow}
-        // pass `selection` and `tableHeight` to control re-render
+        // pass `selection` to control re-render
         selection={view.state.selection}
         headerRowHeight={headerRow ? headerRow.offsetHeight : undefined}
         stickyHeader={this.state.stickyHeader}

package/src/plugins/table/pm-plugins/drag-and-drop/commands.ts

@@ -110,9 +110,6 @@ export const moveSource = (
       }
 
       const move = sourceType === 'table-row' ? moveRow : moveColumn;
-      return move(
-        sourceIndex,
-        targetIndex + (sourceIndex > targetIndex ? 0 : -1),
-      )(tr);
+      return move(sourceIndex, targetIndex)(tr);
     },
   );

package/src/plugins/table/pm-plugins/drag-and-drop/plugin.ts

@@ -87,7 +87,12 @@ export const createPlugin = (
               return;
             }
 
-            const { sourceType, sourceIndexes, targetAdjustedIndex } = data;
+            const {
+              sourceType,
+              sourceIndexes,
+              targetAdjustedIndex,
+              direction,
+            } = data;
 
             // If the drop target index contains merged cells then we should not allow the drop to occur.
             const hasMergedCells =
@@ -105,7 +110,7 @@ export const createPlugin = (
             moveSource(
               sourceType,
               sourceIndex,
-              targetAdjustedIndex,
+              targetAdjustedIndex + (direction === -1 ? 0 : -1),
             )(editorView.state, editorView.dispatch);
           },
         }),

package/src/plugins/table/pm-plugins/drag-and-drop/utils/monitor.ts

@@ -59,6 +59,10 @@ export const getDraggableDataFromEvent = ({
   const targetOffset =
     targetClosestEdge === 'right' || targetClosestEdge === 'bottom' ? 1 : 0;
 
+  // since only consecutive rows/cols can be moved we can assume that if the first index is greater then
+  // the target index, the then the direction of the DnD is decreasing
+  const direction = sourceIndexes[0] > targetIndex ? -1 : 1;
+
   return {
     sourceType,
     sourceLocalId,
@@ -68,5 +72,6 @@ export const getDraggableDataFromEvent = ({
     targetIndex,
     targetAdjustedIndex: targetIndex + targetOffset,
     targetClosestEdge,
+    direction,
   };
 };

package/src/plugins/table/types.ts

@@ -85,14 +85,18 @@ export type { ColumnResizingPluginState } from '@atlaskit/editor-common/types';
  *
  */
 export type CellColumnPositioning = Pick<Rect, 'right' | 'left'>;
-
-export type CellHoverCoordinates = { colIndex?: number; rowIndex?: number };
+export interface CellHoverMeta {
+  colIndex?: number;
+  rowIndex?: number;
+  colWidth?: number;
+  colHeight?: number;
+}
 
 export interface TablePluginState {
   editorHasFocus?: boolean;
   hoveredColumns: number[];
   hoveredRows: number[];
-  hoveredCell: CellHoverCoordinates;
+  hoveredCell: CellHoverMeta;
   pluginConfig: PluginConfig;
   isHeaderColumnEnabled: boolean;
   isHeaderRowEnabled: boolean;
@@ -200,7 +204,12 @@ export type TablePluginAction =
   | { type: 'CLEAR_HOVER_SELECTION'; data: { decorationSet: DecorationSet } }
   | { type: 'SHOW_RESIZE_HANDLE_LINE'; data: { decorationSet: DecorationSet } }
   | { type: 'HIDE_RESIZE_HANDLE_LINE'; data: { decorationSet: DecorationSet } }
-  | { type: 'HOVER_CELL'; data: CellHoverCoordinates }
+  | {
+      type: 'HOVER_CELL';
+      data: {
+        hoveredCell: CellHoverMeta;
+      };
+    }
   | { type: 'SET_TARGET_CELL_POSITION'; data: { targetCellPosition?: number } }
   | {
       type: 'SELECT_COLUMN';
@@ -421,4 +430,5 @@ export interface DraggableData {
   targetIndex: number;
   targetAdjustedIndex: number;
   targetClosestEdge: Edge;
+  direction: 1 | -1;
 }

package/src/plugins/table/ui/DragHandle/index.tsx

@@ -10,7 +10,7 @@ import { token } from '@atlaskit/tokens';
 
 import { TableCssClassName as ClassName } from '../../types';
 import { DragPreview } from '../DragPreview';
-import { DragHandleIcon } from '../icons/DragHandleIcon';
+import { DragHandleIcon } from '../icons';
 
 type DragHandleState = 'default' | 'selected' | 'disabled' | 'danger';
 
@@ -99,7 +99,9 @@ export const DragHandle = ({
         borderRadius: '4px',
         border: `2px solid ${token('elevation.surface', 'white')}`,
         transform: direction === 'column' ? 'none' : 'rotate(90deg)',
+        pointerEvents: 'auto',
       }}
+      data-testid="table-floating-column-controls-drag-handle"
     >
       <DragHandleIcon {...iconProps} />
       {previewContainer &&

package/src/plugins/table/ui/TableFloatingColumnControls/ColumnControls/index.tsx

@@ -1,21 +1,21 @@
-import React, { useMemo } from 'react';
+import React from 'react';
 
 import type { EditorView } from '@atlaskit/editor-prosemirror/view';
 
-import type { CellHoverCoordinates } from '../../../types';
+import type { CellHoverMeta } from '../../../types';
 import { TableCssClassName as ClassName } from '../../../types';
-import { getColumnsWidths, getRowHeights } from '../../../utils';
 import { DragHandle } from '../../DragHandle';
 
 export interface Props {
   editorView: EditorView;
   tableActive?: boolean;
   tableRef: HTMLTableElement;
-  hoveredCell?: CellHoverCoordinates;
+  hoveredCell?: CellHoverMeta;
   isResizing?: boolean;
   stickyTop?: number;
-  tableHeight?: number;
   localId?: string;
+  rowHeights?: number[];
+  colWidths?: (number | undefined)[];
 }
 
 export const ColumnControls: React.FC<Props> = ({
@@ -24,18 +24,11 @@ export const ColumnControls: React.FC<Props> = ({
   tableRef,
   hoveredCell,
   isResizing,
-  tableHeight,
   stickyTop,
   localId,
+  rowHeights,
+  colWidths,
 }) => {
-  const rowHeights = useMemo(() => {
-    // NOTE: we don't care so much as to what tableHeight is, we only care that it changed and is a sane value.
-    if (tableRef && !!tableHeight) {
-      return getRowHeights(tableRef);
-    }
-    return [0];
-  }, [tableRef, tableHeight]);
-
   if (!tableRef) {
     return null;
   }
@@ -48,12 +41,9 @@ export const ColumnControls: React.FC<Props> = ({
   const marginTop =
     hasHeaderRow && stickyTop !== undefined ? rowHeights?.[0] ?? 0 : 0;
 
-  const colWidths = getColumnsWidths(editorView);
-  const widths = colWidths
-    .map((width) => (width ? `${width - 1}px` : '0px'))
-    .join(' ');
-
-  const colIndex = hoveredCell?.colIndex;
+  const widths =
+    colWidths?.map((width) => (width ? `${width - 1}px` : '0px')).join(' ') ??
+    '0px';
 
   const onClick = (
     index: number,
@@ -73,25 +63,32 @@ export const ColumnControls: React.FC<Props> = ({
           marginTop,
         }}
       >
-        {tableActive && !isResizing && Number.isFinite(colIndex) && (
-          <div
-            style={{
-              gridColumn: `${(colIndex as number) + 1} / span 1`,
-              marginTop: `-15px`,
-            }}
-            data-column-control-index={colIndex}
-            data-testid="table-floating-column-control"
-          >
-            <DragHandle
-              direction="column"
-              indexes={[]}
-              onClick={(event) => onClick(colIndex as number, event)}
-              onMouseOver={onMouseOver}
-              onMouseOut={onMouseOut}
-              tableLocalId={localId || ''}
-            />
-          </div>
-        )}
+        {tableActive &&
+          !isResizing &&
+          !!hoveredCell &&
+          Number.isFinite(hoveredCell.colIndex) && (
+            <div
+              style={{
+                gridColumn: `${(hoveredCell.colIndex as number) + 1} / span 1`,
+                marginTop: `-15px`,
+              }}
+              data-column-control-index={hoveredCell.colIndex}
+              data-testid="table-floating-column-control"
+            >
+              <DragHandle
+                direction="column"
+                indexes={[hoveredCell.colIndex!]}
+                onClick={(event) =>
+                  onClick(hoveredCell.colIndex as number, event)
+                }
+                onMouseOver={onMouseOver}
+                onMouseOut={onMouseOut}
+                tableLocalId={localId || ''}
+                previewWidth={hoveredCell.colWidth}
+                previewHeight={hoveredCell.colHeight}
+              />
+            </div>
+          )}
       </div>
     </div>
   );

package/src/plugins/table/ui/TableFloatingColumnControls/ColumnDropTargets/ColumnDropTarget.tsx

@@ -0,0 +1,74 @@
+import React, { useEffect, useRef } from 'react';
+
+import { attachClosestEdge } from '@atlaskit/pragmatic-drag-and-drop-hitbox/addon/closest-edge';
+import { dropTargetForElements } from '@atlaskit/pragmatic-drag-and-drop/adapter/element';
+
+import type { DraggableSourceData } from '../../../types';
+
+export interface Props {
+  index: number;
+  localId?: string;
+  width?: number;
+  height?: number;
+  marginTop?: number;
+}
+
+export const ColumnDropTarget: React.FC<Props> = ({
+  index,
+  localId,
+  width,
+  height,
+  marginTop,
+}) => {
+  const dropTargetRef = useRef<HTMLDivElement | null>(null);
+
+  useEffect(() => {
+    if (!dropTargetRef.current) {
+      return;
+    }
+
+    return dropTargetForElements({
+      element: dropTargetRef.current,
+      canDrop({ source }) {
+        const data = source.data as DraggableSourceData;
+        return (
+          // Only draggables of row type can be dropped on this target
+          data.type === 'table-column' &&
+          // Only draggables which came from the same table can be dropped on this target
+          data.localId === localId &&
+          // Only draggables which DO NOT include this drop targets index can be dropped
+          !!data.indexes?.length &&
+          data.indexes?.indexOf(index) === -1
+        );
+      },
+      getIsSticky: () => true,
+      getData({ input, element }) {
+        const data = {
+          localId,
+          type: 'table-column',
+          targetIndex: index,
+        };
+        return attachClosestEdge(data, {
+          input,
+          element,
+          allowedEdges: ['left', 'right'],
+        });
+      },
+    });
+  }, [index, localId]);
+
+  return (
+    <div
+      ref={dropTargetRef}
+      style={{
+        width: width && `${width - 1}px`,
+        height: height && `${height}px`,
+        marginTop: marginTop && `${marginTop}px`,
+        pointerEvents: 'auto',
+      }}
+      data-drop-target-index={index}
+      data-drop-target-localid={localId}
+      data-testid="table-floating-column-controls-drop-target"
+    />
+  );
+};