reactjs-tiptap-editor 0.4.1 → 1.0.0

package/lib/BaseKit.d.cts

@@ -1,481 +0,0 @@
-import { CharacterCountOptions } from '@tiptap/extensions';
-import { DropcursorOptions } from '@tiptap/extensions';
-import { Editor } from '@tiptap/react';
-import { Extension } from '@tiptap/core';
-import { FocusOptions as FocusOptions_2 } from '@tiptap/extensions';
-import { HardBreakOptions } from '@tiptap/extension-hard-break';
-import { HorizontalRuleOptions } from '@tiptap/extension-horizontal-rule';
-import { ListItemOptions } from '@tiptap/extension-list';
-import { ListKeymapOptions } from '@tiptap/extension-list';
-import { OrderedListOptions } from '@tiptap/extension-list';
-import { ParagraphOptions } from '@tiptap/extension-paragraph';
-import { PlaceholderOptions } from '@tiptap/extensions';
-import { StrikeOptions } from '@tiptap/extension-strike';
-import { TextStyleOptions } from '@tiptap/extension-text-style';
-import { TrailingNodeOptions } from '@tiptap/extensions';
-
-export declare const BaseKit: Extension<BaseKitOptions, any>;
-
-/**
- * Represents the interface for options in the base toolkit.
- */
-export declare interface BaseKitOptions {
-    /**
-     * Whether to enable the document option
-     *
-     * @default false
-     */
-    multiColumn?: boolean;
-    /**
-     * character count options or false, indicating whether to enable character count
-     *
-     * @default true
-     */
-    characterCount: Partial<CharacterCountOptions> | false;
-    /**
-     * selection options or false, indicating whether to enable the selection
-     *
-     * @default true
-     */
-    selection: any | false;
-    /**
-     * Focus options or false, indicating whether to enable focus functionality
-     *
-     * @default true
-     */
-    focus: Partial<FocusOptions_2> | false;
-    /**
-     * Placeholder options or false, indicating whether to enable placeholders
-     *
-     * @default true
-     */
-    placeholder: Partial<PlaceholderOptions> | false;
-    /**
-     * textBubble options or false, indicating whether to enable the textBubble
-     *
-     * @default true
-     */
-    textBubble: Partial<TextBubbleOptions> | false;
-    /**
-     * Text Style options or false, indicating whether to enable text style functionality
-     *
-     * @default true
-     */
-    textStyle: Partial<TextStyleOptions> | false;
-    /**
-     * If set to false, the document extension will not be registered
-     * @example document: false
-     */
-    document: false;
-    /**
-     * If set to false, the dropcursor extension will not be registered
-     * @example dropcursor: false
-     */
-    dropcursor: Partial<DropcursorOptions> | false;
-    /**
-     * If set to false, the gapcursor extension will not be registered
-     * @example gapcursor: false
-     */
-    gapcursor: false;
-    /**
-     * If set to false, the hardBreak extension will not be registered
-     * @example hardBreak: false
-     */
-    hardBreak: Partial<HardBreakOptions> | false;
-    /**
-     * If set to false, the horizontalRule extension will not be registered
-     * @example horizontalRule: false
-     */
-    horizontalRule: Partial<HorizontalRuleOptions> | false;
-    /**
-     * If set to false, the listItem extension will not be registered
-     * @example listItem: false
-     */
-    listItem: Partial<ListItemOptions> | false;
-    /**
-     * If set to false, the listItemKeymap extension will not be registered
-     * @example listKeymap: false
-     */
-    listKeymap: Partial<ListKeymapOptions> | false;
-    /**
-     * If set to false, the orderedList extension will not be registered
-     * @example orderedList: false
-     */
-    orderedList: Partial<OrderedListOptions> | false;
-    /**
-     * If set to false, the paragraph extension will not be registered
-     * @example paragraph: false
-     */
-    paragraph: Partial<ParagraphOptions> | false;
-    /**
-     * If set to false, the strike extension will not be registered
-     * @example strike: false
-     */
-    strike: Partial<StrikeOptions> | false;
-    /**
-     * If set to false, the text extension will not be registered
-     * @example text: false
-     */
-    text: false;
-    /**
-     * If set to false, the trailingNode extension will not be registered
-     * @example trailingNode: false
-     */
-    trailingNode: Partial<TrailingNodeOptions> | false;
-}
-
-/**
- * Represents the ButtonView function.
- */
-declare type ButtonView<T = any> = (options: ButtonViewParams<T>) => ButtonViewReturn | ButtonViewReturn[];
-
-/**
- * Represents the parameters for the ButtonView function.
- */
-declare interface ButtonViewParams<T = any> {
-    /** Editor object */
-    editor: Editor;
-    /** Extension object */
-    extension: Extension<T>;
-    /** Translation function */
-    t: (path: string) => string;
-}
-
-/**
- * Represents the return value for the ButtonView component.
- */
-declare interface ButtonViewReturn {
-    /** Component */
-    component: unknown;
-    /** Component props */
-    componentProps: ButtonViewReturnComponentProps;
-    /** Component slots */
-    componentSlots?: ButtonViewReturnComponentSlots;
-}
-
-/**
- * Represents the props for the ButtonView component.
- */
-declare interface ButtonViewReturnComponentProps {
-    /** Method triggered when action is performed */
-    action?: (value?: any) => void;
-    /** Whether it is in the active state */
-    isActive?: () => boolean;
-    /** Button icon */
-    icon?: any;
-    /** Text displayed on hover */
-    tooltip?: string;
-    [x: string]: any;
-}
-
-/**
- * Represents the slots for the ButtonView component.
- */
-declare interface ButtonViewReturnComponentSlots {
-    /** Dialog slot */
-    dialog: () => any;
-    [x: string]: () => any;
-}
-
-/**
- * Represents the general options for Tiptap extensions.
- */
-declare interface GeneralOptions<T> {
-    /** Enabled divider */
-    divider: boolean;
-    /** Enabled spacer */
-    spacer: boolean;
-    /** Button view function */
-    button: ButtonView<T>;
-    /** Show on Toolbar */
-    toolbar?: boolean;
-    /** Shortcut keys override */
-    shortcutKeys?: string[] | string[][];
-}
-
-declare interface TextBubbleOptions extends GeneralOptions<TextBubbleOptions> {
-}
-
-export { }
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        attachment: {
-            setAttachment: (attrs?: unknown) => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        setCodeBlock: {
-            setCodeBlock: (options?: any) => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        codeView: {
-            /**
-                   * Toggle code view mode
-                   */
-            toggleCodeView: () => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        drawer: {
-            setDrawer: (options: any, replace?: any) => ReturnType;
-            setAlignImageDrawer: (align: 'left' | 'center' | 'right') => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        excalidraw: {
-            setExcalidraw: (attrs?: IExcalidrawAttrs) => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        exportPdf: {
-            exportToPdf: () => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        exportWord: {
-            exportToWord: () => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        fontSize: {
-            /**
-             * Set the text font size. ex: "12px", "2em", or "small". Must be a valid
-             * CSS font-size
-             * (https://developer.mozilla.org/en-US/docs/Web/CSS/font-size).
-             */
-            setFontSize: (fontSize: string) => ReturnType;
-            /**
-             * Unset the font size
-             */
-            unsetFontSize: () => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        painter: {
-            setPainter: (marks: Mark[]) => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        iframe: {
-            /**
-             * Add an iframe
-             */
-            setIframe: (options: {
-                src: string;
-                service: string;
-            }) => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        imageUpload: {
-            /**
-             * Add an image
-             */
-            setImageInline: (options: Partial<SetImageAttrsOptions>) => ReturnType;
-            /**
-             * Update an image
-             */
-            updateImage: (options: Partial<SetImageAttrsOptions>) => ReturnType;
-            /**
-             * Set image alignment
-             */
-            setAlignImage: (align: 'left' | 'center' | 'right') => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        indent: {
-            /**
-             * Set the indent attribute
-             */
-            indent: () => ReturnType;
-            /**
-             * Set the outdent attribute
-             */
-            outdent: () => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        imageGifUpload: {
-            /**
-             * Add an image gif
-             */
-            setImageGif: (options: Partial<SetImageAttrsOptions>) => ReturnType;
-            /**
-             * Update an image gif
-             */
-            updateImageGif: (options: Partial<SetImageAttrsOptions>) => ReturnType;
-            /**
-             * Set image alignment
-             */
-            setAlignImageGif: (align: 'left' | 'center' | 'right') => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        katex: {
-            setKatex: (arg?: IKatexAttrs) => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        lineHeight: {
-            setLineHeight: (lineHeight: string) => ReturnType;
-            unsetLineHeight: () => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        mermaid: {
-            setMermaid: (options: any, replace?: any) => ReturnType;
-            setAlignImageMermaid: (align: 'left' | 'center' | 'right') => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        columns: {
-            insertColumns: (attrs?: {
-                cols: number;
-            }) => ReturnType;
-            addColBefore: () => ReturnType;
-            addColAfter: () => ReturnType;
-            deleteCol: () => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        search: {
-            setSearchTerm: (searchTerm: string) => ReturnType;
-            setReplaceTerm: (replaceTerm: string) => ReturnType;
-            setCaseSensitive: (caseSensitive: boolean) => ReturnType;
-            resetIndex: () => ReturnType;
-            nextSearchResult: () => ReturnType;
-            previousSearchResult: () => ReturnType;
-            replace: () => ReturnType;
-            replaceAll: () => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Storage {
-        searchAndReplace: SearchAndReplaceStorage;
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        tableOfContents: {
-            setTableOfContents: () => ReturnType;
-            removeTableOfContents: () => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        twitter: {
-            /**
-             * Insert a tweet
-             * @param options The tweet attributes
-             * @example editor.commands.setTweet({ src: 'https://x.com/seanpk/status/1800145949580517852' })
-             */
-            setTweet: (options: SetTweetOptions) => ReturnType;
-            updateTweet: (options: SetTweetOptions) => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        video: {
-            /**
-             * Add an video
-             */
-            setVideo: (options: Partial<SetVideoOptions>) => ReturnType;
-            /**
-             * Update an video
-             */
-            updateVideo: (options: Partial<SetVideoOptions>) => ReturnType;
-        };
-    }
-}
-
-
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        tableCellBackground: {
-            setTableCellBackground: (color: string) => ReturnType;
-            unsetTableCellBackground: () => ReturnType;
-        };
-    }
-}