@tiptap/extension-list 3.0.0-beta.0

package/dist/index.d.ts

@@ -0,0 +1,288 @@
+import { Node, Extension, Editor } from '@tiptap/core';
+import * as _tiptap_pm_model from '@tiptap/pm/model';
+import { NodeType, Node as Node$1 } from '@tiptap/pm/model';
+import { EditorState } from '@tiptap/pm/state';
+
+interface BulletListOptions {
+    /**
+     * The node name for the list items
+     * @default 'listItem'
+     * @example 'paragraph'
+     */
+    itemTypeName: string;
+    /**
+     * HTML attributes to add to the bullet list element
+     * @default {}
+     * @example { class: 'foo' }
+     */
+    HTMLAttributes: Record<string, any>;
+    /**
+     * Keep the marks when splitting the list
+     * @default false
+     * @example true
+     */
+    keepMarks: boolean;
+    /**
+     * Keep the attributes when splitting the list
+     * @default false
+     * @example true
+     */
+    keepAttributes: boolean;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        bulletList: {
+            /**
+             * Toggle a bullet list
+             */
+            toggleBulletList: () => ReturnType;
+        };
+    }
+}
+/**
+ * Matches a bullet list to a dash or asterisk.
+ */
+declare const bulletListInputRegex: RegExp;
+/**
+ * This extension allows you to create bullet lists.
+ * This requires the ListItem extension
+ * @see https://tiptap.dev/api/nodes/bullet-list
+ * @see https://tiptap.dev/api/nodes/list-item.
+ */
+declare const BulletList: Node<BulletListOptions, any>;
+
+interface ListItemOptions {
+    /**
+     * The HTML attributes for a list item node.
+     * @default {}
+     * @example { class: 'foo' }
+     */
+    HTMLAttributes: Record<string, any>;
+    /**
+     * The node type for bulletList nodes
+     * @default 'bulletList'
+     * @example 'myCustomBulletList'
+     */
+    bulletListTypeName: string;
+    /**
+     * The node type for orderedList nodes
+     * @default 'orderedList'
+     * @example 'myCustomOrderedList'
+     */
+    orderedListTypeName: string;
+}
+/**
+ * This extension allows you to create list items.
+ * @see https://www.tiptap.dev/api/nodes/list-item
+ */
+declare const ListItem: Node<ListItemOptions, any>;
+
+type ListKeymapOptions = {
+    /**
+     * An array of list types. This is used for item and wrapper list matching.
+     * @default []
+     * @example [{ itemName: 'listItem', wrapperNames: ['bulletList', 'orderedList'] }]
+     */
+    listTypes: Array<{
+        itemName: string;
+        wrapperNames: string[];
+    }>;
+};
+/**
+ * This extension registers custom keymaps to change the behaviour of the backspace and delete keys.
+ * By default Prosemirror keyhandling will always lift or sink items so paragraphs are joined into
+ * the adjacent or previous list item. This extension will prevent this behaviour and instead will
+ * try to join paragraphs from two list items into a single list item.
+ * @see https://www.tiptap.dev/api/extensions/list-keymap
+ */
+declare const ListKeymap: Extension<ListKeymapOptions, any>;
+
+declare const findListItemPos: (typeOrName: string | NodeType, state: EditorState) => {
+    $pos: _tiptap_pm_model.ResolvedPos;
+    depth: number;
+} | null;
+
+declare const getNextListDepth: (typeOrName: string, state: EditorState) => number | false;
+
+declare const handleBackspace: (editor: Editor, name: string, parentListTypes: string[]) => boolean;
+
+declare const handleDelete: (editor: Editor, name: string) => boolean;
+
+declare const hasListBefore: (editorState: EditorState, name: string, parentListTypes: string[]) => boolean;
+
+declare const hasListItemAfter: (typeOrName: string, state: EditorState) => boolean;
+
+declare const hasListItemBefore: (typeOrName: string, state: EditorState) => boolean;
+
+declare const listItemHasSubList: (typeOrName: string, state: EditorState, node?: Node$1) => boolean;
+
+declare const nextListIsDeeper: (typeOrName: string, state: EditorState) => boolean;
+
+declare const nextListIsHigher: (typeOrName: string, state: EditorState) => boolean;
+
+declare const index_findListItemPos: typeof findListItemPos;
+declare const index_getNextListDepth: typeof getNextListDepth;
+declare const index_handleBackspace: typeof handleBackspace;
+declare const index_handleDelete: typeof handleDelete;
+declare const index_hasListBefore: typeof hasListBefore;
+declare const index_hasListItemAfter: typeof hasListItemAfter;
+declare const index_hasListItemBefore: typeof hasListItemBefore;
+declare const index_listItemHasSubList: typeof listItemHasSubList;
+declare const index_nextListIsDeeper: typeof nextListIsDeeper;
+declare const index_nextListIsHigher: typeof nextListIsHigher;
+declare namespace index {
+  export { index_findListItemPos as findListItemPos, index_getNextListDepth as getNextListDepth, index_handleBackspace as handleBackspace, index_handleDelete as handleDelete, index_hasListBefore as hasListBefore, index_hasListItemAfter as hasListItemAfter, index_hasListItemBefore as hasListItemBefore, index_listItemHasSubList as listItemHasSubList, index_nextListIsDeeper as nextListIsDeeper, index_nextListIsHigher as nextListIsHigher };
+}
+
+interface OrderedListOptions {
+    /**
+     * The node type name for list items.
+     * @default 'listItem'
+     * @example 'myListItem'
+     */
+    itemTypeName: string;
+    /**
+     * The HTML attributes for an ordered list node.
+     * @default {}
+     * @example { class: 'foo' }
+     */
+    HTMLAttributes: Record<string, any>;
+    /**
+     * Keep the marks when splitting a list item.
+     * @default false
+     * @example true
+     */
+    keepMarks: boolean;
+    /**
+     * Keep the attributes when splitting a list item.
+     * @default false
+     * @example true
+     */
+    keepAttributes: boolean;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        orderedList: {
+            /**
+             * Toggle an ordered list
+             * @example editor.commands.toggleOrderedList()
+             */
+            toggleOrderedList: () => ReturnType;
+        };
+    }
+}
+/**
+ * Matches an ordered list to a 1. on input (or any number followed by a dot).
+ */
+declare const orderedListInputRegex: RegExp;
+/**
+ * This extension allows you to create ordered lists.
+ * This requires the ListItem extension
+ * @see https://www.tiptap.dev/api/nodes/ordered-list
+ * @see https://www.tiptap.dev/api/nodes/list-item
+ */
+declare const OrderedList: Node<OrderedListOptions, any>;
+
+interface TaskItemOptions {
+    /**
+     * A callback function that is called when the checkbox is clicked while the editor is in readonly mode.
+     * @param node The prosemirror node of the task item
+     * @param checked The new checked state
+     * @returns boolean
+     */
+    onReadOnlyChecked?: (node: Node$1, checked: boolean) => boolean;
+    /**
+     * Controls whether the task items can be nested or not.
+     * @default false
+     * @example true
+     */
+    nested: boolean;
+    /**
+     * HTML attributes to add to the task item element.
+     * @default {}
+     * @example { class: 'foo' }
+     */
+    HTMLAttributes: Record<string, any>;
+    /**
+     * The node type for taskList nodes
+     * @default 'taskList'
+     * @example 'myCustomTaskList'
+     */
+    taskListTypeName: string;
+}
+/**
+ * Matches a task item to a - [ ] on input.
+ */
+declare const inputRegex: RegExp;
+/**
+ * This extension allows you to create task items.
+ * @see https://www.tiptap.dev/api/nodes/task-item
+ */
+declare const TaskItem: Node<TaskItemOptions, any>;
+
+interface TaskListOptions {
+    /**
+     * The node type name for a task item.
+     * @default 'taskItem'
+     * @example 'myCustomTaskItem'
+     */
+    itemTypeName: string;
+    /**
+     * The HTML attributes for a task list node.
+     * @default {}
+     * @example { class: 'foo' }
+     */
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        taskList: {
+            /**
+             * Toggle a task list
+             * @example editor.commands.toggleTaskList()
+             */
+            toggleTaskList: () => ReturnType;
+        };
+    }
+}
+/**
+ * This extension allows you to create task lists.
+ * @see https://www.tiptap.dev/api/nodes/task-list
+ */
+declare const TaskList: Node<TaskListOptions, any>;
+
+interface ListKitOptions {
+    /**
+     * If set to false, the bulletList extension will not be registered
+     * @example table: false
+     */
+    bulletList: Partial<BulletListOptions> | false;
+    /**
+     * If set to false, the listItem extension will not be registered
+     */
+    listItem: Partial<ListItemOptions> | false;
+    /**
+     * If set to false, the listKeymap extension will not be registered
+     */
+    listKeymap: Partial<ListKeymapOptions> | false;
+    /**
+     * If set to false, the orderedList extension will not be registered
+     */
+    orderedList: Partial<OrderedListOptions> | false;
+    /**
+     * If set to false, the taskItem extension will not be registered
+     */
+    taskItem: Partial<TaskItemOptions> | false;
+    /**
+     * If set to false, the taskList extension will not be registered
+     */
+    taskList: Partial<TaskListOptions> | false;
+}
+/**
+ * The table kit is a collection of table editor extensions.
+ *
+ * It’s a good starting point for building your own table in Tiptap.
+ */
+declare const ListKit: Extension<ListKitOptions, any>;
+
+export { BulletList, type BulletListOptions, ListItem, type ListItemOptions, ListKeymap, type ListKeymapOptions, ListKit, type ListKitOptions, OrderedList, type OrderedListOptions, TaskItem, type TaskItemOptions, TaskList, type TaskListOptions, bulletListInputRegex, inputRegex, index as listHelpers, orderedListInputRegex };