Skip to content

armgit / plane

Public Imported from GitHub
0

πŸ”₯πŸ”₯πŸ”₯ Open-source Jira, Linear, Monday, and ClickUp alternative. Plane is a modern project management platform to manage tasks, sprints, docs, and triage.

refactor: table drag preview using decorations (#8597)

Aaryan Khandelwald497304de5a0
diff --git a/apps/api/plane/utils/content_validator.py b/apps/api/plane/utils/content_validator.py
index 9dd52b26e5..1b4ede2626 100644
--- a/apps/api/plane/utils/content_validator.py
+++ b/apps/api/plane/utils/content_validator.py
@@ -139,8 +139,6 @@ ATTRIBUTES = {
"rowspan",
"colwidth",
"background",
- "hideContent",
- "hidecontent",
"style",
},
"td": {
@@ -150,8 +148,6 @@ ATTRIBUTES = {
"background",
"textColor",
"textcolor",
- "hideContent",
- "hidecontent",
"style",
},
"tr": {"background", "textColor", "textcolor", "style"},
diff --git a/packages/editor/src/core/extensions/table/plugins/drag-handles/column/drag-handle.tsx b/packages/editor/src/core/extensions/table/plugins/drag-handles/column/drag-handle.tsx
index 6e39e44b6a..a3d31b8dd2 100644
--- a/packages/editor/src/core/extensions/table/plugins/drag-handles/column/drag-handle.tsx
+++ b/packages/editor/src/core/extensions/table/plugins/drag-handles/column/drag-handle.tsx
@@ -42,7 +42,7 @@ import {
updateColDragMarker,
updateColDropMarker,
} from "../marker-utils";
-import { updateCellContentVisibility } from "../utils";
+import { showCellContent } from "../utils";
import { ColumnOptionsDropdown } from "./dropdown";
import { calculateColumnDropIndex, constructColumnDragPreview, getTableColumnNodesInfo } from "./utils";
@@ -152,8 +152,9 @@ export function ColumnDragHandle(props: ColumnDragHandleProps) {
hideDropMarker(dropMarker);
hideDragMarker(dragMarker);
+ // Show cell content by clearing decorations
if (isCellSelection(editor.state.selection)) {
- updateCellContentVisibility(editor, false);
+ showCellContent(editor);
}
if (col !== dropIndex) {
diff --git a/packages/editor/src/core/extensions/table/plugins/drag-handles/column/utils.ts b/packages/editor/src/core/extensions/table/plugins/drag-handles/column/utils.ts
index c367ee6ecd..ec3717d88d 100644
--- a/packages/editor/src/core/extensions/table/plugins/drag-handles/column/utils.ts
+++ b/packages/editor/src/core/extensions/table/plugins/drag-handles/column/utils.ts
@@ -11,7 +11,7 @@ import { TableMap } from "@tiptap/pm/tables";
import { getSelectedRect, isCellSelection } from "@/extensions/table/table/utilities/helpers";
import type { TableNodeLocation } from "@/extensions/table/table/utilities/helpers";
// local imports
-import { cloneTableCell, constructDragPreviewTable, updateCellContentVisibility } from "../utils";
+import { cloneTableCell, constructDragPreviewTable, getSelectedCellPositions, hideCellContent } from "../utils";
type TableColumn = {
left: number;
@@ -151,7 +151,9 @@ export const constructColumnDragPreview = (
}
});
- updateCellContentVisibility(editor, true);
+ // Hide the selected cells using decorations (local only, not persisted)
+ const cellPositions = getSelectedCellPositions(selection, table);
+ hideCellContent(editor, cellPositions);
return tableElement;
};
diff --git a/packages/editor/src/core/extensions/table/plugins/drag-handles/row/drag-handle.tsx b/packages/editor/src/core/extensions/table/plugins/drag-handles/row/drag-handle.tsx
index e88a1f2bc9..0c069c81f8 100644
--- a/packages/editor/src/core/extensions/table/plugins/drag-handles/row/drag-handle.tsx
+++ b/packages/editor/src/core/extensions/table/plugins/drag-handles/row/drag-handle.tsx
@@ -42,7 +42,7 @@ import {
updateRowDragMarker,
updateRowDropMarker,
} from "../marker-utils";
-import { updateCellContentVisibility } from "../utils";
+import { showCellContent } from "../utils";
import { RowOptionsDropdown } from "./dropdown";
import { calculateRowDropIndex, constructRowDragPreview, getTableRowNodesInfo } from "./utils";
@@ -152,8 +152,9 @@ export function RowDragHandle(props: RowDragHandleProps) {
hideDropMarker(dropMarker);
hideDragMarker(dragMarker);
+ // Show cell content by clearing decorations
if (isCellSelection(editor.state.selection)) {
- updateCellContentVisibility(editor, false);
+ showCellContent(editor);
}
if (row !== dropIndex) {
diff --git a/packages/editor/src/core/extensions/table/plugins/drag-handles/row/utils.ts b/packages/editor/src/core/extensions/table/plugins/drag-handles/row/utils.ts
index 5b6d80c1da..d10ec4015e 100644
--- a/packages/editor/src/core/extensions/table/plugins/drag-handles/row/utils.ts
+++ b/packages/editor/src/core/extensions/table/plugins/drag-handles/row/utils.ts
@@ -11,7 +11,7 @@ import { TableMap } from "@tiptap/pm/tables";
import { getSelectedRect, isCellSelection } from "@/extensions/table/table/utilities/helpers";
import type { TableNodeLocation } from "@/extensions/table/table/utilities/helpers";
// local imports
-import { cloneTableCell, constructDragPreviewTable, updateCellContentVisibility } from "../utils";
+import { cloneTableCell, constructDragPreviewTable, getSelectedCellPositions, hideCellContent } from "../utils";
type TableRow = {
top: number;
@@ -150,7 +150,9 @@ export const constructRowDragPreview = (
}
});
- updateCellContentVisibility(editor, true);
+ // Hide the selected cells using decorations (local only, not persisted)
+ const cellPositions = getSelectedCellPositions(selection, table);
+ hideCellContent(editor, cellPositions);
return tableElement;
};
diff --git a/packages/editor/src/core/extensions/table/plugins/drag-handles/utils.ts b/packages/editor/src/core/extensions/table/plugins/drag-handles/utils.ts
index 4c8f996d3c..9d7e8df830 100644
--- a/packages/editor/src/core/extensions/table/plugins/drag-handles/utils.ts
+++ b/packages/editor/src/core/extensions/table/plugins/drag-handles/utils.ts
@@ -5,9 +5,15 @@
*/
import type { Editor } from "@tiptap/core";
+import type { Selection } from "@tiptap/pm/state";
+import { TableMap } from "@tiptap/pm/tables";
// constants
-import { CORE_EXTENSIONS } from "@/constants/extension";
import { CORE_EDITOR_META } from "@/constants/meta";
+// extensions
+import { getSelectedRect, isCellSelection } from "@/extensions/table/table/utilities/helpers";
+import type { TableNodeLocation } from "@/extensions/table/table/utilities/helpers";
+// local imports
+import { updateTransactionMeta } from "../drag-state";
/**
* @description Construct a pseudo table element which will act as a parent for column and row drag previews.
@@ -47,20 +53,41 @@ export const cloneTableCell = (
};
/**
- * @description This function updates the `hideContent` attribute of the table cells and headers.
+ * @description Get positions of all cells in the current selection.
+ * @param {Selection} selection - The selection.
+ * @param {TableNodeLocation} table - The table node location.
+ * @returns {number[]} Array of cell positions.
+ */
+export const getSelectedCellPositions = (selection: Selection, table: TableNodeLocation): number[] => {
+ if (!isCellSelection(selection)) return [];
+
+ const tableMap = TableMap.get(table.node);
+ const selectedRect = getSelectedRect(selection, tableMap);
+ const cellsInSelection = tableMap.cellsInRect(selectedRect);
+
+ // Convert relative positions to absolute document positions
+ return cellsInSelection.map((cellPos) => table.start + cellPos);
+};
+
+/**
+ * @description Hide cell content using decorations (local only, not persisted).
* @param {Editor} editor - The editor instance.
- * @param {boolean} hideContent - Whether to hide the content.
- * @returns {boolean} Whether the content visibility was updated.
+ * @param {number[]} cellPositions - Array of cell positions to hide.
*/
-export const updateCellContentVisibility = (editor: Editor, hideContent: boolean): boolean =>
- editor
- .chain()
- .focus()
- .setMeta(CORE_EDITOR_META.ADD_TO_HISTORY, false)
- .updateAttributes(CORE_EXTENSIONS.TABLE_CELL, {
- hideContent,
- })
- .updateAttributes(CORE_EXTENSIONS.TABLE_HEADER, {
- hideContent,
- })
- .run();
+export const hideCellContent = (editor: Editor, cellPositions: number[]): void => {
+ const tr = editor.view.state.tr;
+ updateTransactionMeta(tr, cellPositions);
+ tr.setMeta(CORE_EDITOR_META.ADD_TO_HISTORY, false);
+ editor.view.dispatch(tr);
+};
+
+/**
+ * @description Show cell content by clearing decorations.
+ * @param {Editor} editor - The editor instance.
+ */
+export const showCellContent = (editor: Editor): void => {
+ const tr = editor.view.state.tr;
+ updateTransactionMeta(tr, null);
+ tr.setMeta(CORE_EDITOR_META.ADD_TO_HISTORY, false);
+ editor.view.dispatch(tr);
+};
diff --git a/packages/editor/src/core/extensions/table/plugins/drag-state.ts b/packages/editor/src/core/extensions/table/plugins/drag-state.ts
new file mode 100644
index 0000000000..d7afd26911
--- /dev/null
+++ b/packages/editor/src/core/extensions/table/plugins/drag-state.ts
@@ -0,0 +1,64 @@
+/**
+ * Copyright (c) 2023-present Plane Software, Inc. and contributors
+ * SPDX-License-Identifier: AGPL-3.0-only
+ * See the LICENSE file for details.
+ */
+
+import type { Transaction } from "@tiptap/pm/state";
+import { Plugin, PluginKey } from "@tiptap/pm/state";
+import { Decoration, DecorationSet } from "@tiptap/pm/view";
+
+const TABLE_DRAG_STATE_PLUGIN_KEY = new PluginKey("tableDragState");
+
+export const updateTransactionMeta = (tr: Transaction, hiddenCellPositions: number[] | null) => {
+ tr.setMeta(TABLE_DRAG_STATE_PLUGIN_KEY, hiddenCellPositions);
+};
+
+/**
+ * @description Plugin to manage table drag state using decorations.
+ * This allows hiding cell content during drag operations without modifying the document.
+ * Decorations are local to each user and not persisted or shared.
+ */
+export const TableDragStatePlugin = new Plugin({
+ key: TABLE_DRAG_STATE_PLUGIN_KEY,
+ state: {
+ init() {
+ return DecorationSet.empty;
+ },
+ apply(tr, oldState) {
+ // Get metadata about which cells to hide
+ const hiddenCellPositions = tr.getMeta(TABLE_DRAG_STATE_PLUGIN_KEY) as number[] | null;
+
+ if (hiddenCellPositions === undefined) {
+ // No change, map decorations through the transaction
+ return oldState.map(tr.mapping, tr.doc);
+ }
+
+ if (hiddenCellPositions === null || !Array.isArray(hiddenCellPositions) || hiddenCellPositions.length === 0) {
+ // Clear all decorations
+ return DecorationSet.empty;
+ }
+
+ // Create decorations for hidden cells
+ const decorations: Decoration[] = [];
+ hiddenCellPositions.forEach((pos) => {
+ if (typeof pos !== "number") return;
+ const node = tr.doc.nodeAt(pos);
+ if (node) {
+ decorations.push(
+ Decoration.node(pos, pos + node.nodeSize, {
+ class: "content-hidden",
+ })
+ );
+ }
+ });
+
+ return DecorationSet.create(tr.doc, decorations);
+ },
+ },
+ props: {
+ decorations(state) {
+ return this.getState(state);
+ },
+ },
+});
diff --git a/packages/editor/src/core/extensions/table/table-cell.ts b/packages/editor/src/core/extensions/table/table-cell.ts
index 2870ac894d..3bc7c2299e 100644
--- a/packages/editor/src/core/extensions/table/table-cell.ts
+++ b/packages/editor/src/core/extensions/table/table-cell.ts
@@ -53,9 +53,6 @@ export const TableCell = Node.create<TableCellOptions>({
textColor: {
default: null,
},
- hideContent: {
- default: false,
- },
};
},
@@ -116,7 +113,6 @@ export const TableCell = Node.create<TableCellOptions>({
return [
"td",
mergeAttributes(this.options.HTMLAttributes, HTMLAttributes, {
- class: node.attrs.hideContent ? "content-hidden" : "",
style: `background-color: ${node.attrs.background}; color: ${node.attrs.textColor};`,
}),
0,
diff --git a/packages/editor/src/core/extensions/table/table-header.ts b/packages/editor/src/core/extensions/table/table-header.ts
index e3c3725636..9f939c2a41 100644
--- a/packages/editor/src/core/extensions/table/table-header.ts
+++ b/packages/editor/src/core/extensions/table/table-header.ts
@@ -45,9 +45,6 @@ export const TableHeader = Node.create<TableHeaderOptions>({
background: {
default: "none",
},
- hideContent: {
- default: false,
- },
};
},
@@ -63,7 +60,6 @@ export const TableHeader = Node.create<TableHeaderOptions>({
return [
"th",
mergeAttributes(this.options.HTMLAttributes, HTMLAttributes, {
- class: node.attrs.hideContent ? "content-hidden" : "",
style: `background-color: ${node.attrs.background};`,
}),
0,
diff --git a/packages/editor/src/core/extensions/table/table/table.ts b/packages/editor/src/core/extensions/table/table/table.ts
index 08cfb7aa9b..fe8d3e36e1 100644
--- a/packages/editor/src/core/extensions/table/table/table.ts
+++ b/packages/editor/src/core/extensions/table/table/table.ts
@@ -28,6 +28,7 @@ import {
// constants
import { CORE_EXTENSIONS } from "@/constants/extension";
// local imports
+import { TableDragStatePlugin } from "../plugins/drag-state";
import { TableColumnDragHandlePlugin } from "../plugins/drag-handles/column/plugin";
import { TableRowDragHandlePlugin } from "../plugins/drag-handles/row/plugin";
import { TableInsertPlugin } from "../plugins/insert-handlers/plugin";
@@ -281,6 +282,7 @@ export const Table = Node.create<TableOptions>({
tableEditing({
allowTableNodeSelection: this.options.allowTableNodeSelection,
}),
+ TableDragStatePlugin,
TableInsertPlugin(this.editor),
TableColumnDragHandlePlugin(this.editor),
TableRowDragHandlePlugin(this.editor),