@tiptap/extension-task-item 2.6.2 → 3.0.0-next.1

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

@@ -1,50 +0,0 @@
-import { EditorState, Plugin } from '@tiptap/pm/state';
-import { Editor } from './Editor.js';
-import { CanCommands, ChainedCommands, ExtendedRegExpMatchArray, Range, SingleCommands } from './types.js';
-export type PasteRuleMatch = {
-    index: number;
-    text: string;
-    replaceWith?: string;
-    match?: RegExpMatchArray;
-    data?: Record<string, any>;
-};
-export type PasteRuleFinder = RegExp | ((text: string, event?: ClipboardEvent | null) => PasteRuleMatch[] | null | undefined);
-/**
- * Paste rules are used to react to pasted content.
- * @see https://tiptap.dev/guide/custom-extensions/#paste-rules
- */
-export declare class PasteRule {
-    find: PasteRuleFinder;
-    handler: (props: {
-        state: EditorState;
-        range: Range;
-        match: ExtendedRegExpMatchArray;
-        commands: SingleCommands;
-        chain: () => ChainedCommands;
-        can: () => CanCommands;
-        pasteEvent: ClipboardEvent | null;
-        dropEvent: DragEvent | null;
-    }) => void | null;
-    constructor(config: {
-        find: PasteRuleFinder;
-        handler: (props: {
-            can: () => CanCommands;
-            chain: () => ChainedCommands;
-            commands: SingleCommands;
-            dropEvent: DragEvent | null;
-            match: ExtendedRegExpMatchArray;
-            pasteEvent: ClipboardEvent | null;
-            range: Range;
-            state: EditorState;
-        }) => void | null;
-    });
-}
-/**
- * Create an paste rules plugin. When enabled, it will cause pasted
- * text that matches any of the given rules to trigger the rule’s
- * action.
- */
-export declare function pasteRulesPlugin(props: {
-    editor: Editor;
-    rules: PasteRule[];
-}): Plugin[];

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

@@ -1,11 +0,0 @@
-import { Transaction } from '@tiptap/pm/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

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

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

@@ -1,14 +0,0 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        clearContent: {
-            /**
-             * Clear the whole document.
-             * @param emitUpdate Whether to emit an update event.
-             * @example editor.commands.clearContent()
-             */
-            clearContent: (emitUpdate?: boolean) => ReturnType;
-        };
-    }
-}
-export declare const clearContent: RawCommands['clearContent'];

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

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

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

@@ -1,18 +0,0 @@
-import { Command, RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        command: {
-            /**
-             * Define a command inline.
-             * @param fn The command function.
-             * @example
-             * editor.commands.command(({ tr, state }) => {
-             *   ...
-             *   return true
-             * })
-             */
-            command: (fn: (props: Parameters<Command>[0]) => boolean) => ReturnType;
-        };
-    }
-}
-export declare const command: RawCommands['command'];

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

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

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

@@ -1,20 +0,0 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        cut: {
-            /**
-             * Cuts content from a range and inserts it at a given position.
-             * @param range The range to cut.
-             * @param range.from The start position of the range.
-             * @param range.to The end position of the range.
-             * @param targetPos The position to insert the content at.
-             * @example editor.commands.cut({ from: 1, to: 3 }, 5)
-             */
-            cut: ({ from, to }: {
-                from: number;
-                to: number;
-            }, targetPos: number) => ReturnType;
-        };
-    }
-}
-export declare const cut: RawCommands['cut'];

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

@@ -1,13 +0,0 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        deleteCurrentNode: {
-            /**
-             * Delete the node that currently has the selection anchor.
-             * @example editor.commands.deleteCurrentNode()
-             */
-            deleteCurrentNode: () => ReturnType;
-        };
-    }
-}
-export declare const deleteCurrentNode: RawCommands['deleteCurrentNode'];

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

@@ -1,15 +0,0 @@
-import { NodeType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        deleteNode: {
-            /**
-             * Delete a node with a given type or name.
-             * @param typeOrName The type or name of the node.
-             * @example editor.commands.deleteNode('paragraph')
-             */
-            deleteNode: (typeOrName: string | NodeType) => ReturnType;
-        };
-    }
-}
-export declare const deleteNode: RawCommands['deleteNode'];

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

@@ -1,14 +0,0 @@
-import { Range, RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        deleteRange: {
-            /**
-             * Delete a given range.
-             * @param range The range to delete.
-             * @example editor.commands.deleteRange({ from: 1, to: 3 })
-             */
-            deleteRange: (range: Range) => ReturnType;
-        };
-    }
-}
-export declare const deleteRange: RawCommands['deleteRange'];

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

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

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

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

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

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

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

@@ -1,25 +0,0 @@
-import { MarkType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        extendMarkRange: {
-            /**
-             * Extends the text selection to the current mark by type or name.
-             * @param typeOrName The type or name of the mark.
-             * @param attributes The attributes of the mark.
-             * @example editor.commands.extendMarkRange('bold')
-             * @example editor.commands.extendMarkRange('mention', { userId: "1" })
-             */
-            extendMarkRange: (
-            /**
-             * The type or name of the mark.
-             */
-            typeOrName: string | MarkType, 
-            /**
-             * The attributes of the mark.
-             */
-            attributes?: Record<string, any>) => ReturnType;
-        };
-    }
-}
-export declare const extendMarkRange: RawCommands['extendMarkRange'];

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

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

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

@@ -1,27 +0,0 @@
-import { FocusPosition, RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        focus: {
-            /**
-             * Focus the editor at the given position.
-             * @param position The position to focus at.
-             * @param options.scrollIntoView Scroll the focused position into view after focusing
-             * @example editor.commands.focus()
-             * @example editor.commands.focus(32, { scrollIntoView: false })
-             */
-            focus: (
-            /**
-             * The position to focus at.
-             */
-            position?: FocusPosition, 
-            /**
-             * Optional options
-             * @default { scrollIntoView: true }
-             */
-            options?: {
-                scrollIntoView?: boolean;
-            }) => ReturnType;
-        };
-    }
-}
-export declare const focus: RawCommands['focus'];

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

@@ -1,14 +0,0 @@
-import { CommandProps, RawCommands } from '../types.js';
-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/index.d.ts

@@ -1,55 +0,0 @@
-export * from './blur.js';
-export * from './clearContent.js';
-export * from './clearNodes.js';
-export * from './command.js';
-export * from './createParagraphNear.js';
-export * from './cut.js';
-export * from './deleteCurrentNode.js';
-export * from './deleteNode.js';
-export * from './deleteRange.js';
-export * from './deleteSelection.js';
-export * from './enter.js';
-export * from './exitCode.js';
-export * from './extendMarkRange.js';
-export * from './first.js';
-export * from './focus.js';
-export * from './forEach.js';
-export * from './insertContent.js';
-export * from './insertContentAt.js';
-export * from './join.js';
-export * from './joinItemBackward.js';
-export * from './joinItemForward.js';
-export * from './joinTextblockBackward.js';
-export * from './joinTextblockForward.js';
-export * from './keyboardShortcut.js';
-export * from './lift.js';
-export * from './liftEmptyBlock.js';
-export * from './liftListItem.js';
-export * from './newlineInCode.js';
-export * from './resetAttributes.js';
-export * from './scrollIntoView.js';
-export * from './selectAll.js';
-export * from './selectNodeBackward.js';
-export * from './selectNodeForward.js';
-export * from './selectParentNode.js';
-export * from './selectTextblockEnd.js';
-export * from './selectTextblockStart.js';
-export * from './setContent.js';
-export * from './setMark.js';
-export * from './setMeta.js';
-export * from './setNode.js';
-export * from './setNodeSelection.js';
-export * from './setTextSelection.js';
-export * from './sinkListItem.js';
-export * from './splitBlock.js';
-export * from './splitListItem.js';
-export * from './toggleList.js';
-export * from './toggleMark.js';
-export * from './toggleNode.js';
-export * from './toggleWrap.js';
-export * from './undoInputRule.js';
-export * from './unsetAllMarks.js';
-export * from './unsetMark.js';
-export * from './updateAttributes.js';
-export * from './wrapIn.js';
-export * from './wrapInList.js';

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

@@ -1,34 +0,0 @@
-import { ParseOptions } from '@tiptap/pm/model';
-import { Content, RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        insertContent: {
-            /**
-             * Insert a node or string of HTML at the current position.
-             * @example editor.commands.insertContent('<h1>Example</h1>')
-             * @example editor.commands.insertContent('<h1>Example</h1>', { updateSelection: false })
-             */
-            insertContent: (
-            /**
-             * The ProseMirror content to insert.
-             */
-            value: Content, 
-            /**
-             * Optional options
-             */
-            options?: {
-                /**
-                 * Options for parsing the content.
-                 */
-                parseOptions?: ParseOptions;
-                /**
-                 * Whether to update the selection after inserting the content.
-                 */
-                updateSelection?: boolean;
-                applyInputRules?: boolean;
-                applyPasteRules?: boolean;
-            }) => ReturnType;
-        };
-    }
-}
-export declare const insertContent: RawCommands['insertContent'];

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

@@ -1,47 +0,0 @@
-import { ParseOptions } from '@tiptap/pm/model';
-import { Content, Range, RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        insertContentAt: {
-            /**
-             * Insert a node or string of HTML at a specific position.
-             * @example editor.commands.insertContentAt(0, '<h1>Example</h1>')
-             */
-            insertContentAt: (
-            /**
-             * The position to insert the content at.
-             */
-            position: number | Range, 
-            /**
-             * The ProseMirror content to insert.
-             */
-            value: Content, 
-            /**
-             * Optional options
-             */
-            options?: {
-                /**
-                 * Options for parsing the content.
-                 */
-                parseOptions?: ParseOptions;
-                /**
-                 * Whether to update the selection after inserting the content.
-                 */
-                updateSelection?: boolean;
-                /**
-                 * Whether to apply input rules after inserting the content.
-                 */
-                applyInputRules?: boolean;
-                /**
-                 * Whether to apply paste rules after inserting the content.
-                 */
-                applyPasteRules?: boolean;
-                /**
-                 * Whether to throw an error if the content is invalid.
-                 */
-                errorOnInvalidContent?: boolean;
-            }) => ReturnType;
-        };
-    }
-}
-export declare const insertContentAt: RawCommands['insertContentAt'];

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

@@ -1,41 +0,0 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        joinUp: {
-            /**
-             * Join the selected block or, if there is a text selection, the closest ancestor block of the selection that can be joined, with the sibling above it.
-             * @example editor.commands.joinUp()
-             */
-            joinUp: () => ReturnType;
-        };
-        joinDown: {
-            /**
-             * Join the selected block, or the closest ancestor of the selection that can be joined, with the sibling after it.
-             * @example editor.commands.joinDown()
-             */
-            joinDown: () => ReturnType;
-        };
-        joinBackward: {
-            /**
-             * If the selection is empty and at the start of a textblock, try to reduce the distance between that block and the one before it—if there's a block directly before it that can be joined, join them.
-             * If not, try to move the selected block closer to the next one in the document structure by lifting it out of its
-             * parent or moving it into a parent of the previous block. Will use the view for accurate (bidi-aware) start-of-textblock detection if given.
-             * @example editor.commands.joinBackward()
-             */
-            joinBackward: () => ReturnType;
-        };
-        joinForward: {
-            /**
-             * If the selection is empty and the cursor is at the end of a textblock, try to reduce or remove the boundary between that block and the one after it,
-             * either by joining them or by moving the other block closer to this one in the tree structure.
-             * Will use the view for accurate start-of-textblock detection if given.
-             * @example editor.commands.joinForward()
-             */
-            joinForward: () => ReturnType;
-        };
-    }
-}
-export declare const joinUp: RawCommands['joinUp'];
-export declare const joinDown: RawCommands['joinDown'];
-export declare const joinBackward: RawCommands['joinBackward'];
-export declare const joinForward: RawCommands['joinForward'];

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

@@ -1,13 +0,0 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        joinItemBackward: {
-            /**
-             * Join two items backward.
-             * @example editor.commands.joinItemBackward()
-             */
-            joinItemBackward: () => ReturnType;
-        };
-    }
-}
-export declare const joinItemBackward: RawCommands['joinItemBackward'];

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

@@ -1,13 +0,0 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        joinItemForward: {
-            /**
-             * Join two items Forwards.
-             * @example editor.commands.joinItemForward()
-             */
-            joinItemForward: () => ReturnType;
-        };
-    }
-}
-export declare const joinItemForward: RawCommands['joinItemForward'];

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

@@ -1,12 +0,0 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        joinTextblockBackward: {
-            /**
-             * A more limited form of joinBackward that only tries to join the current textblock to the one before it, if the cursor is at the start of a textblock.
-             */
-            joinTextblockBackward: () => ReturnType;
-        };
-    }
-}
-export declare const joinTextblockBackward: RawCommands['joinTextblockBackward'];

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

@@ -1,12 +0,0 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        joinTextblockForward: {
-            /**
-             * A more limited form of joinForward that only tries to join the current textblock to the one after it, if the cursor is at the end of a textblock.
-             */
-            joinTextblockForward: () => ReturnType;
-        };
-    }
-}
-export declare const joinTextblockForward: RawCommands['joinTextblockForward'];

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

@@ -1,14 +0,0 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        keyboardShortcut: {
-            /**
-             * Trigger a keyboard shortcut.
-             * @param name The name of the keyboard shortcut.
-             * @example editor.commands.keyboardShortcut('Mod-b')
-             */
-            keyboardShortcut: (name: string) => ReturnType;
-        };
-    }
-}
-export declare const keyboardShortcut: RawCommands['keyboardShortcut'];

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

@@ -1,17 +0,0 @@
-import { NodeType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        lift: {
-            /**
-             * Removes an existing wrap if possible lifting the node out of it
-             * @param typeOrName The type or name of the node.
-             * @param attributes The attributes of the node.
-             * @example editor.commands.lift('paragraph')
-             * @example editor.commands.lift('heading', { level: 1 })
-             */
-            lift: (typeOrName: string | NodeType, attributes?: Record<string, any>) => ReturnType;
-        };
-    }
-}
-export declare const lift: RawCommands['lift'];

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

@@ -1,13 +0,0 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        liftEmptyBlock: {
-            /**
-             * If the cursor is in an empty textblock that can be lifted, lift the block.
-             * @example editor.commands.liftEmptyBlock()
-             */
-            liftEmptyBlock: () => ReturnType;
-        };
-    }
-}
-export declare const liftEmptyBlock: RawCommands['liftEmptyBlock'];

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

@@ -1,15 +0,0 @@
-import { NodeType } from '@tiptap/pm/model';
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        liftListItem: {
-            /**
-             * Create a command to lift the list item around the selection up into a wrapping list.
-             * @param typeOrName The type or name of the node.
-             * @example editor.commands.liftListItem('listItem')
-             */
-            liftListItem: (typeOrName: string | NodeType) => ReturnType;
-        };
-    }
-}
-export declare const liftListItem: RawCommands['liftListItem'];

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

@@ -1,13 +0,0 @@
-import { RawCommands } from '../types.js';
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        newlineInCode: {
-            /**
-             * Add a newline character in code.
-             * @example editor.commands.newlineInCode()
-             */
-            newlineInCode: () => ReturnType;
-        };
-    }
-}
-export declare const newlineInCode: RawCommands['newlineInCode'];