@tiptap/react 2.0.0-beta.91 → 2.0.0-beta.92

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

@@ -0,0 +1,319 @@
+import { DOMOutputSpec, MarkSpec, Mark as ProseMirrorMark, MarkType } from 'prosemirror-model';
+import { Plugin, Transaction } from 'prosemirror-state';
+import { InputRule } from './InputRule';
+import { PasteRule } from './PasteRule';
+import { Extensions, Attributes, RawCommands, GlobalAttributes, ParentConfig, KeyboardShortcutCommand } from './types';
+import { Node } from './Node';
+import { MarkConfig } from '.';
+import { Editor } from './Editor';
+declare module '@tiptap/core' {
+    interface MarkConfig<Options = any, Storage = any> {
+        [key: string]: any;
+        /**
+         * Name
+         */
+        name: string;
+        /**
+         * Priority
+         */
+        priority?: number;
+        /**
+         * Default options
+         */
+        defaultOptions?: Options;
+        /**
+         * Default Options
+         */
+        addOptions?: (this: {
+            name: string;
+            parent: Exclude<ParentConfig<MarkConfig<Options, Storage>>['addOptions'], undefined>;
+        }) => Options;
+        /**
+         * Default Storage
+         */
+        addStorage?: (this: {
+            name: string;
+            options: Options;
+            parent: Exclude<ParentConfig<MarkConfig<Options, Storage>>['addStorage'], undefined>;
+        }) => Storage;
+        /**
+         * Global attributes
+         */
+        addGlobalAttributes?: (this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addGlobalAttributes'];
+        }) => GlobalAttributes | {};
+        /**
+         * Raw
+         */
+        addCommands?: (this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addCommands'];
+        }) => Partial<RawCommands>;
+        /**
+         * Keyboard shortcuts
+         */
+        addKeyboardShortcuts?: (this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addKeyboardShortcuts'];
+        }) => {
+            [key: string]: KeyboardShortcutCommand;
+        };
+        /**
+         * Input rules
+         */
+        addInputRules?: (this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addInputRules'];
+        }) => InputRule[];
+        /**
+         * Paste rules
+         */
+        addPasteRules?: (this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addPasteRules'];
+        }) => PasteRule[];
+        /**
+         * ProseMirror plugins
+         */
+        addProseMirrorPlugins?: (this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addProseMirrorPlugins'];
+        }) => Plugin[];
+        /**
+         * Extensions
+         */
+        addExtensions?: (this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addExtensions'];
+        }) => Extensions;
+        /**
+         * Extend Node Schema
+         */
+        extendNodeSchema?: ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['extendNodeSchema'];
+        }, extension: Node) => Record<string, any>) | null;
+        /**
+         * Extend Mark Schema
+         */
+        extendMarkSchema?: ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['extendMarkSchema'];
+        }, extension: Mark) => Record<string, any>) | null;
+        /**
+         * The editor is not ready yet.
+         */
+        onBeforeCreate?: ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onBeforeCreate'];
+        }) => void) | null;
+        /**
+         * The editor is ready.
+         */
+        onCreate?: ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onCreate'];
+        }) => void) | null;
+        /**
+         * The content has changed.
+         */
+        onUpdate?: ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onUpdate'];
+        }) => void) | null;
+        /**
+         * The selection has changed.
+         */
+        onSelectionUpdate?: ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onSelectionUpdate'];
+        }) => void) | null;
+        /**
+         * The editor state has changed.
+         */
+        onTransaction?: ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onTransaction'];
+        }, props: {
+            transaction: Transaction;
+        }) => void) | null;
+        /**
+         * The editor is focused.
+         */
+        onFocus?: ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onFocus'];
+        }, props: {
+            event: FocusEvent;
+        }) => void) | null;
+        /**
+         * The editor isn’t focused anymore.
+         */
+        onBlur?: ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onBlur'];
+        }, props: {
+            event: FocusEvent;
+        }) => void) | null;
+        /**
+         * The editor is destroyed.
+         */
+        onDestroy?: ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            editor: Editor;
+            type: MarkType;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['onDestroy'];
+        }) => void) | null;
+        /**
+         * Keep mark after split node
+         */
+        keepOnSplit?: boolean | (() => boolean);
+        /**
+         * Inclusive
+         */
+        inclusive?: MarkSpec['inclusive'] | ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['inclusive'];
+        }) => MarkSpec['inclusive']);
+        /**
+         * Excludes
+         */
+        excludes?: MarkSpec['excludes'] | ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['excludes'];
+        }) => MarkSpec['excludes']);
+        /**
+         * Group
+         */
+        group?: MarkSpec['group'] | ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['group'];
+        }) => MarkSpec['group']);
+        /**
+         * Spanning
+         */
+        spanning?: MarkSpec['spanning'] | ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['spanning'];
+        }) => MarkSpec['spanning']);
+        /**
+         * Code
+         */
+        code?: boolean | ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['code'];
+        }) => boolean);
+        /**
+         * Parse HTML
+         */
+        parseHTML?: (this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['parseHTML'];
+        }) => MarkSpec['parseDOM'];
+        /**
+         * Render HTML
+         */
+        renderHTML?: ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['renderHTML'];
+        }, props: {
+            mark: ProseMirrorMark;
+            HTMLAttributes: Record<string, any>;
+        }) => DOMOutputSpec) | null;
+        /**
+         * Attributes
+         */
+        addAttributes?: (this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<MarkConfig<Options, Storage>>['addAttributes'];
+        }) => Attributes | {};
+    }
+}
+export declare class Mark<Options = any, Storage = any> {
+    type: string;
+    name: string;
+    parent: Mark | null;
+    child: Mark | null;
+    options: Options;
+    storage: Storage;
+    config: MarkConfig;
+    constructor(config?: Partial<MarkConfig<Options, Storage>>);
+    static create<O = any, S = any>(config?: Partial<MarkConfig<O, S>>): Mark<O, S>;
+    configure(options?: Partial<Options>): Mark<Options, Storage>;
+    extend<ExtendedOptions = Options, ExtendedStorage = Storage>(extendedConfig?: Partial<MarkConfig<ExtendedOptions, ExtendedStorage>>): Mark<ExtendedOptions, ExtendedStorage>;
+}

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

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