@blocknote/core 0.8.5 → 0.9.0

package/src/index.ts

@@ -15,3 +15,4 @@ export { getDefaultSlashMenuItems } from "./extensions/SlashMenu/defaultSlashMen
 export * from "./shared/BaseUiElementTypes";
 export type { SuggestionItem } from "./shared/plugins/suggestion/SuggestionItem";
 export * from "./shared/plugins/suggestion/SuggestionPlugin";
+export * from "./shared/utils";

package/src/shared/utils.ts

@@ -11,6 +11,10 @@ export function formatKeyboardShortcut(shortcut: string) {
   }
 }
 
+export function mergeCSSClasses(...classes: string[]) {
+  return classes.filter((c) => c).join(" ");
+}
+
 export class UnreachableCaseError extends Error {
   constructor(val: never) {
     super(`Unreachable case: ${val}`);

package/types/src/BlockNoteEditor.d.ts

@@ -1,7 +1,7 @@
 import { Node } from "prosemirror-model";
 import { Editor as TiptapEditor } from "@tiptap/core/dist/packages/core/src/Editor";
 import * as Y from "yjs";
-import { Block, BlockIdentifier, BlockSchema, PartialBlock } from "./extensions/Blocks/api/blockTypes";
+import { Block, BlockIdentifier, BlockNoteDOMAttributes, BlockSchema, PartialBlock } from "./extensions/Blocks/api/blockTypes";
 import { TextCursorPosition } from "./extensions/Blocks/api/cursorPositionTypes";
 import { DefaultBlockSchema } from "./extensions/Blocks/api/defaultBlocks";
 import { Styles } from "./extensions/Blocks/api/inlineContentTypes";
@@ -27,11 +27,11 @@ export type BlockNoteEditorOptions<BSchema extends BlockSchema> = {
      */
     parentElement: HTMLElement;
     /**
-     * An object containing attributes that should be added to the editor's HTML element.
+     * An object containing attributes that should be added to HTML elements of the editor.
      *
-     * @example { class: "my-editor-class" }
+     * @example { editor: { class: "my-editor-class" } }
      */
-    editorDOMAttributes: Record<string, string>;
+    domAttributes: Partial<BlockNoteDOMAttributes>;
     /**
      *  A callback function that runs when the editor is ready to be used.
      */
@@ -58,12 +58,6 @@ export type BlockNoteEditorOptions<BSchema extends BlockSchema> = {
      * @default true
      */
     defaultStyles: boolean;
-    /**
-     * Whether to use the light or dark theme.
-     *
-     * @default "light"
-     */
-    theme: "light" | "dark";
     /**
      * A list of block types that should be available in the editor.
      */

package/types/src/BlockNoteExtensions.d.ts

@@ -1,11 +1,13 @@
 import { Extensions } from "@tiptap/core";
 import { BlockNoteEditor } from "./BlockNoteEditor";
 import * as Y from "yjs";
+import { BlockNoteDOMAttributes } from "./extensions/Blocks/api/blockTypes";
 /**
  * Get all the Tiptap extensions BlockNote is configured with by default
  */
 export declare const getBlockNoteExtensions: <BSchema extends Record<string, import("./extensions/Blocks/api/blockTypes").BlockSpec<string, import("./extensions/Blocks/api/blockTypes").PropSchema>>>(opts: {
     editor: BlockNoteEditor<BSchema>;
+    domAttributes: Partial<BlockNoteDOMAttributes>;
     blockSchema: BSchema;
     collaboration?: {
         fragment: Y.XmlFragment;

package/types/src/extensions/Blocks/api/block.d.ts

@@ -1,4 +1,5 @@
 import { Attribute } from "@tiptap/core";
+import { BlockNoteDOMAttributes } from "../../..";
 import { BlockConfig, BlockSchema, BlockSpec, PropSchema, TipTapNode, TipTapNodeConfig } from "./blockTypes";
 export declare function camelToDataKebab(str: string): string;
 export declare function propsToAttributes<BType extends string, PSchema extends PropSchema, ContainsInlineContent extends boolean, BSchema extends BlockSchema>(blockConfig: Omit<BlockConfig<BType, PSchema, ContainsInlineContent, BSchema>, "render">): Record<string, Attribute>;
@@ -13,4 +14,8 @@ export declare function render<BType extends string, PSchema extends PropSchema,
     contentDOM?: undefined;
 };
 export declare function createBlockSpec<BType extends string, PSchema extends PropSchema, ContainsInlineContent extends boolean, BSchema extends BlockSchema>(blockConfig: BlockConfig<BType, PSchema, ContainsInlineContent, BSchema>): BlockSpec<BType, PSchema>;
-export declare function createTipTapBlock<Type extends string>(config: TipTapNodeConfig<Type>): TipTapNode<Type>;
+export declare function createTipTapBlock<Type extends string, Options extends {
+    domAttributes?: BlockNoteDOMAttributes;
+} = {
+    domAttributes?: BlockNoteDOMAttributes;
+}, Storage = any>(config: TipTapNodeConfig<Type, Options, Storage>): TipTapNode<Type, Options, Storage>;

package/types/src/extensions/Blocks/api/blockTypes.d.ts

@@ -3,10 +3,22 @@ import { Node, NodeConfig } from "@tiptap/core";
 import { BlockNoteEditor } from "../../../BlockNoteEditor";
 import { InlineContent, PartialInlineContent } from "./inlineContentTypes";
 import { DefaultBlockSchema } from "./defaultBlocks";
-export type TipTapNodeConfig<Name extends string, Options = any, Storage = any> = {
+export type BlockNoteDOMElement = "editor" | "blockContainer" | "blockGroup" | "blockContent" | "inlineContent";
+export type BlockNoteDOMAttributes = Partial<{
+    [DOMElement in BlockNoteDOMElement]: Record<string, string>;
+}>;
+export type TipTapNodeConfig<Name extends string, Options extends {
+    domAttributes?: BlockNoteDOMAttributes;
+} = {
+    domAttributes?: BlockNoteDOMAttributes;
+}, Storage = any> = {
     [K in keyof NodeConfig<Options, Storage>]: K extends "name" ? Name : K extends "group" ? never : NodeConfig<Options, Storage>[K];
 };
-export type TipTapNode<Name extends string, Options = any, Storage = any> = Node<Options, Storage> & {
+export type TipTapNode<Name extends string, Options extends {
+    domAttributes?: BlockNoteDOMAttributes;
+} = {
+    domAttributes?: BlockNoteDOMAttributes;
+}, Storage = any> = Node<Options, Storage> & {
     name: Name;
     group: "blockContent";
 };
@@ -45,7 +57,7 @@ export type BlockConfig<Type extends string, PSchema extends PropSchema, Contain
 };
 export type BlockSpec<Type extends string, PSchema extends PropSchema> = {
     readonly propSchema: PSchema;
-    node: TipTapNode<Type>;
+    node: TipTapNode<Type, any>;
 };
 export type TypesMatch<Blocks extends Record<string, BlockSpec<string, PropSchema>>> = Blocks extends {
     [Type in keyof Blocks]: Type extends string ? Blocks[Type] extends BlockSpec<Type, PropSchema> ? Blocks[Type] : never : never;

package/types/src/extensions/Blocks/api/defaultBlocks.d.ts

@@ -26,7 +26,15 @@ export declare const defaultBlockSchema: {
                 values: readonly ["left", "center", "right", "justify"];
             };
         };
-        readonly node: import("./blockTypes").TipTapNode<"paragraph">;
+        readonly node: import("./blockTypes").TipTapNode<"paragraph", {
+            domAttributes?: Partial<{
+                blockContainer: Record<string, string>;
+                blockGroup: Record<string, string>;
+                editor: Record<string, string>;
+                blockContent: Record<string, string>;
+                inlineContent: Record<string, string>;
+            }> | undefined;
+        }, any>;
     };
     readonly heading: {
         readonly propSchema: {
@@ -45,7 +53,15 @@ export declare const defaultBlockSchema: {
                 values: readonly ["left", "center", "right", "justify"];
             };
         };
-        readonly node: import("./blockTypes").TipTapNode<"heading">;
+        readonly node: import("./blockTypes").TipTapNode<"heading", {
+            domAttributes?: Partial<{
+                blockContainer: Record<string, string>;
+                blockGroup: Record<string, string>;
+                editor: Record<string, string>;
+                blockContent: Record<string, string>;
+                inlineContent: Record<string, string>;
+            }> | undefined;
+        }, any>;
     };
     readonly bulletListItem: {
         readonly propSchema: {
@@ -60,7 +76,15 @@ export declare const defaultBlockSchema: {
                 values: readonly ["left", "center", "right", "justify"];
             };
         };
-        readonly node: import("./blockTypes").TipTapNode<"bulletListItem">;
+        readonly node: import("./blockTypes").TipTapNode<"bulletListItem", {
+            domAttributes?: Partial<{
+                blockContainer: Record<string, string>;
+                blockGroup: Record<string, string>;
+                editor: Record<string, string>;
+                blockContent: Record<string, string>;
+                inlineContent: Record<string, string>;
+            }> | undefined;
+        }, any>;
     };
     readonly numberedListItem: {
         readonly propSchema: {
@@ -75,7 +99,15 @@ export declare const defaultBlockSchema: {
                 values: readonly ["left", "center", "right", "justify"];
             };
         };
-        readonly node: import("./blockTypes").TipTapNode<"numberedListItem">;
+        readonly node: import("./blockTypes").TipTapNode<"numberedListItem", {
+            domAttributes?: Partial<{
+                blockContainer: Record<string, string>;
+                blockGroup: Record<string, string>;
+                editor: Record<string, string>;
+                blockContent: Record<string, string>;
+                inlineContent: Record<string, string>;
+            }> | undefined;
+        }, any>;
     };
 };
 export type DefaultBlockSchema = TypesMatch<typeof defaultBlockSchema>;

package/types/src/extensions/Blocks/index.d.ts

@@ -1 +1,4 @@
-export declare const blocks: any[];
+import { Node } from "@tiptap/core";
+export { BlockContainer } from "./nodes/BlockContainer";
+export { BlockGroup } from "./nodes/BlockGroup";
+export declare const Doc: Node<any, any>;

package/types/src/extensions/Blocks/nodes/BlockContainer.d.ts

@@ -1,8 +1,5 @@
 import { Node } from "@tiptap/core";
 import { BlockSchema, PartialBlock } from "../api/blockTypes";
-export interface IBlock {
-    HTMLAttributes: Record<string, any>;
-}
 declare module "@tiptap/core" {
     interface Commands<ReturnType> {
         block: {
@@ -18,4 +15,12 @@ declare module "@tiptap/core" {
 /**
  * The main "Block node" documents consist of
  */
-export declare const BlockContainer: Node<IBlock, any>;
+export declare const BlockContainer: Node<{
+    domAttributes?: Partial<{
+        blockContainer: Record<string, string>;
+        blockGroup: Record<string, string>;
+        editor: Record<string, string>;
+        blockContent: Record<string, string>;
+        inlineContent: Record<string, string>;
+    }> | undefined;
+}, any>;

package/types/src/extensions/Blocks/nodes/BlockContent/HeadingBlockContent/HeadingBlockContent.d.ts

@@ -1 +1,9 @@
-export declare const HeadingBlockContent: import("../../../api/blockTypes").TipTapNode<"heading">;
+export declare const HeadingBlockContent: import("../../../api/blockTypes").TipTapNode<"heading", {
+    domAttributes?: Partial<{
+        blockContainer: Record<string, string>;
+        blockGroup: Record<string, string>;
+        editor: Record<string, string>;
+        blockContent: Record<string, string>;
+        inlineContent: Record<string, string>;
+    }> | undefined;
+}, any>;

package/types/src/extensions/Blocks/nodes/BlockContent/ListItemBlockContent/BulletListItemBlockContent/BulletListItemBlockContent.d.ts

@@ -1 +1,9 @@
-export declare const BulletListItemBlockContent: import("../../../../api/blockTypes").TipTapNode<"bulletListItem">;
+export declare const BulletListItemBlockContent: import("../../../../api/blockTypes").TipTapNode<"bulletListItem", {
+    domAttributes?: Partial<{
+        blockContainer: Record<string, string>;
+        blockGroup: Record<string, string>;
+        editor: Record<string, string>;
+        blockContent: Record<string, string>;
+        inlineContent: Record<string, string>;
+    }> | undefined;
+}, any>;

package/types/src/extensions/Blocks/nodes/BlockContent/ListItemBlockContent/NumberedListItemBlockContent/NumberedListItemBlockContent.d.ts

@@ -1 +1,9 @@
-export declare const NumberedListItemBlockContent: import("../../../../api/blockTypes").TipTapNode<"numberedListItem">;
+export declare const NumberedListItemBlockContent: import("../../../../api/blockTypes").TipTapNode<"numberedListItem", {
+    domAttributes?: Partial<{
+        blockContainer: Record<string, string>;
+        blockGroup: Record<string, string>;
+        editor: Record<string, string>;
+        blockContent: Record<string, string>;
+        inlineContent: Record<string, string>;
+    }> | undefined;
+}, any>;

package/types/src/extensions/Blocks/nodes/BlockContent/ParagraphBlockContent/ParagraphBlockContent.d.ts

@@ -1 +1,9 @@
-export declare const ParagraphBlockContent: import("../../../api/blockTypes").TipTapNode<"paragraph">;
+export declare const ParagraphBlockContent: import("../../../api/blockTypes").TipTapNode<"paragraph", {
+    domAttributes?: Partial<{
+        blockContainer: Record<string, string>;
+        blockGroup: Record<string, string>;
+        editor: Record<string, string>;
+        blockContent: Record<string, string>;
+        inlineContent: Record<string, string>;
+    }> | undefined;
+}, any>;

package/types/src/extensions/Blocks/nodes/BlockGroup.d.ts

@@ -1,2 +1,10 @@
 import { Node } from "@tiptap/core";
-export declare const BlockGroup: Node<any, any>;
+export declare const BlockGroup: Node<{
+    domAttributes?: Partial<{
+        blockContainer: Record<string, string>;
+        blockGroup: Record<string, string>;
+        editor: Record<string, string>;
+        blockContent: Record<string, string>;
+        inlineContent: Record<string, string>;
+    }> | undefined;
+}, any>;

package/types/src/index.d.ts

@@ -15,3 +15,4 @@ export { getDefaultSlashMenuItems } from "./extensions/SlashMenu/defaultSlashMen
 export * from "./shared/BaseUiElementTypes";
 export type { SuggestionItem } from "./shared/plugins/suggestion/SuggestionItem";
 export * from "./shared/plugins/suggestion/SuggestionPlugin";
+export * from "./shared/utils";

package/types/src/shared/utils.d.ts

@@ -1,5 +1,6 @@
 export declare const isAppleOS: () => boolean;
 export declare function formatKeyboardShortcut(shortcut: string): string;
+export declare function mergeCSSClasses(...classes: string[]): string;
 export declare class UnreachableCaseError extends Error {
     constructor(val: never);
 }

package/src/node_modules/.vitest/results.json

@@ -1 +0,0 @@
-{"version":"0.28.5","results":[["/api/formatConversions/formatConversions.test.ts",{"duration":109,"failed":false}],["/api/nodeConversions/nodeConversions.test.ts",{"duration":32,"failed":false}],["/api/blockManipulation/blockManipulation.test.ts",{"duration":38,"failed":false}],["/BlockNoteEditor.test.ts",{"duration":4,"failed":false}]]}