@humandialog/forms.svelte 1.3.11 → 1.3.13

package/components/document/internal/suggestion.d.ts

@@ -1,158 +1,158 @@
-import { Editor, type Range } from '@tiptap/core';
-import { EditorState, Plugin, PluginKey } from '@tiptap/pm/state';
-import { EditorView } from '@tiptap/pm/view';
-import { findSuggestionMatch as defaultFindSuggestionMatch } from './findSuggestionMatch';
-export interface SuggestionOptions<I = any, TSelected = any> {
-    /**
-     * The plugin key for the suggestion plugin.
-     * @default 'suggestion'
-     * @example 'mention'
-     */
-    pluginKey?: PluginKey;
-    /**
-     * The editor instance.
-     * @default null
-     */
-    editor: Editor;
-    /**
-     * The character that triggers the suggestion.
-     * @default '@'
-     * @example '#'
-     */
-    char?: string;
-    /**
-     * Allow spaces in the suggestion query. Not compatible with `allowToIncludeChar`. Will be disabled if `allowToIncludeChar` is set to `true`.
-     * @default false
-     * @example true
-    */
-    allowSpaces?: boolean;
-    /**
-     * Allow the character to be included in the suggestion query. Not compatible with `allowSpaces`.
-     * @default false
-     */
-    allowToIncludeChar?: boolean;
-    /**
-     * Allow prefixes in the suggestion query.
-     * @default [' ']
-     * @example [' ', '@']
-     */
-    allowedPrefixes?: string[] | null;
-    /**
-     * Only match suggestions at the start of the line.
-     * @default false
-     * @example true
-     */
-    startOfLine?: boolean;
-    /**
-     * The tag name of the decoration node.
-     * @default 'span'
-     * @example 'div'
-     */
-    decorationTag?: string;
-    /**
-     * The class name of the decoration node.
-     * @default 'suggestion'
-     * @example 'mention'
-     */
-    decorationClass?: string;
-    /**
-     * A function that is called when a suggestion is selected.
-     * @param props The props object.
-     * @param props.editor The editor instance.
-     * @param props.range The range of the suggestion.
-     * @param props.props The props of the selected suggestion.
-     * @returns void
-     * @example ({ editor, range, props }) => { props.command(props.props) }
-     */
-    command?: (props: {
-        editor: Editor;
-        range: Range;
-        props: TSelected;
-    }) => void;
-    /**
-     * A function that returns the suggestion items in form of an array.
-     * @param props The props object.
-     * @param props.editor The editor instance.
-     * @param props.query The current suggestion query.
-     * @returns An array of suggestion items.
-     * @example ({ editor, query }) => [{ id: 1, label: 'John Doe' }]
-     */
-    items?: (props: {
-        query: string;
-        editor: Editor;
-    }) => I[] | Promise<I[]>;
-    /**
-     * The render function for the suggestion.
-     * @returns An object with render functions.
-     */
-    render?: () => {
-        onBeforeStart?: (props: SuggestionProps<I, TSelected>) => void;
-        onStart?: (props: SuggestionProps<I, TSelected>) => void;
-        onBeforeUpdate?: (props: SuggestionProps<I, TSelected>) => void;
-        onUpdate?: (props: SuggestionProps<I, TSelected>) => void;
-        onExit?: (props: SuggestionProps<I, TSelected>) => void;
-        onKeyDown?: (props: SuggestionKeyDownProps) => boolean;
-    };
-    /**
-     * A function that returns a boolean to indicate if the suggestion should be active.
-     * @param props The props object.
-     * @returns {boolean}
-     */
-    allow?: (props: {
-        editor: Editor;
-        state: EditorState;
-        range: Range;
-        isActive?: boolean;
-    }) => boolean;
-    findSuggestionMatch?: typeof defaultFindSuggestionMatch;
-}
-export interface SuggestionProps<I = any, TSelected = any> {
-    /**
-     * The editor instance.
-     */
-    editor: Editor;
-    /**
-     * The range of the suggestion.
-     */
-    range: Range;
-    /**
-     * The current suggestion query.
-     */
-    query: string;
-    /**
-     * The current suggestion text.
-     */
-    text: string;
-    /**
-     * The suggestion items array.
-     */
-    items: I[];
-    /**
-     * A function that is called when a suggestion is selected.
-     * @param props The props object.
-     * @returns void
-     */
-    command: (props: TSelected) => void;
-    /**
-     * The decoration node HTML element
-     * @default null
-     */
-    decorationNode: Element | null;
-    /**
-     * The function that returns the client rect
-     * @default null
-     * @example () => new DOMRect(0, 0, 0, 0)
-     */
-    clientRect?: (() => DOMRect | null) | null;
-}
-export interface SuggestionKeyDownProps {
-    view: EditorView;
-    event: KeyboardEvent;
-    range: Range;
-}
-export declare const SuggestionPluginKey: PluginKey<any>;
-/**
- * This utility allows you to create suggestions.
- * @see https://tiptap.dev/api/utilities/suggestion
- */
-export declare function Suggestion<I = any, TSelected = any>({ pluginKey, editor, char, allowSpaces, allowToIncludeChar, allowedPrefixes, startOfLine, decorationTag, decorationClass, command, items, render, allow, findSuggestionMatch, }: SuggestionOptions<I, TSelected>): Plugin<any>;
+import { Editor, type Range } from '@tiptap/core';
+import { EditorState, Plugin, PluginKey } from '@tiptap/pm/state';
+import { EditorView } from '@tiptap/pm/view';
+import { findSuggestionMatch as defaultFindSuggestionMatch } from './findSuggestionMatch';
+export interface SuggestionOptions<I = any, TSelected = any> {
+    /**
+     * The plugin key for the suggestion plugin.
+     * @default 'suggestion'
+     * @example 'mention'
+     */
+    pluginKey?: PluginKey;
+    /**
+     * The editor instance.
+     * @default null
+     */
+    editor: Editor;
+    /**
+     * The character that triggers the suggestion.
+     * @default '@'
+     * @example '#'
+     */
+    char?: string;
+    /**
+     * Allow spaces in the suggestion query. Not compatible with `allowToIncludeChar`. Will be disabled if `allowToIncludeChar` is set to `true`.
+     * @default false
+     * @example true
+    */
+    allowSpaces?: boolean;
+    /**
+     * Allow the character to be included in the suggestion query. Not compatible with `allowSpaces`.
+     * @default false
+     */
+    allowToIncludeChar?: boolean;
+    /**
+     * Allow prefixes in the suggestion query.
+     * @default [' ']
+     * @example [' ', '@']
+     */
+    allowedPrefixes?: string[] | null;
+    /**
+     * Only match suggestions at the start of the line.
+     * @default false
+     * @example true
+     */
+    startOfLine?: boolean;
+    /**
+     * The tag name of the decoration node.
+     * @default 'span'
+     * @example 'div'
+     */
+    decorationTag?: string;
+    /**
+     * The class name of the decoration node.
+     * @default 'suggestion'
+     * @example 'mention'
+     */
+    decorationClass?: string;
+    /**
+     * A function that is called when a suggestion is selected.
+     * @param props The props object.
+     * @param props.editor The editor instance.
+     * @param props.range The range of the suggestion.
+     * @param props.props The props of the selected suggestion.
+     * @returns void
+     * @example ({ editor, range, props }) => { props.command(props.props) }
+     */
+    command?: (props: {
+        editor: Editor;
+        range: Range;
+        props: TSelected;
+    }) => void;
+    /**
+     * A function that returns the suggestion items in form of an array.
+     * @param props The props object.
+     * @param props.editor The editor instance.
+     * @param props.query The current suggestion query.
+     * @returns An array of suggestion items.
+     * @example ({ editor, query }) => [{ id: 1, label: 'John Doe' }]
+     */
+    items?: (props: {
+        query: string;
+        editor: Editor;
+    }) => I[] | Promise<I[]>;
+    /**
+     * The render function for the suggestion.
+     * @returns An object with render functions.
+     */
+    render?: () => {
+        onBeforeStart?: (props: SuggestionProps<I, TSelected>) => void;
+        onStart?: (props: SuggestionProps<I, TSelected>) => void;
+        onBeforeUpdate?: (props: SuggestionProps<I, TSelected>) => void;
+        onUpdate?: (props: SuggestionProps<I, TSelected>) => void;
+        onExit?: (props: SuggestionProps<I, TSelected>) => void;
+        onKeyDown?: (props: SuggestionKeyDownProps) => boolean;
+    };
+    /**
+     * A function that returns a boolean to indicate if the suggestion should be active.
+     * @param props The props object.
+     * @returns {boolean}
+     */
+    allow?: (props: {
+        editor: Editor;
+        state: EditorState;
+        range: Range;
+        isActive?: boolean;
+    }) => boolean;
+    findSuggestionMatch?: typeof defaultFindSuggestionMatch;
+}
+export interface SuggestionProps<I = any, TSelected = any> {
+    /**
+     * The editor instance.
+     */
+    editor: Editor;
+    /**
+     * The range of the suggestion.
+     */
+    range: Range;
+    /**
+     * The current suggestion query.
+     */
+    query: string;
+    /**
+     * The current suggestion text.
+     */
+    text: string;
+    /**
+     * The suggestion items array.
+     */
+    items: I[];
+    /**
+     * A function that is called when a suggestion is selected.
+     * @param props The props object.
+     * @returns void
+     */
+    command: (props: TSelected) => void;
+    /**
+     * The decoration node HTML element
+     * @default null
+     */
+    decorationNode: Element | null;
+    /**
+     * The function that returns the client rect
+     * @default null
+     * @example () => new DOMRect(0, 0, 0, 0)
+     */
+    clientRect?: (() => DOMRect | null) | null;
+}
+export interface SuggestionKeyDownProps {
+    view: EditorView;
+    event: KeyboardEvent;
+    range: Range;
+}
+export declare const SuggestionPluginKey: PluginKey<any>;
+/**
+ * This utility allows you to create suggestions.
+ * @see https://tiptap.dev/api/utilities/suggestion
+ */
+export declare function Suggestion<I = any, TSelected = any>({ pluginKey, editor, char, allowSpaces, allowToIncludeChar, allowedPrefixes, startOfLine, decorationTag, decorationClass, command, items, render, allow, findSuggestionMatch, }: SuggestionOptions<I, TSelected>): Plugin<any>;