@blocknote/core 0.22.0 → 0.23.1

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/editor/BlockNoteEditor.d.ts

@@ -16,8 +16,9 @@ import { BlockNoteSchema } from "./BlockNoteSchema.js";
 import { BlockNoteTipTapEditor } from "./BlockNoteTipTapEditor.js";
 import { Dictionary } from "../i18n/dictionary.js";
 import { Plugin, Transaction } from "@tiptap/pm/state";
-import "../style.css";
 import { EditorView } from "prosemirror-view";
+import "../style.css";
+export type BlockNoteExtensionFactory = (editor: BlockNoteEditor<any, any, any>) => BlockNoteExtension;
 export type BlockNoteExtension = AnyExtension | {
     plugin: Plugin;
 };
@@ -96,6 +97,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
@@ -104,7 +112,7 @@ export type BlockNoteEditorOptions<BSchema extends BlockSchema, ISchema extends
     /**
      * (experimental) add extra prosemirror plugins or tiptap extensions to the editor
      */
-    _extensions: Record<string, BlockNoteExtension>;
+    _extensions: Record<string, BlockNoteExtension | BlockNoteExtensionFactory>;
     trailingBlock?: boolean;
     /**
      * Boolean indicating whether the editor is in headless mode.
@@ -138,6 +146,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/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
@@ -38,6 +58,7 @@ export declare class SideMenuView<BSchema extends BlockSchema, I extends InlineC
     onKeyDown: (_event: KeyboardEvent) => void;
     onMouseMove: (event: MouseEvent) => void;
     private createSyntheticEvent;
+    onScroll: () => void;
     update(_view: EditorView, prevState: EditorState): void;
     destroy(): void;
 }
@@ -46,7 +67,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";

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

@@ -0,0 +1,245 @@
+export declare const it: {
+    slash_menu: {
+        heading: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        heading_2: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        heading_3: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        numbered_list: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        bullet_list: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        check_list: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        paragraph: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        code_block: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        table: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        image: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        video: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        audio: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        file: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+        emoji: {
+            title: string;
+            subtext: string;
+            aliases: string[];
+            group: string;
+        };
+    };
+    placeholders: {
+        default: string;
+        heading: string;
+        bulletListItem: string;
+        numberedListItem: string;
+        checkListItem: string;
+    };
+    file_blocks: {
+        image: {
+            add_button_text: string;
+        };
+        video: {
+            add_button_text: string;
+        };
+        audio: {
+            add_button_text: string;
+        };
+        file: {
+            add_button_text: string;
+        };
+    };
+    side_menu: {
+        add_block_label: string;
+        drag_handle_label: string;
+    };
+    drag_handle: {
+        delete_menuitem: string;
+        colors_menuitem: string;
+    };
+    table_handle: {
+        delete_column_menuitem: string;
+        delete_row_menuitem: string;
+        add_left_menuitem: string;
+        add_right_menuitem: string;
+        add_above_menuitem: string;
+        add_below_menuitem: string;
+    };
+    suggestion_menu: {
+        no_items_title: string;
+        loading: string;
+    };
+    color_picker: {
+        text_title: string;
+        background_title: string;
+        colors: {
+            default: string;
+            gray: string;
+            brown: string;
+            red: string;
+            orange: string;
+            yellow: string;
+            green: string;
+            blue: string;
+            purple: string;
+            pink: string;
+        };
+    };
+    formatting_toolbar: {
+        bold: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        italic: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        underline: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        strike: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        code: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        colors: {
+            tooltip: string;
+        };
+        link: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        file_caption: {
+            tooltip: string;
+            input_placeholder: string;
+        };
+        file_replace: {
+            tooltip: Record<string, string>;
+        };
+        file_rename: {
+            tooltip: Record<string, string>;
+            input_placeholder: Record<string, string>;
+        };
+        file_download: {
+            tooltip: Record<string, string>;
+        };
+        file_delete: {
+            tooltip: Record<string, string>;
+        };
+        file_preview_toggle: {
+            tooltip: string;
+        };
+        nest: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        unnest: {
+            tooltip: string;
+            secondary_tooltip: string;
+        };
+        align_left: {
+            tooltip: string;
+        };
+        align_center: {
+            tooltip: string;
+        };
+        align_right: {
+            tooltip: string;
+        };
+        align_justify: {
+            tooltip: string;
+        };
+    };
+    file_panel: {
+        upload: {
+            title: string;
+            file_placeholder: Record<string, string>;
+            upload_error: string;
+        };
+        embed: {
+            title: string;
+            embed_button: Record<string, string>;
+            url_placeholder: string;
+        };
+    };
+    link_toolbar: {
+        delete: {
+            tooltip: string;
+        };
+        edit: {
+            text: string;
+            tooltip: string;
+        };
+        open: {
+            tooltip: string;
+        };
+        form: {
+            title_placeholder: string;
+            url_placeholder: string;
+        };
+    };
+    generic: {
+        ctrl_shortcut: string;
+    };
+};

package/types/src/index.d.ts

@@ -6,6 +6,9 @@ export * from "./api/nodeUtil.js";
 export * from "./api/testUtil/index.js";
 export * from "./blocks/AudioBlockContent/AudioBlockContent.js";
 export * from "./blocks/CodeBlockContent/CodeBlockContent.js";
+export * from "./blocks/PageBreakBlockContent/PageBreakBlockContent.js";
+export * from "./blocks/PageBreakBlockContent/getPageBreakSlashMenuItems.js";
+export * from "./blocks/PageBreakBlockContent/schema.js";
 export * from "./blocks/FileBlockContent/FileBlockContent.js";
 export * from "./blocks/FileBlockContent/helpers/parse/parseEmbedElement.js";
 export * from "./blocks/FileBlockContent/helpers/parse/parseFigureElement.js";

package/types/src/pm-nodes/BlockContainer.d.ts

@@ -5,8 +5,8 @@ import type { BlockNoteEditor } from "../editor/BlockNoteEditor.js";
  */
 export declare const BlockContainer: Node<{
     domAttributes?: Partial<{
-        blockContent: Record<string, string>;
         blockGroup: Record<string, string>;
+        blockContent: Record<string, string>;
         editor: Record<string, string>;
         block: Record<string, string>;
         inlineContent: Record<string, string>;

package/types/src/pm-nodes/BlockGroup.d.ts

@@ -1,8 +1,8 @@
 import { Node } from "@tiptap/core";
 export declare const BlockGroup: Node<{
     domAttributes?: Partial<{
-        blockContent: Record<string, string>;
         blockGroup: Record<string, string>;
+        blockContent: Record<string, string>;
         editor: Record<string, string>;
         block: Record<string, string>;
         inlineContent: Record<string, string>;