@blocknote/core 0.16.0 → 0.17.1

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

@@ -0,0 +1,136 @@
+import { Node } from "prosemirror-model";
+import { TextSelection } from "prosemirror-state";
+import { describe, expect, it } from "vitest";
+
+import {
+  getBlockInfo,
+  getBlockInfoFromSelection,
+} from "../../../getBlockInfoFromPos.js";
+import { getNodeById } from "../../../nodeUtil.js";
+import { setupTestEnv } from "../../setupTestEnv.js";
+import { splitBlockCommand } from "./splitBlock.js";
+
+const getEditor = setupTestEnv();
+
+function splitBlock(
+  posInBlock: number,
+  keepType?: boolean,
+  keepProps?: boolean
+) {
+  getEditor()._tiptapEditor.commands.command(
+    splitBlockCommand(posInBlock, keepType, keepProps)
+  );
+}
+
+function setSelectionWithOffset(
+  doc: Node,
+  targetBlockId: string,
+  offset: number
+) {
+  const posInfo = getNodeById(targetBlockId, doc);
+  const { blockContent } = getBlockInfo(posInfo);
+
+  getEditor()._tiptapEditor.view.dispatch(
+    getEditor()._tiptapEditor.state.tr.setSelection(
+      TextSelection.create(doc, blockContent.beforePos + offset + 1)
+    )
+  );
+}
+
+describe("Test splitBlocks", () => {
+  it("Basic", () => {
+    setSelectionWithOffset(
+      getEditor()._tiptapEditor.state.doc,
+      "paragraph-0",
+      4
+    );
+
+    splitBlock(getEditor()._tiptapEditor.state.selection.anchor);
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("End of content", () => {
+    setSelectionWithOffset(
+      getEditor()._tiptapEditor.state.doc,
+      "paragraph-0",
+      11
+    );
+
+    splitBlock(getEditor()._tiptapEditor.state.selection.anchor);
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Block has children", () => {
+    setSelectionWithOffset(
+      getEditor()._tiptapEditor.state.doc,
+      "paragraph-with-children",
+      4
+    );
+
+    splitBlock(getEditor()._tiptapEditor.state.selection.anchor);
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Keep type", () => {
+    setSelectionWithOffset(getEditor()._tiptapEditor.state.doc, "heading-0", 4);
+
+    splitBlock(getEditor()._tiptapEditor.state.selection.anchor, true);
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Don't keep type", () => {
+    setSelectionWithOffset(getEditor()._tiptapEditor.state.doc, "heading-0", 4);
+
+    splitBlock(getEditor()._tiptapEditor.state.selection.anchor, false);
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it.skip("Keep props", () => {
+    setSelectionWithOffset(
+      getEditor()._tiptapEditor.state.doc,
+      "paragraph-with-props",
+      4
+    );
+
+    splitBlock(getEditor()._tiptapEditor.state.selection.anchor, false, true);
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Don't keep props", () => {
+    setSelectionWithOffset(
+      getEditor()._tiptapEditor.state.doc,
+      "paragraph-with-props",
+      4
+    );
+
+    splitBlock(getEditor()._tiptapEditor.state.selection.anchor, false, false);
+
+    expect(getEditor().document).toMatchSnapshot();
+  });
+
+  it("Selection is set", () => {
+    setSelectionWithOffset(
+      getEditor()._tiptapEditor.state.doc,
+      "paragraph-0",
+      4
+    );
+
+    splitBlock(getEditor()._tiptapEditor.state.selection.anchor);
+
+    const { blockContainer } = getBlockInfoFromSelection(
+      getEditor()._tiptapEditor.state
+    );
+
+    const anchorIsAtStartOfNewBlock =
+      blockContainer.node.attrs.id === "0" &&
+      getEditor()._tiptapEditor.state.selection.$anchor.parentOffset === 0;
+
+    expect(anchorIsAtStartOfNewBlock).toBeTruthy();
+  });
+});

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

@@ -0,0 +1,48 @@
+import { EditorState } from "prosemirror-state";
+
+import {
+  getBlockInfo,
+  getNearestBlockContainerPos,
+} from "../../../getBlockInfoFromPos.js";
+
+export const splitBlockCommand = (
+  posInBlock: number,
+  keepType?: boolean,
+  keepProps?: boolean
+) => {
+  return ({
+    state,
+    dispatch,
+  }: {
+    state: EditorState;
+    dispatch: ((args?: any) => any) | undefined;
+  }) => {
+    const nearestBlockContainerPos = getNearestBlockContainerPos(
+      state.doc,
+      posInBlock
+    );
+
+    const { blockContainer, blockContent } = getBlockInfo(
+      nearestBlockContainerPos
+    );
+
+    const types = [
+      {
+        type: blockContainer.node.type, // always keep blockcontainer type
+        attrs: keepProps ? { ...blockContainer.node.attrs, id: undefined } : {},
+      },
+      {
+        type: keepType
+          ? blockContent.node.type
+          : state.schema.nodes["paragraph"],
+        attrs: keepProps ? { ...blockContent.node.attrs } : {},
+      },
+    ];
+
+    if (dispatch) {
+      state.tr.split(posInBlock, 2, types);
+    }
+
+    return true;
+  };
+};