reactjs-tiptap-editor 0.2.29 → 0.3.0

package/lib/index.d.cts

@@ -1,10 +1,19 @@
 import { AnyExtension } from '@tiptap/core';
 import { BubbleMenu } from '@tiptap/react';
+import { CharacterCountOptions } from '@tiptap/extension-character-count';
 import { default as default_2 } from 'react';
+import { DropcursorOptions } from '@tiptap/extension-dropcursor';
 import { Editor } from '@tiptap/react';
 import { Editor as Editor_2 } from '@tiptap/core';
+import { Extension } from '@tiptap/core';
+import { FocusOptions as FocusOptions_2 } from '@tiptap/extension-focus';
 import { ForwardRefExoticComponent } from 'react';
+import { HardBreakOptions } from '@tiptap/extension-hard-break';
+import { ListItemOptions } from '@tiptap/extension-list-item';
+import { ParagraphOptions } from '@tiptap/extension-paragraph';
+import { PlaceholderOptions } from '@tiptap/extension-placeholder';
 import { RefAttributes } from 'react';
+import { TextStyleOptions } from '@tiptap/extension-text-style';
 import { TooltipContentProps } from '@radix-ui/react-tooltip';
 import { UseEditorOptions } from '@tiptap/react';
 
@@ -25,6 +34,113 @@ declare interface ActionButtonProps {
     upload?: boolean;
 }
 
+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 true
+     */
+    document: false;
+    /**
+     * Whether to enable the document option
+     *
+     * @default false
+     */
+    multiColumn?: boolean;
+    /**
+     * Whether to enable the text option
+     *
+     * @default true
+     */
+    text: false;
+    /**
+     * Whether to enable the Gapcursor
+     *
+     * @default true
+     */
+    gapcursor: false;
+    /**
+     * Dropcursor options or false, indicating whether to enable the drop cursor
+     *
+     * @default true
+     */
+    dropcursor: Partial<DropcursorOptions> | false;
+    /**
+     * character count options or false, indicating whether to enable character count
+     *
+     * @default true
+     */
+    characterCount: Partial<CharacterCountOptions> | false;
+    /**
+     * HardBreak options or false, indicating whether to enable hard breaks
+     *
+     * @default true
+     */
+    hardBreak: Partial<HardBreakOptions> | false;
+    /**
+     * Placeholder options or false, indicating whether to enable placeholders
+     *
+     * @default true
+     */
+    placeholder: Partial<PlaceholderOptions> | false;
+    /**
+     * Paragraph options or false, indicating whether to enable paragraph functionality
+     *
+     * @default true
+     */
+    paragraph: Partial<ParagraphOptions> | false;
+    /**
+     * Focus options or false, indicating whether to enable focus functionality
+     *
+     * @default true
+     */
+    focus: Partial<FocusOptions_2> | false;
+    /**
+     * ListItem options or false, indicating whether to enable list item functionality
+     *
+     * @default true
+     */
+    listItem: Partial<ListItemOptions> | false;
+    /**
+     * Text Style options or false, indicating whether to enable text style functionality
+     *
+     * @default true
+     */
+    textStyle: Partial<TextStyleOptions> | false;
+    /**
+     * Bubble options, taking `BubbleOptions<BaseKitOptions>` as parameters, indicating whether to enable the bubble functionality
+     */
+    bubble: any;
+    /**
+     * Iframe options or false, indicating whether to enable the iframe
+     *
+     * @default true
+     */
+    /**
+     * Trailing node options or false, indicating whether to enable the trailing node
+     *
+     * @default true
+     */
+    trailingNode: Partial<TrailingNodeOptions> | false;
+    /**
+     * textBubble options or false, indicating whether to enable the textBubble
+     *
+     * @default true
+     */
+    textBubble: Partial<TextBubbleOptions> | false;
+    /**
+     * selection options or false, indicating whether to enable the selection
+     *
+     * @default true
+     */
+    selection: any | false;
+}
+
 export { BubbleMenu }
 
 declare interface BubbleMenuConfig {
@@ -145,6 +261,36 @@ declare interface BubbleMenuRenderProps {
     editor: Editor;
     disabled: boolean;
     bubbleMenu: BubbleMenuProps;
+    extensionsNames: string[];
+}
+
+/**
+ * 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;
 }
 
 /**
@@ -162,6 +308,15 @@ declare interface ButtonViewReturnComponentProps {
     [x: string]: any;
 }
 
+/**
+ * Represents the slots for the ButtonView component.
+ */
+declare interface ButtonViewReturnComponentSlots {
+    /** Dialog slot */
+    dialog: () => any;
+    [x: string]: () => any;
+}
+
 declare const _default: ForwardRefExoticComponent<RichTextEditorProps & RefAttributes<    {
 editor: Editor_2 | null;
 }>>;
@@ -169,6 +324,20 @@ export default _default;
 
 export { Editor }
 
+/**
+ * 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;
+}
+
 /**
  * Interface for RichTextEditor component props
  */
@@ -217,6 +386,9 @@ declare interface RichTextEditorProps {
     resetCSS?: boolean;
 }
 
+declare interface TextBubbleOptions extends GeneralOptions<TextBubbleOptions> {
+}
+
 /**
  * Represents the ToolbarItemProps.
  */
@@ -240,6 +412,16 @@ declare interface ToolbarRenderProps {
     disabled: boolean;
 }
 
+/**
+ * Extension based on:
+ * - https://github.com/ueberdosis/tiptap/blob/v1/packages/tiptap-extensions/src/extensions/TrailingNode.js
+ * - https://github.com/remirror/remirror/blob/e0f1bec4a1e8073ce8f5500d62193e52321155b9/packages/prosemirror-trailing-node/src/trailing-node-plugin.ts
+ */
+declare interface TrailingNodeOptions {
+    node: string;
+    notAfter: string[];
+}
+
 export { UseEditorOptions }
 
 export declare function useEditorState(): UseEditorStateReturn;
@@ -257,15 +439,8 @@ export { }
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        video: {
-            /**
-             * Add an video
-             */
-            setVideo: (options: Partial<SetVideoOptions>) => ReturnType;
-            /**
-             * Update an video
-             */
-            updateVideo: (options: Partial<SetVideoOptions>) => ReturnType;
+        attachment: {
+            setAttachment: (attrs?: unknown) => ReturnType;
         };
     }
 }
@@ -282,17 +457,8 @@ declare module '@tiptap/core' {
 
 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;
+        excalidraw: {
+            setExcalidraw: (attrs?: IExcalidrawAttrs) => ReturnType;
         };
     }
 }
@@ -300,9 +466,11 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        lineHeight: {
-            setLineHeight: (lineHeight: string) => ReturnType;
-            unsetLineHeight: () => ReturnType;
+        emoji: {
+            setEmoji: (emoji: {
+                name: string;
+                emoji: string;
+            }) => ReturnType;
         };
     }
 }
@@ -310,15 +478,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        indent: {
-            /**
-             * Set the indent attribute
-             */
-            indent: () => ReturnType;
-            /**
-             * Set the outdent attribute
-             */
-            outdent: () => ReturnType;
+        drawer: {
+            setDrawer: (options: any, replace?: any) => ReturnType;
+            setAlignImageDrawer: (align: 'left' | 'center' | 'right') => ReturnType;
         };
     }
 }
@@ -326,19 +488,8 @@ declare module '@tiptap/core' {
 
 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;
+        exportWord: {
+            exportToWord: () => ReturnType;
         };
     }
 }
@@ -346,13 +497,17 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        columns: {
-            insertColumns: (attrs?: {
-                cols: number;
-            }) => ReturnType;
-            addColBefore: () => ReturnType;
-            addColAfter: () => ReturnType;
-            deleteCol: () => 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;
         };
     }
 }
@@ -360,9 +515,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        tableCellBackground: {
-            setTableCellBackground: (color: string) => ReturnType;
-            unsetTableCellBackground: () => ReturnType;
+        painter: {
+            setPainter: (marks: Mark[]) => ReturnType;
         };
     }
 }
@@ -385,14 +539,19 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        search: {
-            setSearchTerm: (searchTerm: string) => ReturnType;
-            setReplaceTerm: (replaceTerm: string) => ReturnType;
-            replace: () => ReturnType;
-            replaceAll: () => ReturnType;
-            goToPrevSearchResult: () => void;
-            goToNextSearchResult: () => void;
-            setCaseSensitive: (caseSensitive: boolean) => 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;
         };
     }
 }
@@ -400,8 +559,19 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        painter: {
-            setPainter: (marks: Mark[]) => 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;
         };
     }
 }
@@ -409,8 +579,15 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        katex: {
-            setKatex: (arg?: IKatexAttrs) => ReturnType;
+        indent: {
+            /**
+             * Set the indent attribute
+             */
+            indent: () => ReturnType;
+            /**
+             * Set the outdent attribute
+             */
+            outdent: () => ReturnType;
         };
     }
 }
@@ -418,8 +595,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        exportWord: {
-            exportToWord: () => ReturnType;
+        katex: {
+            setKatex: (arg?: IKatexAttrs) => ReturnType;
         };
     }
 }
@@ -427,9 +604,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        tableOfContents: {
-            setTableOfContents: () => ReturnType;
-            removeTableOfContents: () => ReturnType;
+        lineHeight: {
+            setLineHeight: (lineHeight: string) => ReturnType;
+            unsetLineHeight: () => ReturnType;
         };
     }
 }
@@ -437,11 +614,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        emoji: {
-            setEmoji: (emoji: {
-                name: string;
-                emoji: string;
-            }) => ReturnType;
+        mermaid: {
+            setMermaid: (options: any, replace?: any) => ReturnType;
+            setAlignImageMermaid: (align: 'left' | 'center' | 'right') => ReturnType;
         };
     }
 }
@@ -449,8 +624,13 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        excalidraw: {
-            setExcalidraw: (attrs?: IExcalidrawAttrs) => ReturnType;
+        columns: {
+            insertColumns: (attrs?: {
+                cols: number;
+            }) => ReturnType;
+            addColBefore: () => ReturnType;
+            addColAfter: () => ReturnType;
+            deleteCol: () => ReturnType;
         };
     }
 }
@@ -458,19 +638,14 @@ declare module '@tiptap/core' {
 
 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;
+        search: {
+            setSearchTerm: (searchTerm: string) => ReturnType;
+            setReplaceTerm: (replaceTerm: string) => ReturnType;
+            replace: () => ReturnType;
+            replaceAll: () => ReturnType;
+            goToPrevSearchResult: () => void;
+            goToNextSearchResult: () => void;
+            setCaseSensitive: (caseSensitive: boolean) => ReturnType;
         };
     }
 }
@@ -478,8 +653,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        attachment: {
-            setAttachment: (attrs?: unknown) => ReturnType;
+        tableOfContents: {
+            setTableOfContents: () => ReturnType;
+            removeTableOfContents: () => ReturnType;
         };
     }
 }
@@ -487,9 +663,14 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        mermaid: {
-            setMermaid: (options: any, replace?: any) => ReturnType;
-            setAlignImageMermaid: (align: 'left' | 'center' | 'right') => 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;
         };
     }
 }
@@ -497,9 +678,15 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        drawer: {
-            setDrawer: (options: any, replace?: any) => ReturnType;
-            setAlignImageDrawer: (align: 'left' | 'center' | 'right') => ReturnType;
+        video: {
+            /**
+             * Add an video
+             */
+            setVideo: (options: Partial<SetVideoOptions>) => ReturnType;
+            /**
+             * Update an video
+             */
+            updateVideo: (options: Partial<SetVideoOptions>) => ReturnType;
         };
     }
 }
@@ -507,14 +694,9 @@ declare module '@tiptap/core' {
 
 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;
+        tableCellBackground: {
+            setTableCellBackground: (color: string) => ReturnType;
+            unsetTableCellBackground: () => ReturnType;
         };
     }
 }