@blocknote/core 0.21.0 → 0.23.0

package/types/src/api/testUtil/cases/customInlineContent.d.ts

@@ -139,6 +139,10 @@ declare const schema: BlockNoteSchema<import("../../../index.js").BlockSchemaFro
             type: "numberedListItem";
             content: "inline";
             propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
                 backgroundColor: {
                     default: "default";
                 };
@@ -155,6 +159,10 @@ declare const schema: BlockNoteSchema<import("../../../index.js").BlockSchemaFro
             type: "numberedListItem";
             content: "inline";
             propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
                 backgroundColor: {
                     default: "default";
                 };

package/types/src/api/testUtil/cases/customStyles.d.ts

@@ -139,6 +139,10 @@ declare const schema: BlockNoteSchema<import("../../../index.js").BlockSchemaFro
             type: "numberedListItem";
             content: "inline";
             propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
                 backgroundColor: {
                     default: "default";
                 };
@@ -155,6 +159,10 @@ declare const schema: BlockNoteSchema<import("../../../index.js").BlockSchemaFro
             type: "numberedListItem";
             content: "inline";
             propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
                 backgroundColor: {
                     default: "default";
                 };

package/types/src/api/testUtil/cases/defaultSchema.d.ts

@@ -1,3 +1,4 @@
 import { EditorTestCases } from "../index.js";
 import { DefaultBlockSchema, DefaultInlineContentSchema, DefaultStyleSchema } from "../../../blocks/defaultBlocks.js";
-export declare const defaultSchemaTestCases: EditorTestCases<DefaultBlockSchema, DefaultInlineContentSchema, DefaultStyleSchema>;
+import { pageBreakSchema } from "../../../blocks/PageBreakBlockContent/schema.js";
+export declare const defaultSchemaTestCases: EditorTestCases<DefaultBlockSchema & typeof pageBreakSchema.blockSchema, DefaultInlineContentSchema, DefaultStyleSchema>;

package/types/src/blocks/CodeBlockContent/CodeBlockContent.d.ts

@@ -4,6 +4,8 @@ interface CodeBlockOptions {
     indentLineWithTab: boolean;
     supportedLanguages: SupportedLanguageConfig[];
 }
+export declare const shikiParserSymbol: unique symbol;
+export declare const shikiHighlighterPromiseSymbol: unique symbol;
 export declare const defaultCodeBlockPropSchema: {
     language: {
         default: string;

package/types/src/blocks/ListItemBlockContent/NumberedListItemBlockContent/NumberedListItemBlockContent.d.ts

@@ -1,4 +1,8 @@
 export declare const numberedListItemPropSchema: {
+    start: {
+        default: undefined;
+        type: "number";
+    };
     backgroundColor: {
         default: "default";
     };
@@ -15,6 +19,10 @@ export declare const NumberedListItem: {
         type: "numberedListItem";
         content: "inline";
         propSchema: {
+            start: {
+                default: undefined;
+                type: "number";
+            };
             backgroundColor: {
                 default: "default";
             };
@@ -31,6 +39,10 @@ export declare const NumberedListItem: {
         type: "numberedListItem";
         content: "inline";
         propSchema: {
+            start: {
+                default: undefined;
+                type: "number";
+            };
             backgroundColor: {
                 default: "default";
             };

package/types/src/blocks/PageBreakBlockContent/PageBreakBlockContent.d.ts

@@ -0,0 +1,31 @@
+import { Props } from "../../schema/index.js";
+export declare const pageBreakConfig: {
+    type: "pageBreak";
+    propSchema: {};
+    content: "none";
+    isFileBlock: false;
+    isSelectable: false;
+};
+export declare const pageBreakRender: () => {
+    dom: HTMLDivElement;
+};
+export declare const pageBreakParse: (element: HTMLElement) => Partial<Props<typeof pageBreakConfig.propSchema>> | undefined;
+export declare const pageBreakToExternalHTML: () => {
+    dom: HTMLDivElement;
+};
+export declare const PageBreak: {
+    config: {
+        type: "pageBreak";
+        propSchema: {};
+        content: "none";
+        isFileBlock: false;
+        isSelectable: false;
+    };
+    implementation: import("../../schema/index.js").TiptapBlockImplementation<{
+        type: "pageBreak";
+        propSchema: {};
+        content: "none";
+        isFileBlock: false;
+        isSelectable: false;
+    }, any, import("../../schema/index.js").InlineContentSchema, import("../../schema/index.js").StyleSchema>;
+};

package/types/src/blocks/PageBreakBlockContent/getPageBreakSlashMenuItems.d.ts

@@ -0,0 +1,8 @@
+import { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
+import { DefaultSuggestionItem } from "../../extensions/SuggestionMenu/DefaultSuggestionItem.js";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../schema/index.js";
+import { pageBreakSchema } from "./schema.js";
+export declare function checkPageBreakBlocksInSchema<I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<any, I, S>): editor is BlockNoteEditor<typeof pageBreakSchema.blockSchema, I, S>;
+export declare function getPageBreakSlashMenuItems<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>): (Omit<DefaultSuggestionItem, "key"> & {
+    key: "page_break";
+})[];

package/types/src/blocks/PageBreakBlockContent/schema.d.ts

@@ -0,0 +1,86 @@
+import { BlockNoteSchema } from "../../editor/BlockNoteSchema.js";
+import { InlineContentSchema, StyleSchema } from "../../schema/index.js";
+import { PageBreak } from "./PageBreakBlockContent.js";
+export declare const pageBreakSchema: BlockNoteSchema<import("../../schema/index.js").BlockSchemaFromSpecs<{
+    pageBreak: {
+        config: {
+            type: "pageBreak";
+            propSchema: {};
+            content: "none";
+            isFileBlock: false;
+            isSelectable: false;
+        };
+        implementation: import("../../schema/index.js").TiptapBlockImplementation<{
+            type: "pageBreak";
+            propSchema: {};
+            content: "none";
+            isFileBlock: false;
+            isSelectable: false;
+        }, any, InlineContentSchema, StyleSchema>;
+    };
+}>, import("../../schema/index.js").InlineContentSchemaFromSpecs<{
+    text: {
+        config: "text";
+        implementation: any;
+    };
+    link: {
+        config: "link";
+        implementation: any;
+    };
+}>, import("../../schema/index.js").StyleSchemaFromSpecs<{
+    bold: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+    italic: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+    underline: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+    strike: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+    code: {
+        config: {
+            type: string;
+            propSchema: "boolean";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+    textColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+    backgroundColor: {
+        config: {
+            type: string;
+            propSchema: "string";
+        };
+        implementation: import("../../schema/index.js").StyleImplementation;
+    };
+}>>;
+/**
+ * Adds page break support to the given schema.
+ */
+export declare const withPageBreak: <B extends Record<string, import("../../schema/index.js").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(schema: BlockNoteSchema<B, I, S>) => BlockNoteSchema<B & {
+    pageBreak: typeof PageBreak.config;
+}, I, S>;

package/types/src/blocks/defaultBlocks.d.ts

@@ -138,6 +138,10 @@ export declare const defaultBlockSpecs: {
             type: "numberedListItem";
             content: "inline";
             propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
                 backgroundColor: {
                     default: "default";
                 };
@@ -154,6 +158,10 @@ export declare const defaultBlockSpecs: {
             type: "numberedListItem";
             content: "inline";
             propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
                 backgroundColor: {
                     default: "default";
                 };
@@ -578,6 +586,10 @@ export declare const defaultBlockSchema: import("../schema/index.js").BlockSchem
             type: "numberedListItem";
             content: "inline";
             propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
                 backgroundColor: {
                     default: "default";
                 };
@@ -594,6 +606,10 @@ export declare const defaultBlockSchema: import("../schema/index.js").BlockSchem
             type: "numberedListItem";
             content: "inline";
             propSchema: {
+                start: {
+                    default: undefined;
+                    type: "number";
+                };
                 backgroundColor: {
                     default: "default";
                 };

package/types/src/editor/BlockNoteEditor.d.ts

@@ -96,6 +96,13 @@ export type BlockNoteEditorOptions<BSchema extends BlockSchema, ISchema extends
          * Optional function to customize how cursors of users are rendered
          */
         renderCursor?: (user: any) => HTMLElement;
+        /**
+         * Optional flag to set when the user label should be shown with the default
+         * collaboration cursor. Setting to "always" will always show the label,
+         * while "activity" will only show the label when the user moves the cursor
+         * or types. Defaults to "activity".
+         */
+        showCursorLabels?: "always" | "activity";
     };
     /**
      * additional tiptap options, undocumented
@@ -138,6 +145,14 @@ export type BlockNoteEditorOptions<BSchema extends BlockSchema, ISchema extends
      @default "prefer-navigate-ui"
      */
     tabBehavior: "prefer-navigate-ui" | "prefer-indent";
+    /**
+     * The detection mode for showing the side menu - "viewport" always shows the
+     * side menu for the block next to the mouse cursor, while "editor" only shows
+     * it when hovering the editor or the side menu itself.
+     *
+     * @default "viewport"
+     */
+    sideMenuDetection: "viewport" | "editor";
 };
 export declare class BlockNoteEditor<BSchema extends BlockSchema = DefaultBlockSchema, ISchema extends InlineContentSchema = DefaultInlineContentSchema, SSchema extends StyleSchema = DefaultStyleSchema> {
     protected readonly options: Partial<BlockNoteEditorOptions<any, any, any>>;

package/types/src/editor/BlockNoteExtensions.d.ts

@@ -18,6 +18,7 @@ type ExtensionOptions<BSchema extends BlockSchema, I extends InlineContentSchema
         };
         provider: any;
         renderCursor?: (user: any) => HTMLElement;
+        showCursorLabels?: "always" | "activity";
     };
     disableExtensions: string[] | undefined;
     setIdAttribute?: boolean;
@@ -26,6 +27,7 @@ type ExtensionOptions<BSchema extends BlockSchema, I extends InlineContentSchema
     dropCursor: (opts: any) => Plugin;
     placeholders: Record<string | "default", string>;
     tabBehavior?: "prefer-navigate-ui" | "prefer-indent";
+    sideMenuDetection: "viewport" | "editor";
 };
 /**
  * Get all the Tiptap extensions BlockNote is configured with by default

package/types/src/editor/transformPasted.d.ts

@@ -10,10 +10,14 @@ export declare function wrapTableRows(f: Fragment, schema: Schema): Fragment;
 /**
  * fix for https://github.com/ProseMirror/prosemirror/issues/1430#issuecomment-1822570821
  *
- * Without this fix, pasting two paragraphs would cause the second one to be indented in the other
- * this fix wraps every element in the slice in it's own blockContainer, to prevent Prosemirror from nesting the
- * elements on paste.
+ * This fix wraps pasted ProseMirror nodes in their own `blockContainer` nodes
+ * in most cases. This is to ensure that ProseMirror inserts them as separate
+ * blocks, which it sometimes doesn't do because it doesn't have enough context
+ * about the hierarchy of the pasted nodes. The issue can be seen when pasting
+ * e.g. an image or two consecutive paragraphs, where PM tries to nest the
+ * pasted block(s) when it shouldn't.
  *
- * The exception is when we encounter blockGroups with listitems, because those actually should be nested
+ * However, the fix is not applied in a few cases. See `shouldApplyFix` for
+ * which cases are excluded.
  */
 export declare function transformPasted(slice: Slice, view: EditorView): Slice;

package/types/src/extensions/SideMenu/SideMenuPlugin.d.ts

@@ -1,6 +1,5 @@
-import { PluginView } from "@tiptap/pm/state";
-import { EditorState, Plugin, PluginKey } from "prosemirror-state";
-import { EditorView } from "prosemirror-view";
+import { EditorState, Plugin, PluginKey, PluginView } from "@tiptap/pm/state";
+import { EditorView } from "@tiptap/pm/view";
 import { Block } from "../../blocks/defaultBlocks.js";
 import type { BlockNoteEditor } from "../../editor/BlockNoteEditor.js";
 import { UiElementPosition } from "../../extensions-shared/UiElementPosition.js";
@@ -14,13 +13,15 @@ export type SideMenuState<BSchema extends BlockSchema, I extends InlineContentSc
  */
 export declare class SideMenuView<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> implements PluginView {
     private readonly editor;
+    private readonly sideMenuDetection;
     private readonly pmView;
     state?: SideMenuState<BSchema, I, S>;
     readonly emitUpdate: (state: SideMenuState<BSchema, I, S>) => void;
     private mousePos;
     private hoveredBlock;
     menuFrozen: boolean;
-    constructor(editor: BlockNoteEditor<BSchema, I, S>, pmView: EditorView, emitUpdate: (state: SideMenuState<BSchema, I, S>) => void);
+    isDragOrigin: boolean;
+    constructor(editor: BlockNoteEditor<BSchema, I, S>, sideMenuDetection: "viewport" | "editor", pmView: EditorView, emitUpdate: (state: SideMenuState<BSchema, I, S>) => void);
     updateState: (state: SideMenuState<BSchema, I, S>) => void;
     updateStateFromMousePos: () => void;
     /**
@@ -29,6 +30,25 @@ export declare class SideMenuView<BSchema extends BlockSchema, I extends InlineC
      * when dragging / dropping to the side of the editor
      */
     onDrop: (event: DragEvent) => void;
+    /**
+     * If a block is being dragged, ProseMirror usually gets the context of what's
+     * being dragged from `view.dragging`, which is automatically set when a
+     * `dragstart` event fires in the editor. However, if the user tries to drag
+     * and drop blocks between multiple editors, only the one in which the drag
+     * began has that context, so we need to set it on the others manually. This
+     * ensures that PM always drops the blocks in between other blocks, and not
+     * inside them.
+     *
+     * After the `dragstart` event fires on the drag handle, it sets
+     * `blocknote/html` data on the clipboard. This handler fires right after,
+     * parsing the `blocknote/html` data into nodes and setting them on
+     * `view.dragging`.
+     *
+     * Note: Setting `view.dragging` on `dragover` would be better as the user
+     * could then drag between editors in different windows, but you can only
+     * access `dataTransfer` contents on `dragstart` and `drop` events.
+     */
+    onDragStart: (event: DragEvent) => void;
     /**
      * If the event is outside the editor contents,
      * we dispatch a fake event, so that we can still drop the content
@@ -46,7 +66,7 @@ export declare class SideMenuProsemirrorPlugin<BSchema extends BlockSchema, I ex
     private readonly editor;
     view: SideMenuView<BSchema, I, S> | undefined;
     readonly plugin: Plugin;
-    constructor(editor: BlockNoteEditor<BSchema, I, S>);
+    constructor(editor: BlockNoteEditor<BSchema, I, S>, sideMenuDetection: "viewport" | "editor");
     onUpdate(callback: (state: SideMenuState<BSchema, I, S>) => void): () => void;
     /**
      * Handles drag & drop events for blocks.

package/types/src/extensions/SuggestionMenu/DefaultSuggestionItem.d.ts

@@ -1,6 +1,6 @@
 import type { Dictionary } from "../../i18n/dictionary.js";
 export type DefaultSuggestionItem = {
-    key: keyof Dictionary["slash_menu"];
+    key: keyof Omit<Dictionary["slash_menu"], "page_break">;
     title: string;
     onItemClick: () => void;
     subtext?: string;

package/types/src/i18n/locales/de.d.ts

@@ -48,6 +48,12 @@ export declare const de: {
             aliases: string[];
             group: string;
         };
+        page_break: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
         table: {
             title: string;
             subtext: string;

package/types/src/i18n/locales/en.d.ts

@@ -48,6 +48,12 @@ export declare const en: {
             aliases: string[];
             group: string;
         };
+        page_break: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
         table: {
             title: string;
             subtext: string;

package/types/src/i18n/locales/es.d.ts

@@ -48,6 +48,12 @@ export declare const es: {
             aliases: string[];
             group: string;
         };
+        page_break: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
         table: {
             title: string;
             subtext: string;

package/types/src/i18n/locales/hr.d.ts

@@ -48,6 +48,12 @@ export declare const hr: {
             aliases: string[];
             group: string;
         };
+        page_break: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
         image: {
             title: string;
             subtext: string;

package/types/src/i18n/locales/index.d.ts

@@ -13,3 +13,4 @@ export * from "./pt.js";
 export * from "./ru.js";
 export * from "./vi.js";
 export * from "./zh.js";
+export * from "./it.js";