@blocknote/core 0.2.3 → 0.2.4-alpha.7

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

@@ -1,14 +1,5 @@
 import { Editor, Range } from "@tiptap/core";
 import { SuggestionItem } from "../../shared/plugins/suggestion/SuggestionItem";
-export type SlashMenuCallback = (editor: Editor, range: Range) => boolean;
-export declare enum SlashMenuGroups {
-    HEADINGS = "Headings",
-    BASIC_BLOCKS = "Basic Blocks",
-    CODE = "Code Blocks",
-    INLINE = "Inline",
-    EMBED = "Embed",
-    PLUGIN = "Plugin"
-}
 /**
  * A class that defines a slash command (/<command>).
  *
@@ -16,23 +7,15 @@ export declare enum SlashMenuGroups {
  */
 export declare class SlashMenuItem implements SuggestionItem {
     readonly name: string;
-    readonly group: SlashMenuGroups;
-    readonly execute: SlashMenuCallback;
+    readonly execute: (editor: Editor, range: Range) => void;
     readonly aliases: string[];
-    readonly hint?: string | undefined;
-    readonly shortcut?: string | undefined;
-    groupName: string;
     /**
      * Constructs a new slash-command.
      *
      * @param name The name of the command
-     * @param group Used to organize the menu
      * @param execute The callback for creating a new node
      * @param aliases Aliases for this command
-     * @param icon To be shown next to the name in the menu
-     * @param hint Short description of command
-     * @param shortcut Info about keyboard shortcut that would activate this command
      */
-    constructor(name: string, group: SlashMenuGroups, execute: SlashMenuCallback, aliases?: string[], hint?: string | undefined, shortcut?: string | undefined);
+    constructor(name: string, execute: (editor: Editor, range: Range) => void, aliases?: string[]);
     match(query: string): boolean;
 }

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

@@ -0,0 +1,5 @@
+import { SlashMenuItem } from "./SlashMenuItem";
+/**
+ * An array containing commands for creating all default blocks.
+ */
+export declare const defaultSlashCommands: SlashMenuItem[];

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

@@ -1,5 +1,4 @@
 import { SlashMenuExtension } from "./SlashMenuExtension";
 import defaultCommands from "./defaultCommands";
-import { SlashMenuGroups, SlashMenuItem } from "./SlashMenuItem";
-export { defaultCommands, SlashMenuItem as SlashCommand, SlashMenuGroups as CommandGroup, };
+export { defaultCommands };
 export default SlashMenuExtension;

package/types/src/extensions/TextAlignment/TextAlignmentExtension.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from "@tiptap/core";
+declare module "@tiptap/core" {
+    interface Commands<ReturnType> {
+        textAlignment: {
+            setTextAlignment: (textAlignment: "left" | "center" | "right" | "justify") => ReturnType;
+        };
+    }
+}
+export declare const TextAlignmentExtension: Extension<any, any>;

package/types/src/extensions/TextColor/TextColorExtension.d.ts

@@ -0,0 +1,9 @@
+import { Extension } from "@tiptap/core";
+declare module "@tiptap/core" {
+    interface Commands<ReturnType> {
+        blockTextColor: {
+            setBlockTextColor: (posInBlock: number, color: string) => ReturnType;
+        };
+    }
+}
+export declare const TextColorExtension: Extension<any, any>;

package/types/src/extensions/TextColor/TextColorMark.d.ts

@@ -0,0 +1,9 @@
+import { Mark } from "@tiptap/core";
+declare module "@tiptap/core" {
+    interface Commands<ReturnType> {
+        textColor: {
+            setTextColor: (color: string) => ReturnType;
+        };
+    }
+}
+export declare const TextColorMark: Mark<any, any>;

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

@@ -6,12 +6,6 @@ export interface SuggestionItem {
      * The name of the item
      */
     name: string;
-    /**
-     * The name of the group to which this item belongs
-     */
-    groupName: string;
-    hint?: string;
-    shortcut?: string;
     /**
      * This function matches this item against a query string, the function should return **true** if the item
      * matches the query or **false** otherwise.

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

@@ -1,5 +1,5 @@
 import { Editor, Range } from "@tiptap/core";
-import { Plugin, PluginKey, Selection } from "prosemirror-state";
+import { Plugin, PluginKey } from "prosemirror-state";
 import { SuggestionsMenuFactory } from "./SuggestionsMenuFactoryTypes";
 import { SuggestionItem } from "./SuggestionItem";
 export type SuggestionPluginOptions<T extends SuggestionItem> = {
@@ -14,9 +14,9 @@ export type SuggestionPluginOptions<T extends SuggestionItem> = {
      */
     editor: Editor;
     /**
-     * The character that should trigger the suggestion menu to pop up (e.g. a '/' for commands)
+     * The character that should trigger the suggestion menu to pop up (e.g. a '/' for commands), when typed by the user.
      */
-    char: string;
+    defaultTriggerCharacter: string;
     suggestionsMenuFactory: SuggestionsMenuFactory<T>;
     /**
      * The callback that gets executed when an item is selected by the user.
@@ -41,27 +41,13 @@ export type SuggestionPluginOptions<T extends SuggestionItem> = {
 };
 type SuggestionPluginState<T extends SuggestionItem> = {
     active: boolean;
-    range: Range | null;
-    query: string | null;
-    notFoundCount: number;
+    triggerCharacter: string | undefined;
+    queryStartPos: number | undefined;
     items: T[];
-    selectedItemIndex: number;
-    type: string;
-    decorationId: string | null;
+    keyboardHoveredItemIndex: number | undefined;
+    notFoundCount: number | undefined;
+    decorationId: string | undefined;
 };
-export type MenuType = "slash" | "drag";
-/**
- * Finds a command: a specified character (e.g. '/') followed by a string of characters (all characters except the specified character are allowed).
- * Returns the string following the specified character or undefined if no command was found.
- *
- * @param char the character that indicates the start of a command
- * @param selection the selection (only works if the selection is empty; i.e. is a blinking cursor).
- * @returns an object containing the matching word (excluding the specified character) and the range of the match (including the specified character) or undefined if there is no match.
- */
-export declare function findCommandBeforeCursor(char: string, selection: Selection): {
-    range: Range;
-    query: string;
-} | undefined;
 /**
  * A ProseMirror plugin for suggestions, designed to make '/'-commands possible as well as mentions.
  *
@@ -75,5 +61,5 @@ export declare function findCommandBeforeCursor(char: string, selection: Selecti
  * @param options options for configuring the plugin
  * @returns the prosemirror plugin
  */
-export declare function createSuggestionPlugin<T extends SuggestionItem>({ pluginKey, editor, char, suggestionsMenuFactory, onSelectItem: selectItemCallback, items, }: SuggestionPluginOptions<T>): Plugin<SuggestionPluginState<T>>;
+export declare function createSuggestionPlugin<T extends SuggestionItem>({ pluginKey, editor, defaultTriggerCharacter, suggestionsMenuFactory, onSelectItem: selectItemCallback, items, }: SuggestionPluginOptions<T>): Plugin<SuggestionPluginState<T>>;
 export {};

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

@@ -5,7 +5,7 @@ export type SuggestionsMenuStaticParams<T extends SuggestionItem> = {
 };
 export type SuggestionsMenuDynamicParams<T extends SuggestionItem> = {
     items: T[];
-    selectedItemIndex: number;
+    keyboardHoveredItemIndex: number;
     referenceRect: DOMRect;
 };
 export type SuggestionsMenu<T extends SuggestionItem> = EditorElement<SuggestionsMenuDynamicParams<T>>;