@blocknote/core 0.7.1-alpha.0 → 0.8.1

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

@@ -1,10 +1,11 @@
 import { Extension } from "@tiptap/core";
-import { BlockNoteEditor } from "../..";
+import { BlockNoteEditor, BlockSchema } from "../..";
 import { FormattingToolbarFactory } from "./FormattingToolbarFactoryTypes";
+export type FormattingToolbarOptions<BSchema extends BlockSchema> = {
+    formattingToolbarFactory: FormattingToolbarFactory<BSchema>;
+    editor: BlockNoteEditor<BSchema>;
+};
 /**
  * The menu that is displayed when selecting a piece of text.
  */
-export declare const FormattingToolbarExtension: Extension<{
-    formattingToolbarFactory: FormattingToolbarFactory;
-    editor: BlockNoteEditor;
-}, any>;
+export declare const createFormattingToolbarExtension: <BSchema extends Record<string, import("../..").BlockSpec<string, import("../..").PropSchema>>>() => Extension<FormattingToolbarOptions<BSchema>, any>;

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

@@ -1,10 +1,11 @@
 import { EditorElement, ElementFactory } from "../../shared/EditorElement";
 import { BlockNoteEditor } from "../../BlockNoteEditor";
-export type FormattingToolbarStaticParams = {
-    editor: BlockNoteEditor;
+import { BlockSchema } from "../Blocks/api/blockTypes";
+export type FormattingToolbarStaticParams<BSchema extends BlockSchema> = {
+    editor: BlockNoteEditor<BSchema>;
 };
 export type FormattingToolbarDynamicParams = {
     referenceRect: DOMRect;
 };
 export type FormattingToolbar = EditorElement<FormattingToolbarDynamicParams>;
-export type FormattingToolbarFactory = ElementFactory<FormattingToolbarStaticParams, FormattingToolbarDynamicParams>;
+export type FormattingToolbarFactory<BSchema extends BlockSchema> = ElementFactory<FormattingToolbarStaticParams<BSchema>, FormattingToolbarDynamicParams>;

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

@@ -1,27 +1,19 @@
 import { Editor } from "@tiptap/core";
 import { EditorState, Plugin, PluginKey } from "prosemirror-state";
 import { EditorView } from "prosemirror-view";
-import { BlockNoteEditor } from "../..";
+import { BlockNoteEditor, BlockSchema } from "../..";
 import { FormattingToolbar, FormattingToolbarDynamicParams, FormattingToolbarFactory, FormattingToolbarStaticParams } from "./FormattingToolbarFactoryTypes";
-export interface FormattingToolbarPluginProps {
+export interface FormattingToolbarPluginProps<BSchema extends BlockSchema> {
     pluginKey: PluginKey;
     tiptapEditor: Editor;
-    editor: BlockNoteEditor;
-    formattingToolbarFactory: FormattingToolbarFactory;
-    shouldShow?: ((props: {
-        editor: BlockNoteEditor;
-        view: EditorView;
-        state: EditorState;
-        oldState?: EditorState;
-        from: number;
-        to: number;
-    }) => boolean) | null;
+    editor: BlockNoteEditor<BSchema>;
+    formattingToolbarFactory: FormattingToolbarFactory<BSchema>;
 }
-export type FormattingToolbarViewProps = FormattingToolbarPluginProps & {
+export type FormattingToolbarViewProps<BSchema extends BlockSchema> = FormattingToolbarPluginProps<BSchema> & {
     view: EditorView;
 };
-export declare class FormattingToolbarView {
-    editor: BlockNoteEditor;
+export declare class FormattingToolbarView<BSchema extends BlockSchema> {
+    editor: BlockNoteEditor<BSchema>;
     private ttEditor;
     view: EditorView;
     formattingToolbar: FormattingToolbar;
@@ -29,8 +21,13 @@ export declare class FormattingToolbarView {
     preventShow: boolean;
     toolbarIsOpen: boolean;
     prevWasEditable: boolean | null;
-    shouldShow: Exclude<FormattingToolbarPluginProps["shouldShow"], null>;
-    constructor({ editor, tiptapEditor, formattingToolbarFactory, view, shouldShow, }: FormattingToolbarViewProps);
+    shouldShow: (props: {
+        view: EditorView;
+        state: EditorState;
+        from: number;
+        to: number;
+    }) => boolean;
+    constructor({ editor, tiptapEditor, formattingToolbarFactory, view, }: FormattingToolbarViewProps<BSchema>);
     viewMousedownHandler: () => void;
     viewMouseupHandler: () => void;
     dragstartHandler: () => void;
@@ -42,7 +39,7 @@ export declare class FormattingToolbarView {
     update(view: EditorView, oldState?: EditorState): void;
     destroy(): void;
     getSelectionBoundingBox(): DOMRect;
-    getStaticParams(): FormattingToolbarStaticParams;
+    getStaticParams(): FormattingToolbarStaticParams<BSchema>;
     getDynamicParams(): FormattingToolbarDynamicParams;
 }
-export declare const createFormattingToolbarPlugin: (options: FormattingToolbarPluginProps) => Plugin<any>;
+export declare const createFormattingToolbarPlugin: <BSchema extends Record<string, import("../..").BlockSpec<string, import("../..").PropSchema>>>(options: FormattingToolbarPluginProps<BSchema>) => Plugin<any>;

package/types/src/extensions/Placeholder/localisation/index.d.ts

@@ -0,0 +1,2 @@
+import i18next from "i18next";
+export default i18next;

package/types/src/extensions/Placeholder/localisation/translation.d.ts

@@ -0,0 +1,51 @@
+export declare const translation: {
+    en: {
+        translation: {
+            placeholder: string;
+            heading: string;
+            list: string;
+        };
+    };
+    de: {
+        translation: {
+            placeholder: string;
+            heading: string;
+            list: string;
+        };
+    };
+    it: {
+        translation: {
+            placeholder: string;
+            heading: string;
+            list: string;
+        };
+    };
+    es: {
+        translation: {
+            placeholder: string;
+            heading: string;
+            list: string;
+        };
+    };
+    fr: {
+        translation: {
+            placeholder: string;
+            heading: string;
+            list: string;
+        };
+    };
+    fi: {
+        translation: {
+            placeholder: string;
+            heading: string;
+            list: string;
+        };
+    };
+    sv: {
+        translation: {
+            placeholder: string;
+            heading: string;
+            list: string;
+        };
+    };
+};

package/types/src/extensions/SlashMenu/BaseSlashMenuItem.d.ts

@@ -1,13 +1,14 @@
 import { SuggestionItem } from "../../shared/plugins/suggestion/SuggestionItem";
 import { BlockNoteEditor } from "../../BlockNoteEditor";
+import { BlockSchema } from "../Blocks/api/blockTypes";
 /**
  * A class that defines a slash command (/<command>).
  *
  * (Not to be confused with ProseMirror commands nor TipTap commands.)
  */
-export declare class BaseSlashMenuItem extends SuggestionItem {
+export declare class BaseSlashMenuItem<BSchema extends BlockSchema> extends SuggestionItem {
     readonly name: string;
-    readonly execute: (editor: BlockNoteEditor) => void;
+    readonly execute: (editor: BlockNoteEditor<BSchema>) => void;
     readonly aliases: string[];
     /**
      * Constructs a new slash-command.
@@ -16,5 +17,5 @@ export declare class BaseSlashMenuItem extends SuggestionItem {
      * @param execute The callback for creating a new node
      * @param aliases Aliases for this command
      */
-    constructor(name: string, execute: (editor: BlockNoteEditor) => void, aliases?: string[]);
+    constructor(name: string, execute: (editor: BlockNoteEditor<BSchema>) => void, aliases?: string[]);
 }

package/types/src/extensions/SlashMenu/SlashMenuExtension.d.ts

@@ -3,10 +3,11 @@ import { PluginKey } from "prosemirror-state";
 import { SuggestionsMenuFactory } from "../../shared/plugins/suggestion/SuggestionsMenuFactoryTypes";
 import { BaseSlashMenuItem } from "./BaseSlashMenuItem";
 import { BlockNoteEditor } from "../../BlockNoteEditor";
-export type SlashMenuOptions = {
-    editor: BlockNoteEditor | undefined;
-    commands: BaseSlashMenuItem[] | undefined;
+import { BlockSchema } from "../Blocks/api/blockTypes";
+export type SlashMenuOptions<BSchema extends BlockSchema> = {
+    editor: BlockNoteEditor<BSchema> | undefined;
+    commands: BaseSlashMenuItem<BSchema>[] | undefined;
     slashMenuFactory: SuggestionsMenuFactory<any> | undefined;
 };
 export declare const SlashMenuPluginKey: PluginKey<any>;
-export declare const SlashMenuExtension: Extension<SlashMenuOptions, any>;
+export declare const createSlashMenuExtension: <BSchema extends Record<string, import("../Blocks/api/blockTypes").BlockSpec<string, import("../Blocks/api/blockTypes").PropSchema>>>() => Extension<SlashMenuOptions<BSchema>, any>;

package/types/src/extensions/SlashMenu/defaultSlashMenuItems.d.ts

@@ -2,4 +2,69 @@ import { BaseSlashMenuItem } from "./BaseSlashMenuItem";
 /**
  * An array containing commands for creating all default blocks.
  */
-export declare const defaultSlashMenuItems: BaseSlashMenuItem[];
+export declare const defaultSlashMenuItems: BaseSlashMenuItem<{
+    readonly paragraph: {
+        readonly propSchema: {
+            backgroundColor: {
+                default: "transparent";
+            };
+            textColor: {
+                default: "black";
+            };
+            textAlignment: {
+                default: "left";
+                values: readonly ["left", "center", "right", "justify"];
+            };
+        };
+        readonly node: import("../Blocks/api/blockTypes").TipTapNode<"paragraph">;
+    };
+    readonly heading: {
+        readonly propSchema: {
+            readonly level: {
+                readonly default: "1";
+                readonly values: readonly ["1", "2", "3"];
+            };
+            readonly backgroundColor: {
+                default: "transparent";
+            };
+            readonly textColor: {
+                default: "black";
+            };
+            readonly textAlignment: {
+                default: "left";
+                values: readonly ["left", "center", "right", "justify"];
+            };
+        };
+        readonly node: import("../Blocks/api/blockTypes").TipTapNode<"heading">;
+    };
+    readonly bulletListItem: {
+        readonly propSchema: {
+            backgroundColor: {
+                default: "transparent";
+            };
+            textColor: {
+                default: "black";
+            };
+            textAlignment: {
+                default: "left";
+                values: readonly ["left", "center", "right", "justify"];
+            };
+        };
+        readonly node: import("../Blocks/api/blockTypes").TipTapNode<"bulletListItem">;
+    };
+    readonly numberedListItem: {
+        readonly propSchema: {
+            backgroundColor: {
+                default: "transparent";
+            };
+            textColor: {
+                default: "black";
+            };
+            textAlignment: {
+                default: "left";
+                values: readonly ["left", "center", "right", "justify"];
+            };
+        };
+        readonly node: import("../Blocks/api/blockTypes").TipTapNode<"numberedListItem">;
+    };
+}>[];

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

@@ -1,4 +1,4 @@
 import { defaultSlashMenuItems } from "./defaultSlashMenuItems";
-import { SlashMenuExtension } from "./SlashMenuExtension";
+import { createSlashMenuExtension } from "./SlashMenuExtension";
 import { BaseSlashMenuItem } from "./BaseSlashMenuItem";
-export { defaultSlashMenuItems, BaseSlashMenuItem, SlashMenuExtension };
+export { defaultSlashMenuItems, BaseSlashMenuItem, createSlashMenuExtension };

package/types/src/index.d.ts

@@ -1,6 +1,8 @@
 export * from "./BlockNoteEditor";
 export * from "./BlockNoteExtensions";
+export * from "./extensions/Blocks/api/block";
 export * from "./extensions/Blocks/api/blockTypes";
+export * from "./extensions/Blocks/api/defaultBlocks";
 export * from "./extensions/DraggableBlocks/BlockSideMenuFactoryTypes";
 export * from "./extensions/FormattingToolbar/FormattingToolbarFactoryTypes";
 export * from "./extensions/HyperlinkToolbar/HyperlinkToolbarFactoryTypes";
@@ -10,3 +12,5 @@ export * from "./shared/EditorElement";
 export type { SuggestionItem } from "./shared/plugins/suggestion/SuggestionItem";
 export * from "./shared/plugins/suggestion/SuggestionsMenuFactoryTypes";
 export * from "./extensions/Blocks/api/inlineContentTypes";
+export * from "./extensions/Blocks/api/serialization";
+export * as blockStyles from "./extensions/Blocks/nodes/Block.module.css";

package/types/src/shared/plugins/suggestion/SuggestionPlugin.d.ts

@@ -3,7 +3,8 @@ import { Plugin, PluginKey } from "prosemirror-state";
 import { SuggestionsMenuFactory } from "./SuggestionsMenuFactoryTypes";
 import { SuggestionItem } from "./SuggestionItem";
 import { BlockNoteEditor } from "../../../BlockNoteEditor";
-export type SuggestionPluginOptions<T extends SuggestionItem> = {
+import { BlockSchema } from "../../../extensions/Blocks/api/blockTypes";
+export type SuggestionPluginOptions<T extends SuggestionItem, BSchema extends BlockSchema> = {
     /**
      * The name of the plugin.
      *
@@ -13,7 +14,7 @@ export type SuggestionPluginOptions<T extends SuggestionItem> = {
     /**
      * The BlockNote editor.
      */
-    editor: BlockNoteEditor;
+    editor: BlockNoteEditor<BSchema>;
     /**
      * The character that should trigger the suggestion menu to pop up (e.g. a '/' for commands), when typed by the user.
      */
@@ -28,7 +29,7 @@ export type SuggestionPluginOptions<T extends SuggestionItem> = {
      */
     onSelectItem?: (props: {
         item: T;
-        editor: BlockNoteEditor;
+        editor: BlockNoteEditor<BSchema>;
     }) => void;
     /**
      * A function that should supply the plugin with items to suggest, based on a certain query string.
@@ -61,5 +62,5 @@ type SuggestionPluginState<T extends SuggestionItem> = {
  * @param options options for configuring the plugin
  * @returns the prosemirror plugin
  */
-export declare function createSuggestionPlugin<T extends SuggestionItem>({ pluginKey, editor, defaultTriggerCharacter, suggestionsMenuFactory, onSelectItem: selectItemCallback, items, }: SuggestionPluginOptions<T>): Plugin<SuggestionPluginState<T>>;
+export declare function createSuggestionPlugin<T extends SuggestionItem, BSchema extends BlockSchema>({ pluginKey, editor, defaultTriggerCharacter, suggestionsMenuFactory, onSelectItem: selectItemCallback, items, }: SuggestionPluginOptions<T, BSchema>): Plugin<SuggestionPluginState<T>>;
 export {};

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

@@ -1,13 +0,0 @@
-export declare const Alert: import("./blockTypes").BlockSpec<"alert", {
-    readonly textAlignment: {
-        default: "left";
-        values: readonly ["left", "center", "right", "justify"];
-    };
-    readonly textColor: {
-        default: "black";
-    };
-    readonly type: {
-        readonly default: "warning";
-        readonly values: readonly ["warning", "error", "info", "success"];
-    };
-}>;

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

@@ -1,13 +0,0 @@
-export declare const Alert2: import("./blockTypes").BlockSpec<"alert2", {
-    readonly textAlignment: {
-        default: "left";
-        values: readonly ["left", "center", "right", "justify"];
-    };
-    readonly textColor: {
-        default: "black";
-    };
-    readonly type: {
-        readonly default: "warning";
-        readonly values: readonly ["warning", "error", "info", "success"];
-    };
-}>;