@tiptap/starter-kit 2.0.0-beta.105 → 2.0.0-beta.106

package/dist/packages/core/src/Node.d.ts

@@ -0,0 +1,339 @@
+import { DOMOutputSpec, NodeSpec, Node as ProseMirrorNode, NodeType } from 'prosemirror-model';
+import { Plugin, Transaction } from 'prosemirror-state';
+import { InputRule } from 'prosemirror-inputrules';
+import { Extensions, Attributes, NodeViewRenderer, GlobalAttributes, RawCommands, ParentConfig, KeyboardShortcutCommand } from './types';
+import { NodeConfig } from '.';
+import { Editor } from './Editor';
+declare module '@tiptap/core' {
+    interface NodeConfig<Options = any> {
+        [key: string]: any;
+        /**
+         * Name
+         */
+        name: string;
+        /**
+         * Priority
+         */
+        priority?: number;
+        /**
+         * Default options
+         */
+        defaultOptions?: Options;
+        /**
+         * Global attributes
+         */
+        addGlobalAttributes?: (this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['addGlobalAttributes'];
+        }) => GlobalAttributes | {};
+        /**
+         * Raw
+         */
+        addCommands?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['addCommands'];
+        }) => Partial<RawCommands>;
+        /**
+         * Keyboard shortcuts
+         */
+        addKeyboardShortcuts?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['addKeyboardShortcuts'];
+        }) => {
+            [key: string]: KeyboardShortcutCommand;
+        };
+        /**
+         * Input rules
+         */
+        addInputRules?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['addInputRules'];
+        }) => InputRule[];
+        /**
+         * Paste rules
+         */
+        addPasteRules?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['addPasteRules'];
+        }) => Plugin[];
+        /**
+         * ProseMirror plugins
+         */
+        addProseMirrorPlugins?: (this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['addProseMirrorPlugins'];
+        }) => Plugin[];
+        /**
+         * Extensions
+         */
+        addExtensions?: (this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['addExtensions'];
+        }) => Extensions;
+        /**
+         * Extend Node Schema
+         */
+        extendNodeSchema?: ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['extendNodeSchema'];
+        }, extension: Node) => Record<string, any>) | null;
+        /**
+         * Extend Mark Schema
+         */
+        extendMarkSchema?: ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['extendMarkSchema'];
+        }, extension: Node) => Record<string, any>) | null;
+        /**
+         * The editor is not ready yet.
+         */
+        onBeforeCreate?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['onBeforeCreate'];
+        }) => void) | null;
+        /**
+         * The editor is ready.
+         */
+        onCreate?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['onCreate'];
+        }) => void) | null;
+        /**
+         * The content has changed.
+         */
+        onUpdate?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['onUpdate'];
+        }) => void) | null;
+        /**
+         * The selection has changed.
+         */
+        onSelectionUpdate?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['onSelectionUpdate'];
+        }) => void) | null;
+        /**
+         * The editor state has changed.
+         */
+        onTransaction?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['onTransaction'];
+        }, props: {
+            transaction: Transaction;
+        }) => void) | null;
+        /**
+         * The editor is focused.
+         */
+        onFocus?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['onFocus'];
+        }, props: {
+            event: FocusEvent;
+        }) => void) | null;
+        /**
+         * The editor isn’t focused anymore.
+         */
+        onBlur?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['onBlur'];
+        }, props: {
+            event: FocusEvent;
+        }) => void) | null;
+        /**
+         * The editor is destroyed.
+         */
+        onDestroy?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['onDestroy'];
+        }) => void) | null;
+        /**
+         * Node View
+         */
+        addNodeView?: ((this: {
+            name: string;
+            options: Options;
+            editor: Editor;
+            type: NodeType;
+            parent: ParentConfig<NodeConfig<Options>>['addNodeView'];
+        }) => NodeViewRenderer) | null;
+        /**
+         * TopNode
+         */
+        topNode?: boolean;
+        /**
+         * Content
+         */
+        content?: NodeSpec['content'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['content'];
+        }) => NodeSpec['content']);
+        /**
+         * Marks
+         */
+        marks?: NodeSpec['marks'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['marks'];
+        }) => NodeSpec['marks']);
+        /**
+         * Group
+         */
+        group?: NodeSpec['group'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['group'];
+        }) => NodeSpec['group']);
+        /**
+         * Inline
+         */
+        inline?: NodeSpec['inline'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['inline'];
+        }) => NodeSpec['inline']);
+        /**
+         * Atom
+         */
+        atom?: NodeSpec['atom'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['atom'];
+        }) => NodeSpec['atom']);
+        /**
+         * Selectable
+         */
+        selectable?: NodeSpec['selectable'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['selectable'];
+        }) => NodeSpec['selectable']);
+        /**
+         * Draggable
+         */
+        draggable?: NodeSpec['draggable'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['draggable'];
+        }) => NodeSpec['draggable']);
+        /**
+         * Code
+         */
+        code?: NodeSpec['code'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['code'];
+        }) => NodeSpec['code']);
+        /**
+         * Defining
+         */
+        defining?: NodeSpec['defining'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['defining'];
+        }) => NodeSpec['defining']);
+        /**
+         * Isolating
+         */
+        isolating?: NodeSpec['isolating'] | ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['isolating'];
+        }) => NodeSpec['isolating']);
+        /**
+         * Parse HTML
+         */
+        parseHTML?: (this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['parseHTML'];
+        }) => NodeSpec['parseDOM'];
+        /**
+         * Render HTML
+         */
+        renderHTML?: ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['renderHTML'];
+        }, props: {
+            node: ProseMirrorNode;
+            HTMLAttributes: Record<string, any>;
+        }) => DOMOutputSpec) | null;
+        /**
+         * Render Text
+         */
+        renderText?: ((this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['renderText'];
+        }, props: {
+            node: ProseMirrorNode;
+            pos: number;
+            parent: ProseMirrorNode;
+            index: number;
+        }) => string) | null;
+        /**
+         * Add Attributes
+         */
+        addAttributes?: (this: {
+            name: string;
+            options: Options;
+            parent: ParentConfig<NodeConfig<Options>>['addAttributes'];
+        }) => Attributes | {};
+    }
+}
+export declare class Node<Options = any> {
+    type: string;
+    name: string;
+    parent: Node | null;
+    child: Node | null;
+    options: Options;
+    config: NodeConfig;
+    constructor(config?: Partial<NodeConfig<Options>>);
+    static create<O>(config?: Partial<NodeConfig<O>>): Node<O>;
+    configure(options?: Partial<Options>): Node<Options>;
+    extend<ExtendedOptions = Options>(extendedConfig?: Partial<NodeConfig<ExtendedOptions>>): Node<ExtendedOptions>;
+}

package/dist/packages/core/src/NodeView.d.ts

@@ -0,0 +1,27 @@
+import { Decoration, NodeView as ProseMirrorNodeView } from 'prosemirror-view';
+import { Node as ProseMirrorNode } from 'prosemirror-model';
+import { Editor as CoreEditor } from './Editor';
+import { Node } from './Node';
+import { NodeViewRendererProps, NodeViewRendererOptions } from './types';
+export declare class NodeView<Component, Editor extends CoreEditor = CoreEditor, Options extends NodeViewRendererOptions = NodeViewRendererOptions> implements ProseMirrorNodeView {
+    component: Component;
+    editor: Editor;
+    options: Options;
+    extension: Node;
+    node: ProseMirrorNode;
+    decorations: Decoration[];
+    getPos: any;
+    isDragging: boolean;
+    constructor(component: Component, props: NodeViewRendererProps, options?: Partial<Options>);
+    mount(): void;
+    get dom(): Element | null;
+    get contentDOM(): Element | null;
+    onDragStart(event: DragEvent): void;
+    stopEvent(event: Event): boolean;
+    ignoreMutation(mutation: MutationRecord | {
+        type: 'selection';
+        target: Element;
+    }): boolean;
+    updateAttributes(attributes: {}): void;
+    deleteNode(): void;
+}

package/dist/packages/core/src/Tracker.d.ts

@@ -0,0 +1,11 @@
+import { Transaction } from 'prosemirror-state';
+export interface TrackerResult {
+    position: number;
+    deleted: boolean;
+}
+export declare class Tracker {
+    transaction: Transaction;
+    currentStep: number;
+    constructor(transaction: Transaction);
+    map(position: number): TrackerResult;
+}

package/dist/packages/core/src/commands/blur.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        blur: {
+            /**
+             * Removes focus from the editor.
+             */
+            blur: () => ReturnType;
+        };
+    }
+}
+export declare const blur: RawCommands['blur'];

package/dist/packages/core/src/commands/clearContent.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        clearContent: {
+            /**
+             * Clear the whole document.
+             */
+            clearContent: (emitUpdate?: boolean) => ReturnType;
+        };
+    }
+}
+export declare const clearContent: RawCommands['clearContent'];

package/dist/packages/core/src/commands/clearNodes.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        clearNodes: {
+            /**
+             * Normalize nodes to a simple paragraph.
+             */
+            clearNodes: () => ReturnType;
+        };
+    }
+}
+export declare const clearNodes: RawCommands['clearNodes'];

package/dist/packages/core/src/commands/command.d.ts

@@ -0,0 +1,12 @@
+import { Command, RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        command: {
+            /**
+             * Define a command inline.
+             */
+            command: (fn: (props: Parameters<Command>[0]) => boolean) => ReturnType;
+        };
+    }
+}
+export declare const command: RawCommands['command'];

package/dist/packages/core/src/commands/createParagraphNear.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        createParagraphNear: {
+            /**
+             * Create a paragraph nearby.
+             */
+            createParagraphNear: () => ReturnType;
+        };
+    }
+}
+export declare const createParagraphNear: RawCommands['createParagraphNear'];

package/dist/packages/core/src/commands/deleteNode.d.ts

@@ -0,0 +1,13 @@
+import { NodeType } from 'prosemirror-model';
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        deleteNode: {
+            /**
+             * Delete a node.
+             */
+            deleteNode: (typeOrName: string | NodeType) => ReturnType;
+        };
+    }
+}
+export declare const deleteNode: RawCommands['deleteNode'];

package/dist/packages/core/src/commands/deleteRange.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands, Range } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        deleteRange: {
+            /**
+             * Delete a given range.
+             */
+            deleteRange: (range: Range) => ReturnType;
+        };
+    }
+}
+export declare const deleteRange: RawCommands['deleteRange'];

package/dist/packages/core/src/commands/deleteSelection.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        deleteSelection: {
+            /**
+             * Delete the selection, if there is one.
+             */
+            deleteSelection: () => ReturnType;
+        };
+    }
+}
+export declare const deleteSelection: RawCommands['deleteSelection'];

package/dist/packages/core/src/commands/enter.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        enter: {
+            /**
+             * Trigger enter.
+             */
+            enter: () => ReturnType;
+        };
+    }
+}
+export declare const enter: RawCommands['enter'];

package/dist/packages/core/src/commands/exitCode.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        exitCode: {
+            /**
+             * Exit from a code block.
+             */
+            exitCode: () => ReturnType;
+        };
+    }
+}
+export declare const exitCode: RawCommands['exitCode'];

package/dist/packages/core/src/commands/extendMarkRange.d.ts

@@ -0,0 +1,13 @@
+import { MarkType } from 'prosemirror-model';
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        extendMarkRange: {
+            /**
+             * Extends the text selection to the current mark.
+             */
+            extendMarkRange: (typeOrName: string | MarkType, attributes?: Record<string, any>) => ReturnType;
+        };
+    }
+}
+export declare const extendMarkRange: RawCommands['extendMarkRange'];

package/dist/packages/core/src/commands/first.d.ts

@@ -0,0 +1,12 @@
+import { Command, CommandProps, RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        first: {
+            /**
+             * Runs one command after the other and stops at the first which returns true.
+             */
+            first: (commands: Command[] | ((props: CommandProps) => Command[])) => ReturnType;
+        };
+    }
+}
+export declare const first: RawCommands['first'];

package/dist/packages/core/src/commands/focus.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands, FocusPosition } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        focus: {
+            /**
+             * Focus the editor at the given position.
+             */
+            focus: (position?: FocusPosition) => ReturnType;
+        };
+    }
+}
+export declare const focus: RawCommands['focus'];

package/dist/packages/core/src/commands/forEach.d.ts

@@ -0,0 +1,14 @@
+import { CommandProps, RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        forEach: {
+            /**
+             * Loop through an array of items.
+             */
+            forEach: <T>(items: T[], fn: (item: T, props: CommandProps & {
+                index: number;
+            }) => boolean) => ReturnType;
+        };
+    }
+}
+export declare const forEach: RawCommands['forEach'];

package/dist/packages/core/src/commands/insertContent.d.ts

@@ -0,0 +1,13 @@
+import { CreateNodeFromContentOptions } from '../helpers/createNodeFromContent';
+import { RawCommands, Content } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        insertContent: {
+            /**
+             * Insert a node or string of HTML at the current position.
+             */
+            insertContent: (value: Content, options?: CreateNodeFromContentOptions) => ReturnType;
+        };
+    }
+}
+export declare const insertContent: RawCommands['insertContent'];

package/dist/packages/core/src/commands/insertContentAt.d.ts

@@ -0,0 +1,13 @@
+import { CreateNodeFromContentOptions } from '../helpers/createNodeFromContent';
+import { RawCommands, Content, Range } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        insertContentAt: {
+            /**
+             * Insert a node or string of HTML at a specific position.
+             */
+            insertContentAt: (position: number | Range, value: Content, options?: CreateNodeFromContentOptions) => ReturnType;
+        };
+    }
+}
+export declare const insertContentAt: RawCommands['insertContentAt'];

package/dist/packages/core/src/commands/joinBackward.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        joinBackward: {
+            /**
+             * Join two nodes backward.
+             */
+            joinBackward: () => ReturnType;
+        };
+    }
+}
+export declare const joinBackward: RawCommands['joinBackward'];

package/dist/packages/core/src/commands/joinForward.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        joinForward: {
+            /**
+             * Join two nodes forward.
+             */
+            joinForward: () => ReturnType;
+        };
+    }
+}
+export declare const joinForward: RawCommands['joinForward'];

package/dist/packages/core/src/commands/keyboardShortcut.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        keyboardShortcut: {
+            /**
+             * Trigger a keyboard shortcut.
+             */
+            keyboardShortcut: (name: string) => ReturnType;
+        };
+    }
+}
+export declare const keyboardShortcut: RawCommands['keyboardShortcut'];

package/dist/packages/core/src/commands/lift.d.ts

@@ -0,0 +1,13 @@
+import { NodeType } from 'prosemirror-model';
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        lift: {
+            /**
+             * Removes an existing wrap.
+             */
+            lift: (typeOrName: string | NodeType, attributes?: Record<string, any>) => ReturnType;
+        };
+    }
+}
+export declare const lift: RawCommands['lift'];

package/dist/packages/core/src/commands/liftEmptyBlock.d.ts

@@ -0,0 +1,12 @@
+import { RawCommands } from '../types';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        liftEmptyBlock: {
+            /**
+             * Lift block if empty.
+             */
+            liftEmptyBlock: () => ReturnType;
+        };
+    }
+}
+export declare const liftEmptyBlock: RawCommands['liftEmptyBlock'];