@tiptap/react 2.0.0-alpha.2 → 2.0.0-beta.101

package/dist/packages/extension-code-block-lowlight/src/lowlight-plugin.d.ts

@@ -0,0 +1,6 @@
+import { Plugin } from 'prosemirror-state';
+export declare function LowlightPlugin({ name, lowlight, defaultLanguage }: {
+    name: string;
+    lowlight: any;
+    defaultLanguage: string | null | undefined;
+}): Plugin<any, any>;

package/dist/packages/extension-collaboration/src/collaboration.d.ts

@@ -0,0 +1,30 @@
+import { Extension } from '@tiptap/core';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        collaboration: {
+            /**
+             * Undo recent changes
+             */
+            undo: () => ReturnType;
+            /**
+             * Reapply reverted changes
+             */
+            redo: () => ReturnType;
+        };
+    }
+}
+export interface CollaborationOptions {
+    /**
+     * An initialized Y.js document.
+     */
+    document: any;
+    /**
+     * Name of a Y.js fragment, can be changed to sync multiple fields with one Y.js document.
+     */
+    field: string;
+    /**
+     * A raw Y.js fragment, can be used instead of `document` and `field`.
+     */
+    fragment: any;
+}
+export declare const Collaboration: Extension<CollaborationOptions, any>;

package/dist/packages/extension-collaboration/src/helpers/isChangeOrigin.d.ts

@@ -0,0 +1,2 @@
+import { Transaction } from 'prosemirror-state';
+export declare function isChangeOrigin(transaction: Transaction): boolean;

package/dist/packages/extension-collaboration/src/index.d.ts

@@ -0,0 +1,4 @@
+import { Collaboration } from './collaboration';
+export * from './collaboration';
+export * from './helpers/isChangeOrigin';
+export default Collaboration;

package/dist/packages/extension-collaboration-cursor/src/collaboration-cursor.d.ts

@@ -0,0 +1,37 @@
+import { Extension } from '@tiptap/core';
+declare type CollaborationCursorStorage = {
+    users: {
+        clientId: number;
+        [key: string]: any;
+    }[];
+};
+export interface CollaborationCursorOptions {
+    provider: any;
+    user: Record<string, any>;
+    render(user: Record<string, any>): HTMLElement;
+    /**
+     * @deprecated The "onUpdate" option is deprecated. Please use `editor.storage.collaborationCursor.users` instead. Read more: https://tiptap.dev/api/extensions/collaboration-cursor
+     */
+    onUpdate: (users: {
+        clientId: number;
+        [key: string]: any;
+    }[]) => null;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        collaborationCursor: {
+            /**
+             * Update details of the current user
+             */
+            updateUser: (attributes: Record<string, any>) => ReturnType;
+            /**
+             * Update details of the current user
+             *
+             * @deprecated The "user" command is deprecated. Please use "updateUser" instead. Read more: https://tiptap.dev/api/extensions/collaboration-cursor
+             */
+            user: (attributes: Record<string, any>) => ReturnType;
+        };
+    }
+}
+export declare const CollaborationCursor: Extension<CollaborationCursorOptions, CollaborationCursorStorage>;
+export {};

package/dist/packages/extension-collaboration-cursor/src/index.d.ts

@@ -0,0 +1,3 @@
+import { CollaborationCursor } from './collaboration-cursor';
+export * from './collaboration-cursor';
+export default CollaborationCursor;

package/dist/packages/extension-color/src/color.d.ts

@@ -0,0 +1,20 @@
+import { Extension } from '@tiptap/core';
+import '@tiptap/extension-text-style';
+export declare type ColorOptions = {
+    types: string[];
+};
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        color: {
+            /**
+             * Set the text color
+             */
+            setColor: (color: string) => ReturnType;
+            /**
+             * Unset the text color
+             */
+            unsetColor: () => ReturnType;
+        };
+    }
+}
+export declare const Color: Extension<ColorOptions, any>;

package/dist/packages/extension-color/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Color } from './color';
+export * from './color';
+export default Color;

package/dist/packages/extension-document/src/document.d.ts

@@ -0,0 +1,2 @@
+import { Node } from '@tiptap/core';
+export declare const Document: Node<any, any>;

package/dist/packages/extension-document/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Document } from './document';
+export * from './document';
+export default Document;

package/dist/packages/extension-dropcursor/src/dropcursor.d.ts

@@ -0,0 +1,7 @@
+import { Extension } from '@tiptap/core';
+export interface DropcursorOptions {
+    color: string | null;
+    width: number | null;
+    class: string | null;
+}
+export declare const Dropcursor: Extension<DropcursorOptions, any>;

package/dist/packages/extension-dropcursor/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Dropcursor } from './dropcursor';
+export * from './dropcursor';
+export default Dropcursor;

package/dist/packages/extension-floating-menu/src/floating-menu-plugin.d.ts

@@ -0,0 +1,40 @@
+import { Editor } from '@tiptap/core';
+import { EditorState, Plugin, PluginKey } from 'prosemirror-state';
+import { EditorView } from 'prosemirror-view';
+import { Instance, Props } from 'tippy.js';
+export interface FloatingMenuPluginProps {
+    pluginKey: PluginKey | string;
+    editor: Editor;
+    element: HTMLElement;
+    tippyOptions?: Partial<Props>;
+    shouldShow?: ((props: {
+        editor: Editor;
+        view: EditorView;
+        state: EditorState;
+        oldState?: EditorState;
+    }) => boolean) | null;
+}
+export declare type FloatingMenuViewProps = FloatingMenuPluginProps & {
+    view: EditorView;
+};
+export declare class FloatingMenuView {
+    editor: Editor;
+    element: HTMLElement;
+    view: EditorView;
+    preventHide: boolean;
+    tippy: Instance | undefined;
+    tippyOptions?: Partial<Props>;
+    shouldShow: Exclude<FloatingMenuPluginProps['shouldShow'], null>;
+    constructor({ editor, element, view, tippyOptions, shouldShow, }: FloatingMenuViewProps);
+    mousedownHandler: () => void;
+    focusHandler: () => void;
+    blurHandler: ({ event }: {
+        event: FocusEvent;
+    }) => void;
+    createTooltip(): void;
+    update(view: EditorView, oldState?: EditorState): void;
+    show(): void;
+    hide(): void;
+    destroy(): void;
+}
+export declare const FloatingMenuPlugin: (options: FloatingMenuPluginProps) => Plugin<any, any>;

package/dist/packages/extension-floating-menu/src/floating-menu.d.ts

@@ -0,0 +1,6 @@
+import { Extension } from '@tiptap/core';
+import { FloatingMenuPluginProps } from './floating-menu-plugin';
+export declare type FloatingMenuOptions = Omit<FloatingMenuPluginProps, 'editor' | 'element'> & {
+    element: HTMLElement | null;
+};
+export declare const FloatingMenu: Extension<FloatingMenuOptions, any>;

package/dist/packages/extension-floating-menu/src/index.d.ts

@@ -0,0 +1,4 @@
+import { FloatingMenu } from './floating-menu';
+export * from './floating-menu';
+export * from './floating-menu-plugin';
+export default FloatingMenu;

package/dist/packages/extension-focus/src/focus.d.ts

@@ -0,0 +1,6 @@
+import { Extension } from '@tiptap/core';
+export interface FocusOptions {
+    className: string;
+    mode: 'all' | 'deepest' | 'shallowest';
+}
+export declare const FocusClasses: Extension<FocusOptions, any>;

package/dist/packages/extension-focus/src/index.d.ts

@@ -0,0 +1,3 @@
+import { FocusClasses } from './focus';
+export * from './focus';
+export default FocusClasses;

package/dist/packages/extension-font-family/src/font-family.d.ts

@@ -0,0 +1,21 @@
+import { Extension } from '@tiptap/core';
+import '@tiptap/extension-text-style';
+declare type FontFamilyOptions = {
+    types: string[];
+};
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        fontFamily: {
+            /**
+             * Set the font family
+             */
+            setFontFamily: (fontFamily: string) => ReturnType;
+            /**
+             * Unset the font family
+             */
+            unsetFontFamily: () => ReturnType;
+        };
+    }
+}
+export declare const FontFamily: Extension<FontFamilyOptions, any>;
+export {};

package/dist/packages/extension-font-family/src/index.d.ts

@@ -0,0 +1,3 @@
+import { FontFamily } from './font-family';
+export * from './font-family';
+export default FontFamily;

package/dist/packages/extension-gapcursor/src/gapcursor.d.ts

@@ -0,0 +1,15 @@
+import { Extension, ParentConfig } from '@tiptap/core';
+declare module '@tiptap/core' {
+    interface NodeConfig<Options, Storage> {
+        /**
+         * Allow gap cursor
+         */
+        allowGapCursor?: boolean | null | ((this: {
+            name: string;
+            options: Options;
+            storage: Storage;
+            parent: ParentConfig<NodeConfig<Options>>['allowGapCursor'];
+        }) => boolean | null);
+    }
+}
+export declare const Gapcursor: Extension<any, any>;

package/dist/packages/extension-gapcursor/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Gapcursor } from './gapcursor';
+export * from './gapcursor';
+export default Gapcursor;

package/dist/packages/extension-hard-break/src/hard-break.d.ts

@@ -0,0 +1,16 @@
+import { Node } from '@tiptap/core';
+export interface HardBreakOptions {
+    keepMarks: boolean;
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        hardBreak: {
+            /**
+             * Add a hard break
+             */
+            setHardBreak: () => ReturnType;
+        };
+    }
+}
+export declare const HardBreak: Node<HardBreakOptions, any>;

package/dist/packages/extension-hard-break/src/index.d.ts

@@ -0,0 +1,3 @@
+import { HardBreak } from './hard-break';
+export * from './hard-break';
+export default HardBreak;

package/dist/packages/extension-heading/src/heading.d.ts

@@ -0,0 +1,26 @@
+import { Node } from '@tiptap/core';
+declare type Level = 1 | 2 | 3 | 4 | 5 | 6;
+export interface HeadingOptions {
+    levels: Level[];
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        heading: {
+            /**
+             * Set a heading node
+             */
+            setHeading: (attributes: {
+                level: Level;
+            }) => ReturnType;
+            /**
+             * Toggle a heading node
+             */
+            toggleHeading: (attributes: {
+                level: Level;
+            }) => ReturnType;
+        };
+    }
+}
+export declare const Heading: Node<HeadingOptions, unknown>;
+export {};

package/dist/packages/extension-heading/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Heading } from './heading';
+export * from './heading';
+export default Heading;

package/dist/packages/extension-highlight/src/highlight.d.ts

@@ -0,0 +1,30 @@
+import { Mark } from '@tiptap/core';
+export interface HighlightOptions {
+    multicolor: boolean;
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        highlight: {
+            /**
+             * Set a highlight mark
+             */
+            setHighlight: (attributes?: {
+                color: string;
+            }) => ReturnType;
+            /**
+             * Toggle a highlight mark
+             */
+            toggleHighlight: (attributes?: {
+                color: string;
+            }) => ReturnType;
+            /**
+             * Unset a highlight mark
+             */
+            unsetHighlight: () => ReturnType;
+        };
+    }
+}
+export declare const inputRegex: RegExp;
+export declare const pasteRegex: RegExp;
+export declare const Highlight: Mark<HighlightOptions, unknown>;

package/dist/packages/extension-highlight/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Highlight } from './highlight';
+export * from './highlight';
+export default Highlight;

package/dist/packages/extension-history/src/history.d.ts

@@ -0,0 +1,20 @@
+import { Extension } from '@tiptap/core';
+export interface HistoryOptions {
+    depth: number;
+    newGroupDelay: number;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        history: {
+            /**
+             * Undo recent changes
+             */
+            undo: () => ReturnType;
+            /**
+             * Reapply reverted changes
+             */
+            redo: () => ReturnType;
+        };
+    }
+}
+export declare const History: Extension<HistoryOptions, any>;

package/dist/packages/extension-history/src/index.d.ts

@@ -0,0 +1,3 @@
+import { History } from './history';
+export * from './history';
+export default History;

package/dist/packages/extension-horizontal-rule/src/horizontal-rule.d.ts

@@ -0,0 +1,15 @@
+import { Node } from '@tiptap/core';
+export interface HorizontalRuleOptions {
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        horizontalRule: {
+            /**
+             * Add a horizontal rule
+             */
+            setHorizontalRule: () => ReturnType;
+        };
+    }
+}
+export declare const HorizontalRule: Node<HorizontalRuleOptions, unknown>;

package/dist/packages/extension-horizontal-rule/src/index.d.ts

@@ -0,0 +1,3 @@
+import { HorizontalRule } from './horizontal-rule';
+export * from './horizontal-rule';
+export default HorizontalRule;

package/dist/packages/extension-image/src/image.d.ts

@@ -0,0 +1,21 @@
+import { Node } from '@tiptap/core';
+export interface ImageOptions {
+    inline: boolean;
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        image: {
+            /**
+             * Add an image
+             */
+            setImage: (options: {
+                src: string;
+                alt?: string;
+                title?: string;
+            }) => ReturnType;
+        };
+    }
+}
+export declare const inputRegex: RegExp;
+export declare const Image: Node<ImageOptions, unknown>;

package/dist/packages/extension-image/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Image } from './image';
+export * from './image';
+export default Image;

package/dist/packages/extension-italic/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Italic } from './italic';
+export * from './italic';
+export default Italic;

package/dist/packages/extension-italic/src/italic.d.ts

@@ -0,0 +1,27 @@
+import { Mark } from '@tiptap/core';
+export interface ItalicOptions {
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        italic: {
+            /**
+             * Set an italic mark
+             */
+            setItalic: () => ReturnType;
+            /**
+             * Toggle an italic mark
+             */
+            toggleItalic: () => ReturnType;
+            /**
+             * Unset an italic mark
+             */
+            unsetItalic: () => ReturnType;
+        };
+    }
+}
+export declare const starInputRegex: RegExp;
+export declare const starPasteRegex: RegExp;
+export declare const underscoreInputRegex: RegExp;
+export declare const underscorePasteRegex: RegExp;
+export declare const Italic: Mark<ItalicOptions, unknown>;

package/dist/packages/extension-link/src/helpers/autolink.d.ts

@@ -0,0 +1,7 @@
+import { Plugin } from 'prosemirror-state';
+import { MarkType } from 'prosemirror-model';
+declare type AutolinkOptions = {
+    type: MarkType;
+};
+export declare function autolink(options: AutolinkOptions): Plugin;
+export {};

package/dist/packages/extension-link/src/helpers/clickHandler.d.ts

@@ -0,0 +1,7 @@
+import { Plugin } from 'prosemirror-state';
+import { MarkType } from 'prosemirror-model';
+declare type ClickHandlerOptions = {
+    type: MarkType;
+};
+export declare function clickHandler(options: ClickHandlerOptions): Plugin;
+export {};

package/dist/packages/extension-link/src/helpers/pasteHandler.d.ts

@@ -0,0 +1,9 @@
+import { Editor } from '@tiptap/core';
+import { Plugin } from 'prosemirror-state';
+import { MarkType } from 'prosemirror-model';
+declare type PasteHandlerOptions = {
+    editor: Editor;
+    type: MarkType;
+};
+export declare function pasteHandler(options: PasteHandlerOptions): Plugin;
+export {};

package/dist/packages/extension-link/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Link } from './link';
+export * from './link';
+export default Link;

package/dist/packages/extension-link/src/link.d.ts

@@ -0,0 +1,44 @@
+import { Mark } from '@tiptap/core';
+export interface LinkOptions {
+    /**
+     * If enabled, it adds links as you type.
+     */
+    autolink: boolean;
+    /**
+     * If enabled, links will be opened on click.
+     */
+    openOnClick: boolean;
+    /**
+     * Adds a link to the current selection if the pasted content only contains an url.
+     */
+    linkOnPaste: boolean;
+    /**
+     * A list of HTML attributes to be rendered.
+     */
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        link: {
+            /**
+             * Set a link mark
+             */
+            setLink: (attributes: {
+                href: string;
+                target?: string;
+            }) => ReturnType;
+            /**
+             * Toggle a link mark
+             */
+            toggleLink: (attributes: {
+                href: string;
+                target?: string;
+            }) => ReturnType;
+            /**
+             * Unset a link mark
+             */
+            unsetLink: () => ReturnType;
+        };
+    }
+}
+export declare const Link: Mark<LinkOptions, unknown>;

package/dist/packages/extension-list-item/src/index.d.ts

@@ -0,0 +1,3 @@
+import { ListItem } from './list-item';
+export * from './list-item';
+export default ListItem;

package/dist/packages/extension-list-item/src/list-item.d.ts

@@ -0,0 +1,5 @@
+import { Node } from '@tiptap/core';
+export interface ListItemOptions {
+    HTMLAttributes: Record<string, any>;
+}
+export declare const ListItem: Node<ListItemOptions, any>;

package/dist/packages/extension-mention/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Mention } from './mention';
+export * from './mention';
+export default Mention;

package/dist/packages/extension-mention/src/mention.d.ts

@@ -0,0 +1,14 @@
+import { Node } from '@tiptap/core';
+import { Node as ProseMirrorNode } from 'prosemirror-model';
+import { PluginKey } from 'prosemirror-state';
+import { SuggestionOptions } from '@tiptap/suggestion';
+export declare type MentionOptions = {
+    HTMLAttributes: Record<string, any>;
+    renderLabel: (props: {
+        options: MentionOptions;
+        node: ProseMirrorNode;
+    }) => string;
+    suggestion: Omit<SuggestionOptions, 'editor'>;
+};
+export declare const MentionPluginKey: PluginKey<any, any>;
+export declare const Mention: Node<MentionOptions, any>;

package/dist/packages/extension-ordered-list/src/index.d.ts

@@ -0,0 +1,3 @@
+import { OrderedList } from './ordered-list';
+export * from './ordered-list';
+export default OrderedList;

package/dist/packages/extension-ordered-list/src/ordered-list.d.ts

@@ -0,0 +1,17 @@
+import { Node } from '@tiptap/core';
+export interface OrderedListOptions {
+    itemTypeName: string;
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        orderedList: {
+            /**
+             * Toggle an ordered list
+             */
+            toggleOrderedList: () => ReturnType;
+        };
+    }
+}
+export declare const inputRegex: RegExp;
+export declare const OrderedList: Node<OrderedListOptions, unknown>;

package/dist/packages/extension-paragraph/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Paragraph } from './paragraph';
+export * from './paragraph';
+export default Paragraph;

package/dist/packages/extension-paragraph/src/paragraph.d.ts

@@ -0,0 +1,15 @@
+import { Node } from '@tiptap/core';
+export interface ParagraphOptions {
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        paragraph: {
+            /**
+             * Toggle a paragraph
+             */
+            setParagraph: () => ReturnType;
+        };
+    }
+}
+export declare const Paragraph: Node<ParagraphOptions, any>;

package/dist/packages/extension-placeholder/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Placeholder } from './placeholder';
+export * from './placeholder';
+export default Placeholder;

package/dist/packages/extension-placeholder/src/placeholder.d.ts

@@ -0,0 +1,15 @@
+import { Editor, Extension } from '@tiptap/core';
+import { Node as ProsemirrorNode } from 'prosemirror-model';
+export interface PlaceholderOptions {
+    emptyEditorClass: string;
+    emptyNodeClass: string;
+    placeholder: ((PlaceholderProps: {
+        editor: Editor;
+        node: ProsemirrorNode;
+        pos: number;
+    }) => string) | string;
+    showOnlyWhenEditable: boolean;
+    showOnlyCurrent: boolean;
+    includeChildren: boolean;
+}
+export declare const Placeholder: Extension<PlaceholderOptions, any>;

package/dist/packages/extension-strike/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Strike } from './strike';
+export * from './strike';
+export default Strike;