@blocknote/core 0.19.0 → 0.19.1

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

@@ -1,4 +1,4 @@
-import { EditorOptions } from "@tiptap/core";
+import { AnyExtension, EditorOptions } from "@tiptap/core";
 import { Node, Schema } from "prosemirror-model";
 import * as Y from "yjs";
 import { Block, DefaultBlockSchema, DefaultInlineContentSchema, DefaultStyleSchema, PartialBlock } from "../blocks/defaultBlocks.js";
@@ -8,7 +8,7 @@ import { LinkToolbarProsemirrorPlugin } from "../extensions/LinkToolbar/LinkTool
 import { SideMenuProsemirrorPlugin } from "../extensions/SideMenu/SideMenuPlugin.js";
 import { SuggestionMenuProseMirrorPlugin } from "../extensions/SuggestionMenu/SuggestionPlugin.js";
 import { TableHandlesProsemirrorPlugin } from "../extensions/TableHandles/TableHandlesPlugin.js";
-import { BlockIdentifier, BlockNoteDOMAttributes, BlockSchema, BlockSpecs, InlineContentSchema, InlineContentSpecs, PartialInlineContent, StyleSchema, StyleSpecs, Styles } from "../schema/index.js";
+import { BlockIdentifier, BlockNoteDOMAttributes, BlockSchema, BlockSpecs, InlineContentSchema, InlineContentSpecs, PartialInlineContent, Styles, StyleSchema, StyleSpecs } from "../schema/index.js";
 import { NoInfer } from "../util/typescript.js";
 import { TextCursorPosition } from "./cursorPositionTypes.js";
 import { Selection } from "./selectionTypes.js";
@@ -17,6 +17,9 @@ import { BlockNoteTipTapEditor } from "./BlockNoteTipTapEditor.js";
 import { Dictionary } from "../i18n/dictionary.js";
 import { Plugin, Transaction } from "@tiptap/pm/state";
 import "../style.css";
+export type BlockNoteExtension = AnyExtension | {
+    plugin: Plugin;
+};
 export type BlockNoteEditorOptions<BSchema extends BlockSchema, ISchema extends InlineContentSchema, SSchema extends StyleSchema> = {
     /**
      * Whether changes to blocks (like indentation, creating lists, changing headings) should be animated or not. Defaults to `true`.
@@ -24,6 +27,9 @@ export type BlockNoteEditorOptions<BSchema extends BlockSchema, ISchema extends
      * @default true
      */
     animations?: boolean;
+    /**
+     * Disable internal extensions (based on keys / extension name)
+     */
     disableExtensions: string[];
     /**
      * A dictionary object containing translations for the editor.
@@ -90,7 +96,14 @@ export type BlockNoteEditorOptions<BSchema extends BlockSchema, ISchema extends
          */
         renderCursor?: (user: any) => HTMLElement;
     };
+    /**
+     * additional tiptap options, undocumented
+     */
     _tiptapOptions: Partial<EditorOptions>;
+    /**
+     * (experimental) add extra prosemirror plugins or tiptap extensions to the editor
+     */
+    _extensions: Record<string, BlockNoteExtension>;
     trailingBlock?: boolean;
     /**
      * Boolean indicating whether the editor is in headless mode.
@@ -114,6 +127,10 @@ export type BlockNoteEditorOptions<BSchema extends BlockSchema, ISchema extends
 export declare class BlockNoteEditor<BSchema extends BlockSchema = DefaultBlockSchema, ISchema extends InlineContentSchema = DefaultInlineContentSchema, SSchema extends StyleSchema = DefaultStyleSchema> {
     protected readonly options: Partial<BlockNoteEditorOptions<any, any, any>>;
     private readonly _pmSchema;
+    /**
+     * extensions that are added to the editor, can be tiptap extensions or prosemirror plugins
+     */
+    readonly extensions: Record<string, BlockNoteExtension>;
     /**
      * Boolean indicating whether the editor is in headless mode.
      * Headless mode means we can use features like importing / exporting blocks,

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

@@ -1,10 +1,8 @@
-import type { BlockNoteEditor } from "./BlockNoteEditor.js";
+import type { BlockNoteEditor, BlockNoteExtension } from "./BlockNoteEditor.js";
+import { Plugin } from "prosemirror-state";
 import * as Y from "yjs";
-import { BlockNoteDOMAttributes, BlockSpecs, InlineContentSchema, InlineContentSpecs, StyleSchema, StyleSpecs } from "../schema/index.js";
-/**
- * Get all the Tiptap extensions BlockNote is configured with by default
- */
-export declare const getBlockNoteExtensions: <BSchema extends Record<string, import("../schema/index.js").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(opts: {
+import { BlockNoteDOMAttributes, BlockSchema, BlockSpecs, InlineContentSchema, InlineContentSpecs, StyleSchema, StyleSpecs } from "../schema/index.js";
+type ExtensionOptions<BSchema extends BlockSchema, I extends InlineContentSchema, S extends StyleSchema> = {
     editor: BlockNoteEditor<BSchema, I, S>;
     domAttributes: Partial<BlockNoteDOMAttributes>;
     blockSpecs: BlockSpecs;
@@ -23,4 +21,13 @@ export declare const getBlockNoteExtensions: <BSchema extends Record<string, imp
     };
     disableExtensions: string[] | undefined;
     setIdAttribute?: boolean;
-}) => import("@tiptap/core").AnyExtension[];
+    animations: boolean;
+    tableHandles: boolean;
+    dropCursor: (opts: any) => Plugin;
+    placeholders: Record<string | "default", string>;
+};
+/**
+ * Get all the Tiptap extensions BlockNote is configured with by default
+ */
+export declare const getBlockNoteExtensions: <BSchema extends Record<string, import("../schema/index.js").BlockConfig>, I extends InlineContentSchema, S extends StyleSchema>(opts: ExtensionOptions<BSchema, I, S>) => Record<string, BlockNoteExtension>;
+export {};

package/types/src/extensions/NodeSelectionKeyboard/NodeSelectionKeyboardPlugin.d.ts

@@ -1,2 +1,5 @@
 import { Plugin } from "prosemirror-state";
-export declare const NodeSelectionKeyboardPlugin: () => Plugin<any>;
+export declare class NodeSelectionKeyboardPlugin {
+    readonly plugin: Plugin;
+    constructor();
+}

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

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

package/types/src/extensions/PreviousBlockType/PreviousBlockTypePlugin.d.ts

@@ -7,8 +7,7 @@ import { Plugin } from "prosemirror-state";
  *
  * Solution: When attributes change on a node, this plugin sets a data-* attribute with the "previous" value. This way we can still use CSS transitions. (See block.module.css)
  */
-export declare const PreviousBlockTypePlugin: () => Plugin<{
-    prevTransactionOldBlockAttrs: any;
-    currentTransactionOldBlockAttrs: any;
-    updatedBlocks: Set<string>;
-}>;
+export declare class PreviousBlockTypePlugin {
+    readonly plugin: Plugin;
+    constructor();
+}