@blocknote/core 0.19.1 → 0.20.0

package/src/api/blockManipulation/selections/selection.ts

@@ -0,0 +1,244 @@
+import { TextSelection } from "prosemirror-state";
+import { TableMap } from "prosemirror-tables";
+
+import { Block } from "../../../blocks/defaultBlocks.js";
+import type { BlockNoteEditor } from "../../../editor/BlockNoteEditor";
+import { Selection } from "../../../editor/selectionTypes.js";
+import {
+  BlockIdentifier,
+  BlockSchema,
+  InlineContentSchema,
+  StyleSchema,
+} from "../../../schema/index.js";
+import { getBlockInfo, getNearestBlockPos } from "../../getBlockInfoFromPos.js";
+import { nodeToBlock } from "../../nodeConversions/nodeToBlock.js";
+import { getNodeById } from "../../nodeUtil.js";
+
+export function getSelection<
+  BSchema extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+>(
+  editor: BlockNoteEditor<BSchema, I, S>
+): Selection<BSchema, I, S> | undefined {
+  const state = editor._tiptapEditor.state;
+
+  const $startBlockBeforePos = state.doc.resolve(
+    getNearestBlockPos(state.doc, state.selection.from).posBeforeNode
+  );
+  const $endBlockBeforePos = state.doc.resolve(
+    getNearestBlockPos(state.doc, state.selection.to).posBeforeNode
+  );
+
+  // Return undefined if anchor and head are in the same block.
+  if ($startBlockBeforePos.pos === $endBlockBeforePos.pos) {
+    return undefined;
+  }
+
+  // Converts the node at the given index and depth around `$startBlockBeforePos`
+  // to a block. Used to get blocks at given indices at the shared depth and
+  // at the depth of `$startBlockBeforePos`.
+  const indexToBlock = (
+    index: number,
+    depth?: number
+  ): Block<BSchema, I, S> => {
+    const pos = $startBlockBeforePos.posAtIndex(index, depth);
+    const node = state.doc.resolve(pos).nodeAfter;
+
+    if (!node) {
+      throw new Error(
+        `Error getting selection - node not found at position ${pos}`
+      );
+    }
+
+    return nodeToBlock(
+      node,
+      editor.schema.blockSchema,
+      editor.schema.inlineContentSchema,
+      editor.schema.styleSchema,
+      editor.blockCache
+    );
+  };
+
+  const blocks: Block<BSchema, I, S>[] = [];
+  // Minimum depth at which the blocks share a common ancestor.
+  const sharedDepth = $startBlockBeforePos.sharedDepth($endBlockBeforePos.pos);
+  const startIndex = $startBlockBeforePos.index(sharedDepth);
+  const endIndex = $endBlockBeforePos.index(sharedDepth);
+
+  // In most cases, we want to return the blocks spanned by the selection at the
+  // shared depth. However, when the block in which the selection starts is at a
+  // higher depth than the shared depth, we omit the first block at the shared
+  // depth. Instead, we include the first block at its depth, and any blocks at
+  // a higher index up to the shared depth. The following  example illustrates
+  // this:
+  // - id-0
+  //   - id-1
+  //     - >|id-2
+  //     - id-3
+  //   - id-4
+  //     - id-5
+  //   - id-6
+  // - id-7
+  // - id-8
+  // - id-9|<
+  //   - id-10
+  // Here, each block is represented by its ID, and the selection is represented
+  // by the `>|` and `|<` markers. So the selection starts in block `id-2` and
+  // ends in block `id-8`. In this case, the shared depth is 0, since the blocks
+  // `id-6`, `id-7`, and `id-8` set the shared depth, as they are the least
+  // nested blocks spanned by the selection. Therefore, these blocks are all
+  // added to the `blocks` array. However, the selection starts in block `id-2`,
+  // which is at a higher depth than the shared depth. So we add block `id-2` to
+  // the `blocks` array, as well as any later siblings (in this case, `id-3`),
+  // and move up one level of depth. The ancestor of block `id-2` at this depth
+  // is block `id-1`, so we add all its later siblings to the `blocks` array as
+  // well, again moving up one level of depth. Since we're now at the shared
+  // depth, we are done. The final `blocks` array for this example would be:
+  // [ id-2, id-3, id-4, id-6, id-7, id-8, id-9 ]
+  if ($startBlockBeforePos.depth > sharedDepth) {
+    // Adds the block that the selection starts in.
+    blocks.push(
+      nodeToBlock(
+        $startBlockBeforePos.nodeAfter!,
+        editor.schema.blockSchema,
+        editor.schema.inlineContentSchema,
+        editor.schema.styleSchema,
+        editor.blockCache
+      )
+    );
+
+    // Traverses all depths from the depth of the block in which the selection
+    // starts, up to the shared depth.
+    for (let depth = $startBlockBeforePos.depth; depth > sharedDepth; depth--) {
+      const parentNode = $startBlockBeforePos.node(depth);
+
+      if (parentNode.type.isInGroup("childContainer")) {
+        const startIndexAtDepth = $startBlockBeforePos.index(depth) + 1;
+        const childCountAtDepth = $startBlockBeforePos.node(depth).childCount;
+
+        // Adds all blocks after the index of the block in which the selection
+        // starts (or its ancestors at lower depths).
+        for (let i = startIndexAtDepth; i < childCountAtDepth; i++) {
+          blocks.push(indexToBlock(i, depth));
+        }
+      }
+    }
+  } else {
+    // Adds the first block spanned by the selection at the shared depth.
+    blocks.push(indexToBlock(startIndex, sharedDepth));
+  }
+
+  // Adds all blocks spanned by the selection at the shared depth, excluding
+  // the first.
+  for (let i = startIndex + 1; i <= endIndex; i++) {
+    blocks.push(indexToBlock(i, sharedDepth));
+  }
+
+  if (blocks.length === 0) {
+    throw new Error(
+      `Error getting selection - selection doesn't span any blocks (${state.selection})`
+    );
+  }
+
+  return {
+    blocks,
+  };
+}
+
+export function setSelection<
+  BSchema extends BlockSchema,
+  I extends InlineContentSchema,
+  S extends StyleSchema
+>(
+  editor: BlockNoteEditor<BSchema, I, S>,
+  startBlock: BlockIdentifier,
+  endBlock: BlockIdentifier
+) {
+  const startBlockId =
+    typeof startBlock === "string" ? startBlock : startBlock.id;
+  const endBlockId = typeof endBlock === "string" ? endBlock : endBlock.id;
+
+  if (startBlockId === endBlockId) {
+    throw new Error(
+      `Attempting to set selection with the same anchor and head blocks (id ${startBlockId})`
+    );
+  }
+
+  const doc = editor._tiptapEditor.state.doc;
+
+  const anchorPosInfo = getNodeById(startBlockId, doc);
+  if (!anchorPosInfo) {
+    throw new Error(`Block with ID ${startBlockId} not found`);
+  }
+  const headPosInfo = getNodeById(endBlockId, doc);
+  if (!headPosInfo) {
+    throw new Error(`Block with ID ${endBlockId} not found`);
+  }
+
+  const anchorBlockInfo = getBlockInfo(anchorPosInfo);
+  const headBlockInfo = getBlockInfo(headPosInfo);
+
+  const anchorBlockConfig =
+    editor.schema.blockSchema[
+      anchorBlockInfo.blockNoteType as keyof typeof editor.schema.blockSchema
+    ];
+  const headBlockConfig =
+    editor.schema.blockSchema[
+      headBlockInfo.blockNoteType as keyof typeof editor.schema.blockSchema
+    ];
+
+  if (
+    !anchorBlockInfo.isBlockContainer ||
+    anchorBlockConfig.content === "none"
+  ) {
+    throw new Error(
+      `Attempting to set selection anchor in block without content (id ${startBlockId})`
+    );
+  }
+  if (!headBlockInfo.isBlockContainer || headBlockConfig.content === "none") {
+    throw new Error(
+      `Attempting to set selection anchor in block without content (id ${endBlockId})`
+    );
+  }
+
+  let startPos: number;
+  let endPos: number;
+
+  if (anchorBlockConfig.content === "table") {
+    const tableMap = TableMap.get(anchorBlockInfo.blockContent.node);
+    const firstCellPos =
+      anchorBlockInfo.blockContent.beforePos +
+      tableMap.positionAt(0, 0, anchorBlockInfo.blockContent.node) +
+      1;
+    startPos = firstCellPos + 2;
+  } else {
+    startPos = anchorBlockInfo.blockContent.beforePos + 1;
+  }
+
+  if (headBlockConfig.content === "table") {
+    const tableMap = TableMap.get(headBlockInfo.blockContent.node);
+    const lastCellPos =
+      headBlockInfo.blockContent.beforePos +
+      tableMap.positionAt(
+        tableMap.height - 1,
+        tableMap.width - 1,
+        headBlockInfo.blockContent.node
+      ) +
+      1;
+    const lastCellNodeSize = doc.resolve(lastCellPos).nodeAfter!.nodeSize;
+    endPos = lastCellPos + lastCellNodeSize - 2;
+  } else {
+    endPos = headBlockInfo.blockContent.afterPos - 1;
+  }
+
+  // TODO: We should polish up the `MultipleNodeSelection` and use that instead.
+  //  Right now it's missing a few things like a jsonID and styling to show
+  //  which nodes are selected. `TextSelection` is ok for now, but has the
+  //  restriction that the start/end blocks must have content.
+  editor._tiptapEditor.dispatch(
+    editor._tiptapEditor.state.tr.setSelection(
+      TextSelection.create(editor._tiptapEditor.state.doc, startPos, endPos)
+    )
+  );
+}

package/src/api/blockManipulation/selections/textCursorPosition/textCursorPosition.ts

@@ -96,6 +96,10 @@ export function setTextCursorPosition<
   const id = typeof targetBlock === "string" ? targetBlock : targetBlock.id;
 
   const posInfo = getNodeById(id, editor._tiptapEditor.state.doc);
+  if (!posInfo) {
+    throw new Error(`Block with ID ${id} not found`);
+  }
+
   const info = getBlockInfo(posInfo);
 
   const contentType: "none" | "inline" | "table" =

package/src/api/clipboard/fromClipboard/handleVSCodePaste.ts

@@ -18,9 +18,6 @@ export async function handleVSCodePaste<
   }
 
   const text = event.clipboardData!.getData("text/plain");
-  const vscode = event.clipboardData!.getData("vscode-editor-data");
-  const vscodeData = vscode ? JSON.parse(vscode) : undefined;
-  const language = vscodeData?.mode;
 
   if (!text) {
     return false;
@@ -28,10 +25,13 @@ export async function handleVSCodePaste<
 
   if (!schema.nodes.codeBlock) {
     view.pasteText(text);
-
     return true;
   }
 
+  const vscode = event.clipboardData!.getData("vscode-editor-data");
+  const vscodeData = vscode ? JSON.parse(vscode) : undefined;
+  const language = vscodeData?.mode;
+
   if (!language) {
     return false;
   }

package/src/api/nodeUtil.ts

@@ -6,7 +6,7 @@ import { Node } from "prosemirror-model";
 export function getNodeById(
   id: string,
   doc: Node
-): { node: Node; posBeforeNode: number } {
+): { node: Node; posBeforeNode: number } | undefined {
   let targetNode: Node | undefined = undefined;
   let posBeforeNode: number | undefined = undefined;
 
@@ -28,7 +28,7 @@ export function getNodeById(
   });
 
   if (targetNode === undefined || posBeforeNode === undefined) {
-    throw Error("Could not find block in the editor with matching ID.");
+    return undefined;
   }
 
   return {

package/src/blocks/CodeBlockContent/CodeBlockContent.ts

@@ -47,11 +47,15 @@ const CodeBlockContent = createStronglyTypedTiptapNode({
     };
   },
   addAttributes() {
+    const supportedLanguages = this.options
+      .supportedLanguages as SupportedLanguageConfig[];
+
     return {
       language: {
         default: this.options.defaultLanguage,
         parseHTML: (inputElement) => {
           let element = inputElement as HTMLElement | null;
+          let language: string | null = null;
 
           if (
             element?.tagName === "DIV" &&
@@ -67,20 +71,26 @@ const CodeBlockContent = createStronglyTypedTiptapNode({
           const dataLanguage = element?.getAttribute("data-language");
 
           if (dataLanguage) {
-            return dataLanguage.toLowerCase();
+            language = dataLanguage.toLowerCase();
+          } else {
+            const classNames = [...(element?.className.split(" ") || [])];
+            const languages = classNames
+              .filter((className) => className.startsWith("language-"))
+              .map((className) => className.replace("language-", ""));
+            const [classLanguage] = languages;
+
+            language = classLanguage.toLowerCase();
           }
 
-          const classNames = [...(element?.className.split(" ") || [])];
-          const languages = classNames
-            .filter((className) => className.startsWith("language-"))
-            .map((className) => className.replace("language-", ""));
-          const [language] = languages;
-
           if (!language) {
             return null;
           }
 
-          return language.toLowerCase();
+          return (
+            supportedLanguages.find(({ match }) => {
+              return match.includes(language);
+            })?.id || this.options.defaultLanguage
+          );
         },
         renderHTML: (attributes) => {
           return attributes.language && attributes.language !== "text"

package/src/blocks/CodeBlockContent/defaultSupportedLanguages.ts

@@ -1,4 +1,4 @@
-import { bundledLanguagesInfo } from "shiki/bundle/web";
+import { bundledLanguagesInfo } from "shiki";
 
 export type SupportedLanguageConfig = {
   id: string;
@@ -14,23 +14,42 @@ export const defaultSupportedLanguages: SupportedLanguageConfig[] = [
   },
   ...bundledLanguagesInfo
     .filter((lang) => {
-      return ![
-        "angular-html",
-        "angular-ts",
-        "astro",
-        "blade",
-        "coffee",
-        "handlebars",
-        "html-derivative",
-        "http",
-        "imba",
-        "jinja",
-        "jison",
-        "json5",
-        "marko",
-        "mdc",
-        "stylus",
-        "ts-tags",
+      return [
+        "c",
+        "cpp",
+        "css",
+        "glsl",
+        "graphql",
+        "haml",
+        "html",
+        "java",
+        "javascript",
+        "json",
+        "jsonc",
+        "jsonl",
+        "jsx",
+        "julia",
+        "less",
+        "markdown",
+        "mdx",
+        "php",
+        "postcss",
+        "pug",
+        "python",
+        "r",
+        "regexp",
+        "sass",
+        "scss",
+        "shellscript",
+        "sql",
+        "svelte",
+        "typescript",
+        "vue",
+        "vue-html",
+        "wasm",
+        "wgsl",
+        "xml",
+        "yaml",
       ].includes(lang.id);
     })
     .map((lang) => ({
@@ -38,6 +57,7 @@ export const defaultSupportedLanguages: SupportedLanguageConfig[] = [
       id: lang.id,
       name: lang.name,
     })),
+  { id: "tsx", name: "TSX", match: ["tsx", "typescriptreact"] },
   {
     id: "haskell",
     name: "Haskell",

package/src/blocks/TableBlockContent/TableExtension.ts

@@ -1,5 +1,5 @@
 import { callOrReturn, Extension, getExtensionField } from "@tiptap/core";
-import { columnResizing, tableEditing } from "prosemirror-tables";
+import { columnResizing, goToNextCell, tableEditing } from "prosemirror-tables";
 
 export const RESIZE_MIN_WIDTH = 35;
 export const EMPTY_CELL_WIDTH = 120;
@@ -53,6 +53,17 @@ export const TableExtension = Extension.create({
           selectionIsInTableParagraphNode
         );
       },
+      // Enables navigating cells using the tab key.
+      Tab: () => {
+        return this.editor.commands.command(({ state, dispatch, view }) =>
+          goToNextCell(1)(state, dispatch, view)
+        );
+      },
+      "Shift-Tab": () => {
+        return this.editor.commands.command(({ state, dispatch, view }) =>
+          goToNextCell(-1)(state, dispatch, view)
+        );
+      },
     };
   },
 

package/src/editor/Block.css

@@ -299,6 +299,9 @@ NESTED BLOCKS
   transition: opacity 0.3s;
   transition-delay: 1s;
 }
+.bn-block-content[data-content-type="codeBlock"] > div > select > option {
+  color: black;
+}
 .bn-block-content[data-content-type="codeBlock"]:hover > div > select,
 .bn-block-content[data-content-type="codeBlock"] > div > select:focus {
   opacity: 0.5;