reactjs-tiptap-editor 0.0.43 → 0.0.45

package/lib/index.d.cts

@@ -218,6 +218,13 @@ declare interface BubbleMenuProps {
          */
         hidden?: boolean;
     };
+    imageGifConfig?: {
+        /**
+         * @description Image menu hidden
+         * @default false
+         */
+        hidden?: boolean;
+    };
     videoConfig?: {
         /**
          * @description Video menu hidden
@@ -516,6 +523,7 @@ export declare const en: {
     'editor.attachment.tooltip': string;
     'editor.attachment.uploading': string;
     'editor.attachment.please_upload': string;
+    'editor.imageGif.tooltip': string;
 };
 
 export declare const Excalidraw: Node_2<any, any>;
@@ -607,10 +615,20 @@ declare interface IKatexOptions {
 declare const Image_2: Node_2<ImageOptions, any>;
 export { Image_2 as Image }
 
+export declare const ImageGif: Node_2<ImageGifOptions, any>;
+
+declare interface ImageGifOptions extends ImageOptions {
+    /**
+     * The key for the gif https://giphy.com/
+     */
+    GIPHY_API_KEY: string;
+}
+
 export declare const ImageUpload: Node_3<ImageUploadOptions, any>;
 
 export declare interface ImageUploadOptions {
     upload: (file: File) => Promise<string>;
+    postUpload?: (url: string) => Promise<string>;
     acceptMimes: string[];
     maxSize: number;
 }
@@ -869,6 +887,7 @@ export declare const pt_BR: {
     'editor.attachment.tooltip': string;
     'editor.attachment.uploading': string;
     'editor.attachment.please_upload': string;
+    'editor.imageGif.tooltip': string;
 };
 
 declare interface Result {
@@ -1207,6 +1226,7 @@ export declare const vi: {
     'editor.attachment.tooltip': string;
     'editor.attachment.uploading': string;
     'editor.attachment.please_upload': string;
+    'editor.imageGif.tooltip': string;
 };
 
 export declare const Video: Node_2<VideoOptions, any>;
@@ -1403,6 +1423,7 @@ export declare const zh_CN: {
     'editor.attachment.tooltip': string;
     'editor.attachment.uploading': string;
     'editor.attachment.please_upload': string;
+    'editor.imageGif.tooltip': string;
 };
 
 export { }
@@ -1444,9 +1465,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        tableCellBackground: {
-            setTableCellBackground: (color: string) => ReturnType;
-            unsetTableCellBackground: () => ReturnType;
+        lineHeight: {
+            setLineHeight: (lineHeight: string) => ReturnType;
+            unsetLineHeight: () => ReturnType;
         };
     }
 }
@@ -1454,13 +1475,15 @@ 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;
+        indent: {
+            /**
+             * Set the indent attribute
+             */
+            indent: () => ReturnType;
+            /**
+             * Set the outdent attribute
+             */
+            outdent: () => ReturnType;
         };
     }
 }
@@ -1468,8 +1491,19 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        videoUpload: {
-            setVideoUpload: () => ReturnType;
+        imageResize: {
+            /**
+             * Add an image
+             */
+            setImage: (options: Partial<SetImageAttrsOptions>) => ReturnType;
+            /**
+             * Update an image
+             */
+            updateImage: (options: Partial<SetImageAttrsOptions>) => ReturnType;
+            /**
+             * Set image alignment
+             */
+            setAlignImage: (align: 'left' | 'center' | 'right') => ReturnType;
         };
     }
 }
@@ -1477,14 +1511,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        iframe: {
-            /**
-             * Add an iframe
-             */
-            setIframe: (options: {
-                src: string;
-                service: string;
-            }) => ReturnType;
+        tableCellBackground: {
+            setTableCellBackground: (color: string) => ReturnType;
+            unsetTableCellBackground: () => ReturnType;
         };
     }
 }
@@ -1492,9 +1521,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        lineHeight: {
-            setLineHeight: (lineHeight: string) => ReturnType;
-            unsetLineHeight: () => ReturnType;
+        imageUpload: {
+            setImageUpload: () => ReturnType;
         };
     }
 }
@@ -1502,8 +1530,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        imageUpload: {
-            setImageUpload: () => ReturnType;
+        videoUpload: {
+            setVideoUpload: () => ReturnType;
         };
     }
 }
@@ -1511,15 +1539,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        indent: {
-            /**
-             * Set the indent attribute
-             */
-            indent: () => ReturnType;
-            /**
-             * Set the outdent attribute
-             */
-            outdent: () => ReturnType;
+        painter: {
+            setPainter: (marks: Mark[]) => ReturnType;
         };
     }
 }
@@ -1527,8 +1548,13 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        katex: {
-            setKatex: (arg?: IKatexAttrs) => ReturnType;
+        columns: {
+            insertColumns: (attrs?: {
+                cols: number;
+            }) => ReturnType;
+            addColBefore: () => ReturnType;
+            addColAfter: () => ReturnType;
+            deleteCol: () => ReturnType;
         };
     }
 }
@@ -1536,8 +1562,14 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        painter: {
-            setPainter: (marks: Mark[]) => ReturnType;
+        iframe: {
+            /**
+             * Add an iframe
+             */
+            setIframe: (options: {
+                src: string;
+                service: string;
+            }) => ReturnType;
         };
     }
 }
@@ -1545,13 +1577,13 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        columns: {
-            insertColumns: (attrs?: {
-                cols: number;
-            }) => ReturnType;
-            addColBefore: () => ReturnType;
-            addColAfter: () => ReturnType;
-            deleteCol: () => ReturnType;
+        search: {
+            setSearchTerm: (searchTerm: string) => ReturnType;
+            setReplaceTerm: (replaceTerm: string) => ReturnType;
+            replace: () => ReturnType;
+            replaceAll: () => ReturnType;
+            goToPrevSearchResult: () => void;
+            goToNextSearchResult: () => void;
         };
     }
 }
@@ -1569,6 +1601,15 @@ declare module '@tiptap/core' {
 }
 
 
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        katex: {
+            setKatex: (arg?: IKatexAttrs) => ReturnType;
+        };
+    }
+}
+
+
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         exportWord: {
@@ -1580,19 +1621,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        imageResize: {
-            /**
-             * Add an image
-             */
-            setImage: (options: Partial<SetImageAttrsOptions>) => ReturnType;
-            /**
-             * Update an image
-             */
-            updateImage: (options: Partial<SetImageAttrsOptions>) => ReturnType;
-            /**
-             * Set image alignment
-             */
-            setAlignImage: (align: 'left' | 'center' | 'right') => ReturnType;
+        excalidraw: {
+            setExcalidraw: (attrs?: IExcalidrawAttrs) => ReturnType;
         };
     }
 }
@@ -1600,9 +1630,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        tableOfContents: {
-            setTableOfContents: () => ReturnType;
-            removeTableOfContents: () => ReturnType;
+        attachment: {
+            setAttachment: (attrs?: unknown) => ReturnType;
         };
     }
 }
@@ -1610,8 +1639,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        excalidraw: {
-            setExcalidraw: (attrs?: IExcalidrawAttrs) => ReturnType;
+        tableOfContents: {
+            setTableOfContents: () => ReturnType;
+            removeTableOfContents: () => ReturnType;
         };
     }
 }
@@ -1619,8 +1649,19 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        attachment: {
-            setAttachment: (attrs?: unknown) => ReturnType;
+        imageResize: {
+            /**
+             * 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;
         };
     }
 }

package/lib/index.d.ts

@@ -218,6 +218,13 @@ declare interface BubbleMenuProps {
          */
         hidden?: boolean;
     };
+    imageGifConfig?: {
+        /**
+         * @description Image menu hidden
+         * @default false
+         */
+        hidden?: boolean;
+    };
     videoConfig?: {
         /**
          * @description Video menu hidden
@@ -516,6 +523,7 @@ export declare const en: {
     'editor.attachment.tooltip': string;
     'editor.attachment.uploading': string;
     'editor.attachment.please_upload': string;
+    'editor.imageGif.tooltip': string;
 };
 
 export declare const Excalidraw: Node_2<any, any>;
@@ -607,10 +615,20 @@ declare interface IKatexOptions {
 declare const Image_2: Node_2<ImageOptions, any>;
 export { Image_2 as Image }
 
+export declare const ImageGif: Node_2<ImageGifOptions, any>;
+
+declare interface ImageGifOptions extends ImageOptions {
+    /**
+     * The key for the gif https://giphy.com/
+     */
+    GIPHY_API_KEY: string;
+}
+
 export declare const ImageUpload: Node_3<ImageUploadOptions, any>;
 
 export declare interface ImageUploadOptions {
     upload: (file: File) => Promise<string>;
+    postUpload?: (url: string) => Promise<string>;
     acceptMimes: string[];
     maxSize: number;
 }
@@ -869,6 +887,7 @@ export declare const pt_BR: {
     'editor.attachment.tooltip': string;
     'editor.attachment.uploading': string;
     'editor.attachment.please_upload': string;
+    'editor.imageGif.tooltip': string;
 };
 
 declare interface Result {
@@ -1207,6 +1226,7 @@ export declare const vi: {
     'editor.attachment.tooltip': string;
     'editor.attachment.uploading': string;
     'editor.attachment.please_upload': string;
+    'editor.imageGif.tooltip': string;
 };
 
 export declare const Video: Node_2<VideoOptions, any>;
@@ -1403,6 +1423,7 @@ export declare const zh_CN: {
     'editor.attachment.tooltip': string;
     'editor.attachment.uploading': string;
     'editor.attachment.please_upload': string;
+    'editor.imageGif.tooltip': string;
 };
 
 export { }
@@ -1444,9 +1465,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        tableCellBackground: {
-            setTableCellBackground: (color: string) => ReturnType;
-            unsetTableCellBackground: () => ReturnType;
+        lineHeight: {
+            setLineHeight: (lineHeight: string) => ReturnType;
+            unsetLineHeight: () => ReturnType;
         };
     }
 }
@@ -1454,13 +1475,15 @@ 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;
+        indent: {
+            /**
+             * Set the indent attribute
+             */
+            indent: () => ReturnType;
+            /**
+             * Set the outdent attribute
+             */
+            outdent: () => ReturnType;
         };
     }
 }
@@ -1468,8 +1491,19 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        videoUpload: {
-            setVideoUpload: () => ReturnType;
+        imageResize: {
+            /**
+             * Add an image
+             */
+            setImage: (options: Partial<SetImageAttrsOptions>) => ReturnType;
+            /**
+             * Update an image
+             */
+            updateImage: (options: Partial<SetImageAttrsOptions>) => ReturnType;
+            /**
+             * Set image alignment
+             */
+            setAlignImage: (align: 'left' | 'center' | 'right') => ReturnType;
         };
     }
 }
@@ -1477,14 +1511,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        iframe: {
-            /**
-             * Add an iframe
-             */
-            setIframe: (options: {
-                src: string;
-                service: string;
-            }) => ReturnType;
+        tableCellBackground: {
+            setTableCellBackground: (color: string) => ReturnType;
+            unsetTableCellBackground: () => ReturnType;
         };
     }
 }
@@ -1492,9 +1521,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        lineHeight: {
-            setLineHeight: (lineHeight: string) => ReturnType;
-            unsetLineHeight: () => ReturnType;
+        imageUpload: {
+            setImageUpload: () => ReturnType;
         };
     }
 }
@@ -1502,8 +1530,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        imageUpload: {
-            setImageUpload: () => ReturnType;
+        videoUpload: {
+            setVideoUpload: () => ReturnType;
         };
     }
 }
@@ -1511,15 +1539,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        indent: {
-            /**
-             * Set the indent attribute
-             */
-            indent: () => ReturnType;
-            /**
-             * Set the outdent attribute
-             */
-            outdent: () => ReturnType;
+        painter: {
+            setPainter: (marks: Mark[]) => ReturnType;
         };
     }
 }
@@ -1527,8 +1548,13 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        katex: {
-            setKatex: (arg?: IKatexAttrs) => ReturnType;
+        columns: {
+            insertColumns: (attrs?: {
+                cols: number;
+            }) => ReturnType;
+            addColBefore: () => ReturnType;
+            addColAfter: () => ReturnType;
+            deleteCol: () => ReturnType;
         };
     }
 }
@@ -1536,8 +1562,14 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        painter: {
-            setPainter: (marks: Mark[]) => ReturnType;
+        iframe: {
+            /**
+             * Add an iframe
+             */
+            setIframe: (options: {
+                src: string;
+                service: string;
+            }) => ReturnType;
         };
     }
 }
@@ -1545,13 +1577,13 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        columns: {
-            insertColumns: (attrs?: {
-                cols: number;
-            }) => ReturnType;
-            addColBefore: () => ReturnType;
-            addColAfter: () => ReturnType;
-            deleteCol: () => ReturnType;
+        search: {
+            setSearchTerm: (searchTerm: string) => ReturnType;
+            setReplaceTerm: (replaceTerm: string) => ReturnType;
+            replace: () => ReturnType;
+            replaceAll: () => ReturnType;
+            goToPrevSearchResult: () => void;
+            goToNextSearchResult: () => void;
         };
     }
 }
@@ -1569,6 +1601,15 @@ declare module '@tiptap/core' {
 }
 
 
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        katex: {
+            setKatex: (arg?: IKatexAttrs) => ReturnType;
+        };
+    }
+}
+
+
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         exportWord: {
@@ -1580,19 +1621,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        imageResize: {
-            /**
-             * Add an image
-             */
-            setImage: (options: Partial<SetImageAttrsOptions>) => ReturnType;
-            /**
-             * Update an image
-             */
-            updateImage: (options: Partial<SetImageAttrsOptions>) => ReturnType;
-            /**
-             * Set image alignment
-             */
-            setAlignImage: (align: 'left' | 'center' | 'right') => ReturnType;
+        excalidraw: {
+            setExcalidraw: (attrs?: IExcalidrawAttrs) => ReturnType;
         };
     }
 }
@@ -1600,9 +1630,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        tableOfContents: {
-            setTableOfContents: () => ReturnType;
-            removeTableOfContents: () => ReturnType;
+        attachment: {
+            setAttachment: (attrs?: unknown) => ReturnType;
         };
     }
 }
@@ -1610,8 +1639,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        excalidraw: {
-            setExcalidraw: (attrs?: IExcalidrawAttrs) => ReturnType;
+        tableOfContents: {
+            setTableOfContents: () => ReturnType;
+            removeTableOfContents: () => ReturnType;
         };
     }
 }
@@ -1619,8 +1649,19 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        attachment: {
-            setAttachment: (attrs?: unknown) => ReturnType;
+        imageResize: {
+            /**
+             * 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;
         };
     }
 }