@blocknote/core 0.1.0-alpha.3

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

@@ -0,0 +1,74 @@
+import { Editor, Range } from "@tiptap/core";
+import { Plugin, PluginKey, Selection } from "prosemirror-state";
+import SuggestionItem from "./SuggestionItem";
+export declare type SuggestionPluginOptions<T extends SuggestionItem> = {
+    /**
+     * The name of the plugin.
+     *
+     * Used for ensuring that the plugin key is unique when more than one instance of the SuggestionPlugin is used.
+     */
+    pluginKey: PluginKey;
+    /**
+     * The TipTap editor.
+     */
+    editor: Editor;
+    /**
+     * The character that should trigger the suggestion menu to pop up (e.g. a '/' for commands)
+     */
+    char: string;
+    /**
+     * The callback that gets executed when an item is selected by the user.
+     *
+     * **NOTE:** The command text is not removed automatically from the editor by this plugin,
+     * this should be done manually. The `editor` and `range` properties passed
+     * to the callback function might come in handy when doing this.
+     */
+    onSelectItem?: (props: {
+        item: T;
+        editor: Editor;
+        range: Range;
+    }) => void;
+    /**
+     * A function that should supply the plugin with items to suggest, based on a certain query string.
+     */
+    items?: (query: string) => T[];
+    allow?: (props: {
+        editor: Editor;
+        range: Range;
+    }) => boolean;
+};
+export declare 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.
+ *
+ * This is basically a simplified version of TipTap's [Suggestions](https://github.com/ueberdosis/tiptap/tree/db92a9b313c5993b723c85cd30256f1d4a0b65e1/packages/suggestion) plugin.
+ *
+ * This version is adapted from the aforementioned version in the following ways:
+ * - This version supports generic items instead of only strings (to allow for more advanced filtering for example)
+ * - This version hides some unnecessary complexity from the user of the plugin.
+ * - This version handles key events differently
+ *
+ * @param options options for configuring the plugin
+ * @returns the prosemirror plugin
+ */
+export declare function createSuggestionPlugin<T extends SuggestionItem>({ pluginKey, editor, char, onSelectItem: selectItemCallback, items, }: SuggestionPluginOptions<T>): Plugin<{
+    active: boolean;
+    range: any;
+    query: string | null;
+    notFoundCount: number;
+    items: T[];
+    type: string;
+    decorationId: string | null;
+}>;

package/types/src/shared/plugins/suggestion/components/SuggestionGroup.d.ts

@@ -0,0 +1,23 @@
+/// <reference types="react" />
+import SuggestionItem from "../SuggestionItem";
+declare type SuggestionGroupProps<T> = {
+    /**
+     * Name of the group
+     */
+    name: string;
+    /**
+     * The list of items
+     */
+    items: T[];
+    /**
+     * Index of the selected item in this group; relative to this item group (so 0 refers to the first item in this group)
+     * This should be 'undefined' if none of the items in this group are selected
+     */
+    selectedIndex?: number;
+    /**
+     * Callback that gets executed when an item is clicked on.
+     */
+    clickItem: (item: T) => void;
+};
+export declare function SuggestionGroup<T extends SuggestionItem>(props: SuggestionGroupProps<T>): JSX.Element;
+export {};

package/types/src/shared/plugins/suggestion/components/SuggestionList.d.ts

@@ -0,0 +1,26 @@
+/// <reference types="react" />
+import SuggestionItem from "../SuggestionItem";
+export declare type SuggestionListProps<T> = {
+    /**
+     * Object containing all suggestion items, grouped by their `groupName`.
+     */
+    groups: {
+        [groupName: string]: T[];
+    };
+    /**
+     * The total number of suggestion-items
+     */
+    count: number;
+    /**
+     * This callback gets executed whenever an item is clicked on
+     */
+    onSelectItem: (item: T) => void;
+    /**
+     * The index of the item that is currently selected (but not yet clicked on)
+     */
+    selectedIndex: number;
+};
+/**
+ * Stateless component that renders the suggestion list
+ */
+export declare function SuggestionList<T extends SuggestionItem>(props: SuggestionListProps<T>): JSX.Element;

package/types/src/useEditor.d.ts

@@ -0,0 +1,8 @@
+import { EditorOptions } from "@tiptap/react";
+import { DependencyList } from "react";
+declare type BlockNoteEditorOptions = EditorOptions & {
+    enableBlockNoteExtensions: boolean;
+    disableHistoryExtension: boolean;
+};
+export declare const useEditor: (options?: Partial<BlockNoteEditorOptions>, deps?: DependencyList) => import("@tiptap/react").Editor | null;
+export {};