@blocknote/core 0.16.0 → 0.17.1

package/src/api/blockManipulation/commands/moveBlock/moveBlock.test.ts

@@ -0,0 +1,192 @@
+import { NodeSelection, TextSelection } from "prosemirror-state";
+import { CellSelection } from "prosemirror-tables";
+import { describe, expect, it } from "vitest";
+
+import { getBlockInfoFromSelection } from "../../../getBlockInfoFromPos.js";
+import { setupTestEnv } from "../../setupTestEnv.js";
+import {
+  moveBlockDown,
+  moveBlockUp,
+  moveSelectedBlockAndSelection,
+} from "./moveBlock.js";
+
+const getEditor = setupTestEnv();
+
+function makeSelectionSpanContent(selectionType: "text" | "node" | "cell") {
+  const { blockContent } = getBlockInfoFromSelection(
+    getEditor()._tiptapEditor.state
+  );
+
+  if (selectionType === "cell") {
+    getEditor()._tiptapEditor.view.dispatch(
+      getEditor()._tiptapEditor.state.tr.setSelection(
+        CellSelection.create(
+          getEditor()._tiptapEditor.state.doc,
+          getEditor()
+            ._tiptapEditor.state.doc.resolve(blockContent.beforePos + 3)
+            .before(),
+          getEditor()
+            ._tiptapEditor.state.doc.resolve(blockContent.afterPos - 3)
+            .before()
+        )
+      )
+    );
+  } else if (selectionType === "node") {
+    const resolvedContentStartPos = getEditor()._tiptapEditor.state.doc.resolve(
+      blockContent.beforePos
+    );
+
+    getEditor()._tiptapEditor.view.dispatch(
+      getEditor()._tiptapEditor.state.tr.setSelection(
+        NodeSelection.create(
+          getEditor()._tiptapEditor.state.doc,
+          getEditor()
+            ._tiptapEditor.state.doc.resolve(
+              resolvedContentStartPos.after(resolvedContentStartPos.depth + 1)
+            )
+            .start()
+        )
+      )
+    );
+  } else {
+    const resolvedContentStartPos = getEditor()._tiptapEditor.state.doc.resolve(
+      blockContent.beforePos
+    );
+    const resolvedContentEndPos = getEditor()._tiptapEditor.state.doc.resolve(
+      blockContent.afterPos
+    );
+
+    getEditor()._tiptapEditor.view.dispatch(
+      getEditor()._tiptapEditor.state.tr.setSelection(
+        TextSelection.create(
+          getEditor()._tiptapEditor.state.doc,
+          getEditor()
+            ._tiptapEditor.state.doc.resolve(
+              resolvedContentStartPos.after(resolvedContentStartPos.depth + 1)
+            )
+            .start(),
+          getEditor()
+            ._tiptapEditor.state.doc.resolve(
+              resolvedContentEndPos.before(resolvedContentEndPos.depth + 1)
+            )
+            .end()
+        )
+      )
+    );
+  }
+}
+
+describe("Test moveSelectedBlockAndSelection", () => {
+  it("Text selection", () => {
+    getEditor().setTextCursorPosition("paragraph-1");
+    makeSelectionSpanContent("text");
+
+    moveSelectedBlockAndSelection(getEditor(), "paragraph-0", "before");
+
+    const selection = getEditor()._tiptapEditor.state.selection;
+    getEditor().setTextCursorPosition("paragraph-1");
+    makeSelectionSpanContent("text");
+
+    expect(
+      selection.eq(getEditor()._tiptapEditor.state.selection)
+    ).toBeTruthy();
+  });
+
+  it("Node selection", () => {
+    getEditor().setTextCursorPosition("image-0");
+    makeSelectionSpanContent("node");
+
+    moveSelectedBlockAndSelection(getEditor(), "paragraph-0", "before");
+
+    const selection = getEditor()._tiptapEditor.state.selection;
+    getEditor().setTextCursorPosition("image-0");
+    makeSelectionSpanContent("node");
+
+    expect(
+      selection.eq(getEditor()._tiptapEditor.state.selection)
+    ).toBeTruthy();
+  });
+
+  it("Cell selection", () => {
+    getEditor().setTextCursorPosition("table-0");
+    makeSelectionSpanContent("cell");
+
+    moveSelectedBlockAndSelection(getEditor(), "paragraph-0", "before");
+
+    const selection = getEditor()._tiptapEditor.state.selection;
+    getEditor().setTextCursorPosition("table-0");
+    makeSelectionSpanContent("cell");
+
+    expect(
+      selection.eq(getEditor()._tiptapEditor.state.selection)
+    ).toBeTruthy();
+  });
+});
+
+describe("Test moveBlockUp", () => {
+  it("Basic", () => {
+    getEditor().setTextCursorPosition("paragraph-1");
+
+    moveBlockUp(getEditor());
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Into children", () => {
+    getEditor().setTextCursorPosition("paragraph-2");
+
+    moveBlockUp(getEditor());
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Out of children", () => {
+    getEditor().setTextCursorPosition("nested-paragraph-1");
+
+    moveBlockUp(getEditor());
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("First block", () => {
+    getEditor().setTextCursorPosition("paragraph-0");
+
+    moveBlockUp(getEditor());
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+});
+
+describe("Test moveBlockDown", () => {
+  it("Basic", () => {
+    getEditor().setTextCursorPosition("paragraph-0");
+
+    moveBlockDown(getEditor());
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Into children", () => {
+    getEditor().setTextCursorPosition("paragraph-1");
+
+    moveBlockDown(getEditor());
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Out of children", () => {
+    getEditor().setTextCursorPosition("nested-paragraph-1");
+
+    moveBlockDown(getEditor());
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Last block", () => {
+    getEditor().setTextCursorPosition("trailing-paragraph");
+
+    moveBlockDown(getEditor());
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+});

package/src/api/blockManipulation/commands/moveBlock/moveBlock.ts

@@ -0,0 +1,178 @@
+import { NodeSelection, Selection, TextSelection } from "prosemirror-state";
+import { CellSelection } from "prosemirror-tables";
+
+import type { BlockNoteEditor } from "../../../../editor/BlockNoteEditor";
+import { BlockIdentifier } from "../../../../schema/index.js";
+import { getBlockInfoFromSelection } from "../../../getBlockInfoFromPos.js";
+import { getNodeById } from "../../../nodeUtil.js";
+
+type BlockSelectionData = (
+  | {
+      type: "text";
+      anchor: number;
+      head: number;
+    }
+  | {
+      type: "node";
+      from: number;
+    }
+  | {
+      type: "cell";
+      anchorCell: number;
+      headCell: number;
+    }
+) & {
+  blockId: string;
+  blockPos: number;
+};
+
+// `getBlockSelectionData` and `updateBlockSelectionFromData` are used to save
+// and restore the selection within a block, when the block is moved.
+function getBlockSelectionData(
+  editor: BlockNoteEditor<any, any, any>
+): BlockSelectionData {
+  const { blockContainer } = getBlockInfoFromSelection(
+    editor._tiptapEditor.state
+  );
+
+  const selectionData = {
+    blockId: blockContainer.node.attrs.id,
+    blockPos: blockContainer.beforePos,
+  };
+
+  if (editor._tiptapEditor.state.selection instanceof CellSelection) {
+    return {
+      ...selectionData,
+      type: "cell" as const,
+      anchorCell: (editor._tiptapEditor.state.selection as CellSelection)
+        .$anchorCell.pos,
+      headCell: (editor._tiptapEditor.state.selection as CellSelection)
+        .$headCell.pos,
+    };
+  } else if (editor._tiptapEditor.state.selection instanceof NodeSelection) {
+    return {
+      ...selectionData,
+      type: "node" as const,
+      from: editor._tiptapEditor.state.selection.from,
+    };
+  } else {
+    return {
+      ...selectionData,
+      type: "text" as const,
+      anchor: editor._tiptapEditor.state.selection.anchor,
+      head: editor._tiptapEditor.state.selection.head,
+    };
+  }
+}
+
+function updateBlockSelectionFromData(
+  editor: BlockNoteEditor<any, any, any>,
+  data: BlockSelectionData
+) {
+  const blockPos = getNodeById(
+    data.blockId,
+    editor._tiptapEditor.state.doc
+  ).posBeforeNode;
+
+  let selection: Selection;
+  if (data.type === "cell") {
+    selection = CellSelection.create(
+      editor._tiptapEditor.state.doc,
+      data.anchorCell + (blockPos - data.blockPos),
+      data.headCell + (blockPos - data.blockPos)
+    );
+  } else if (data.type === "node") {
+    selection = NodeSelection.create(
+      editor._tiptapEditor.state.doc,
+      data.from + (blockPos - data.blockPos)
+    );
+  } else {
+    selection = TextSelection.create(
+      editor._tiptapEditor.state.doc,
+      data.anchor + (blockPos - data.blockPos),
+      data.head + (blockPos - data.blockPos)
+    );
+  }
+
+  editor._tiptapEditor.view.dispatch(
+    editor._tiptapEditor.state.tr.setSelection(selection)
+  );
+}
+
+export function moveSelectedBlockAndSelection(
+  editor: BlockNoteEditor<any, any, any>,
+  referenceBlock: BlockIdentifier,
+  placement: "before" | "after"
+) {
+  const { block } = editor.getTextCursorPosition();
+  const selectionData = getBlockSelectionData(editor);
+
+  editor.removeBlocks([block]);
+  editor.insertBlocks([block], referenceBlock, placement);
+
+  updateBlockSelectionFromData(editor, selectionData);
+}
+
+export function moveBlockUp(editor: BlockNoteEditor<any, any, any>) {
+  // This function currently only supports moving a single block.
+  const editorSelection = editor.getSelection();
+  if (editorSelection && editorSelection.blocks.length > 1) {
+    return;
+  }
+
+  const { prevBlock, parentBlock } = editor.getTextCursorPosition();
+
+  let referenceBlockId: string | undefined;
+  let placement: "before" | "after" | undefined;
+
+  if (!prevBlock) {
+    if (parentBlock) {
+      referenceBlockId = parentBlock.id;
+      placement = "before";
+    }
+  } else if (prevBlock.children.length > 0) {
+    referenceBlockId = prevBlock.children[prevBlock.children.length - 1].id;
+    placement = "after";
+  } else {
+    referenceBlockId = prevBlock.id;
+    placement = "before";
+  }
+
+  if (!referenceBlockId || !placement) {
+    return;
+  }
+
+  moveSelectedBlockAndSelection(editor, referenceBlockId, placement);
+}
+
+export function moveBlockDown(editor: BlockNoteEditor<any, any, any>) {
+  // This function currently only supports moving a single block.
+  const editorSelection = editor.getSelection();
+  if (editorSelection && editorSelection.blocks.length > 1) {
+    return;
+  }
+
+  const { nextBlock, parentBlock } = editor.getTextCursorPosition();
+
+  let referenceBlockId: string | undefined;
+  let placement: "before" | "after" | undefined;
+
+  if (!nextBlock) {
+    if (parentBlock) {
+      referenceBlockId = parentBlock.id;
+      placement = "after";
+    }
+  } else if (nextBlock.children.length > 0) {
+    referenceBlockId = nextBlock.children[0].id;
+    placement = "before";
+  } else {
+    referenceBlockId = nextBlock.id;
+    placement = "after";
+  }
+
+  if (!referenceBlockId || !placement) {
+    return;
+  }
+
+  moveSelectedBlockAndSelection(editor, referenceBlockId, placement);
+}