@blocknote/core 0.12.4 → 0.13.2

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

@@ -3,10 +3,10 @@ import { Node } from "prosemirror-model";
 import * as Y from "yjs";
 import { Block, DefaultBlockSchema, DefaultInlineContentSchema, DefaultStyleSchema, PartialBlock } from "../blocks/defaultBlocks";
 import { FormattingToolbarProsemirrorPlugin } from "../extensions/FormattingToolbar/FormattingToolbarPlugin";
+import { ImagePanelProsemirrorPlugin } from "../extensions/ImagePanel/ImageToolbarPlugin";
 import { LinkToolbarProsemirrorPlugin } from "../extensions/LinkToolbar/LinkToolbarPlugin";
 import { SideMenuProsemirrorPlugin } from "../extensions/SideMenu/SideMenuPlugin";
 import { SuggestionMenuProseMirrorPlugin } from "../extensions/SuggestionMenu/SuggestionPlugin";
-import { ImagePanelProsemirrorPlugin } from "../extensions/ImagePanel/ImageToolbarPlugin";
 import { TableHandlesProsemirrorPlugin } from "../extensions/TableHandles/TableHandlesPlugin";
 import { BlockIdentifier, BlockNoteDOMAttributes, BlockSchema, BlockSpecs, InlineContentSchema, InlineContentSpecs, PartialInlineContent, StyleSchema, StyleSpecs, Styles } from "../schema";
 import { NoInfer } from "../util/typescript";
@@ -14,10 +14,18 @@ import { TextCursorPosition } from "./cursorPositionTypes";
 import { Selection } from "./selectionTypes";
 import { BlockNoteSchema } from "./BlockNoteSchema";
 import { BlockNoteTipTapEditor } from "./BlockNoteTipTapEditor";
+import { Dictionary } from "../i18n/dictionary";
 import "./Block.css";
 import "./editor.css";
 export type BlockNoteEditorOptions<BSchema extends BlockSchema, ISchema extends InlineContentSchema, SSchema extends StyleSchema> = {
     enableBlockNoteExtensions: boolean;
+    /**
+     * A dictionary object containing translations for the editor.
+     */
+    dictionary?: Dictionary;
+    /**
+     * @deprecated, provide placeholders via dictionary instead
+     */
     placeholders: Record<string | "default", string>;
     /**
      * An object containing attributes that should be added to HTML elements of the editor.
@@ -67,6 +75,7 @@ export type BlockNoteEditorOptions<BSchema extends BlockSchema, ISchema extends
         renderCursor?: (user: any) => HTMLElement;
     };
     _tiptapOptions: Partial<EditorOptions>;
+    trailingBlock?: boolean;
 };
 export declare class BlockNoteEditor<BSchema extends BlockSchema = DefaultBlockSchema, ISchema extends InlineContentSchema = DefaultInlineContentSchema, SSchema extends StyleSchema = DefaultStyleSchema> {
     private readonly options;
@@ -74,6 +83,7 @@ export declare class BlockNoteEditor<BSchema extends BlockSchema = DefaultBlockS
         contentComponent: any;
     };
     blockCache: WeakMap<Node, Block<any, any, any>>;
+    readonly dictionary: Dictionary;
     readonly schema: BlockNoteSchema<BSchema, ISchema, SSchema>;
     readonly blockImplementations: BlockSpecs;
     readonly inlineContentImplementations: InlineContentSpecs;

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

@@ -7,12 +7,12 @@ import { BlockNoteDOMAttributes, BlockSpecs, InlineContentSchema, InlineContentS
  */
 export declare const getBlockNoteExtensions: <BSchema extends Record<string, import("../schema").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(opts: {
     editor: BlockNoteEditor<BSchema, I, S>;
-    placeholders?: Record<string, string> | undefined;
     domAttributes: Partial<BlockNoteDOMAttributes>;
     blockSchema: BSchema;
     blockSpecs: BlockSpecs;
     inlineContentSpecs: InlineContentSpecs;
     styleSpecs: StyleSpecs;
+    trailingBlock: boolean | undefined;
     collaboration?: {
         fragment: Y.XmlFragment;
         user: {
@@ -20,6 +20,6 @@ export declare const getBlockNoteExtensions: <BSchema extends Record<string, imp
             color: string;
         };
         provider: any;
-        renderCursor?: ((user: any) => HTMLElement) | undefined;
-    } | undefined;
+        renderCursor?: (user: any) => HTMLElement;
+    };
 }) => Extensions;

package/types/src/extensions/FormattingToolbar/FormattingToolbarPlugin.d.ts

@@ -1,11 +1,11 @@
-import { EditorState, Plugin, PluginKey } from "prosemirror-state";
+import { EditorState, Plugin, PluginKey, PluginView } from "prosemirror-state";
 import { EditorView } from "prosemirror-view";
 import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
 import { UiElementPosition } from "../../extensions-shared/UiElementPosition";
 import { BlockSchema, InlineContentSchema, StyleSchema } from "../../schema";
 import { EventEmitter } from "../../util/EventEmitter";
 export type FormattingToolbarState = UiElementPosition;
-export declare class FormattingToolbarView {
+export declare class FormattingToolbarView implements PluginView {
     private readonly editor;
     private readonly pmView;
     state?: FormattingToolbarState;
@@ -23,11 +23,10 @@ export declare class FormattingToolbarView {
     viewMousedownHandler: () => void;
     viewMouseupHandler: () => void;
     dragHandler: () => void;
-    focusHandler: () => void;
-    blurHandler: (event: FocusEvent) => void;
     scrollHandler: () => void;
     update(view: EditorView, oldState?: EditorState): void;
     destroy(): void;
+    closeMenu: () => void;
     getSelectionBoundingBox(): DOMRect;
 }
 export declare const formattingToolbarPluginKey: PluginKey<any>;
@@ -35,5 +34,7 @@ export declare class FormattingToolbarProsemirrorPlugin extends EventEmitter<any
     private view;
     readonly plugin: Plugin;
     constructor(editor: BlockNoteEditor<any, any, any>);
+    get shown(): boolean;
     onUpdate(callback: (state: FormattingToolbarState) => void): () => void;
+    closeMenu: () => void;
 }

package/types/src/extensions/ImagePanel/ImageToolbarPlugin.d.ts

@@ -1,14 +1,14 @@
-import { EditorState, Plugin, PluginKey } from "prosemirror-state";
+import { EditorState, Plugin, PluginKey, PluginView } from "prosemirror-state";
 import { EditorView } from "prosemirror-view";
+import { DefaultBlockSchema } from "../../blocks/defaultBlocks";
 import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
-import type { BlockFromConfig, InlineContentSchema, StyleSchema } from "../../schema";
 import { UiElementPosition } from "../../extensions-shared/UiElementPosition";
+import type { BlockFromConfig, InlineContentSchema, StyleSchema } from "../../schema";
 import { EventEmitter } from "../../util/EventEmitter";
-import { DefaultBlockSchema } from "../../blocks/defaultBlocks";
 export type ImagePanelState<I extends InlineContentSchema, S extends StyleSchema> = UiElementPosition & {
     block: BlockFromConfig<DefaultBlockSchema["image"], I, S>;
 };
-export declare class ImagePanelView<I extends InlineContentSchema, S extends StyleSchema> {
+export declare class ImagePanelView<I extends InlineContentSchema, S extends StyleSchema> implements PluginView {
     private readonly pluginKey;
     private readonly pmView;
     state?: ImagePanelState<I, S>;
@@ -17,9 +17,9 @@ export declare class ImagePanelView<I extends InlineContentSchema, S extends Sty
     constructor(pluginKey: PluginKey, pmView: EditorView, emitUpdate: (state: ImagePanelState<I, S>) => void);
     mouseDownHandler: () => void;
     dragstartHandler: () => void;
-    blurHandler: (event: FocusEvent) => void;
     scrollHandler: () => void;
     update(view: EditorView, prevState: EditorState): void;
+    closeMenu: () => void;
     destroy(): void;
 }
 export declare class ImagePanelProsemirrorPlugin<I extends InlineContentSchema, S extends StyleSchema> extends EventEmitter<any> {
@@ -28,5 +28,7 @@ export declare class ImagePanelProsemirrorPlugin<I extends InlineContentSchema,
     constructor(_editor: BlockNoteEditor<{
         image: DefaultBlockSchema["image"];
     }, I, S>);
+    get shown(): boolean;
     onUpdate(callback: (state: ImagePanelState<I, S>) => void): () => void;
+    closeMenu: () => void;
 }

package/types/src/extensions/LinkToolbar/LinkToolbarPlugin.d.ts

@@ -1,7 +1,7 @@
 import { Plugin, PluginKey } from "prosemirror-state";
 import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
-import { BlockSchema, InlineContentSchema, StyleSchema } from "../../schema";
 import { UiElementPosition } from "../../extensions-shared/UiElementPosition";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../schema";
 import { EventEmitter } from "../../util/EventEmitter";
 export type LinkToolbarState = UiElementPosition & {
     url: string;
@@ -37,4 +37,6 @@ export declare class LinkToolbarProsemirrorPlugin<BSchema extends BlockSchema, I
      * cursor exits the link toolbar.
      */
     stopHideTimer: () => void;
+    get shown(): boolean;
+    closeMenu: () => void;
 }

package/types/src/extensions/Placeholder/PlaceholderPlugin.d.ts

@@ -0,0 +1,3 @@
+import { Plugin } from "prosemirror-state";
+import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
+export declare const PlaceholderPlugin: (editor: BlockNoteEditor<any, any, any>, placeholders: Record<string | "default", string>) => Plugin<any>;

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

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

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

@@ -1,7 +1,7 @@
 import { Plugin, PluginKey } from "prosemirror-state";
 import type { BlockNoteEditor } from "../../editor/BlockNoteEditor";
-import { BlockSchema, InlineContentSchema, StyleSchema } from "../../schema";
 import { UiElementPosition } from "../../extensions-shared/UiElementPosition";
+import { BlockSchema, InlineContentSchema, StyleSchema } from "../../schema";
 import { EventEmitter } from "../../util/EventEmitter";
 export type SuggestionMenuState = UiElementPosition & {
     query: string;
@@ -27,5 +27,6 @@ export declare class SuggestionMenuProseMirrorPlugin<BSchema extends BlockSchema
     removeTriggerCharacter: (triggerCharacter: string) => void;
     closeMenu: () => void;
     clearQuery: () => void;
+    get shown(): boolean;
 }
 export declare function createSuggestionMenu<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema>(editor: BlockNoteEditor<BSchema, I, S>, triggerCharacter: string): void;

package/types/src/i18n/dictionary.d.ts

@@ -0,0 +1,2 @@
+import type { en } from "./locales";
+export type Dictionary = typeof en;

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

@@ -0,0 +1,184 @@
+export declare const en: {
+    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;
+        };
+        paragraph: {
+            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;
+        };
+    };
+    placeholders: {
+        default: string;
+        heading: string;
+        bulletListItem: string;
+        numberedListItem: string;
+    };
+    image: {
+        add_button: 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;
+        };
+        image_caption: {
+            tooltip: string;
+            input_placeholder: string;
+        };
+        image_replace: {
+            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;
+        };
+    };
+    image_panel: {
+        upload: {
+            title: string;
+            file_placeholder: string;
+            upload_error: string;
+        };
+        embed: {
+            title: string;
+            embed_button: 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/i18n/locales/fr.d.ts

@@ -0,0 +1,184 @@
+export declare const fr: {
+    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;
+        };
+        paragraph: {
+            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;
+        };
+    };
+    placeholders: {
+        default: string;
+        heading: string;
+        bulletListItem: string;
+        numberedListItem: string;
+    };
+    image: {
+        add_button: 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;
+        };
+        image_caption: {
+            tooltip: string;
+            input_placeholder: string;
+        };
+        image_replace: {
+            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;
+        };
+    };
+    image_panel: {
+        upload: {
+            title: string;
+            file_placeholder: string;
+            upload_error: string;
+        };
+        embed: {
+            title: string;
+            embed_button: 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/i18n/locales/index.d.ts

@@ -0,0 +1,4 @@
+export * from "./en";
+export * from "./nl";
+export * from "./zh";
+export * from "./fr";

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

@@ -0,0 +1,2 @@
+import type { Dictionary } from "../dictionary";
+export declare const nl: Dictionary;

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

@@ -0,0 +1,2 @@
+import type { Dictionary } from "../dictionary";
+export declare const zh: Dictionary;

package/types/src/index.d.ts

@@ -1,3 +1,4 @@
+import * as locales from "./i18n/locales";
 export * from "./api/exporters/html/externalHTMLExporter";
 export * from "./api/exporters/html/internalHTMLSerializer";
 export * from "./api/testUtil";
@@ -24,4 +25,6 @@ export * from "./util/string";
 export * from "./api/nodeConversions/nodeConversions";
 export * from "./api/testUtil/partialBlockTestUtil";
 export * from "./extensions/UniqueID/UniqueID";
-export { UnreachableCaseError } from "./util/typescript";
+export * from "./i18n/dictionary";
+export { UnreachableCaseError, assertEmpty } from "./util/typescript";
+export { locales };

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

@@ -25,5 +25,5 @@ export declare const BlockContainer: Node<{
         blockContent: Record<string, string>;
         inlineContent: Record<string, string>;
     }> | undefined;
-    editor: BlockNoteEditor<BlockSchema, InlineContentSchema, StyleSchema>;
+    editor: BlockNoteEditor<any, any, any>;
 }, any>;

package/types/src/util/browser.d.ts

@@ -1,4 +1,4 @@
 export declare const isAppleOS: () => boolean;
-export declare function formatKeyboardShortcut(shortcut: string): string;
+export declare function formatKeyboardShortcut(shortcut: string, ctrlText?: string): string;
 export declare function mergeCSSClasses(...classes: string[]): string;
 export declare const isSafari: () => boolean;

package/types/src/util/typescript.d.ts

@@ -1,4 +1,5 @@
 export declare class UnreachableCaseError extends Error {
     constructor(val: never);
 }
+export declare function assertEmpty(obj: Record<string, never>, throwError?: boolean): void;
 export type NoInfer<T> = [T][T extends any ? 0 : never];