reactjs-tiptap-editor 0.2.19 → 0.2.21

package/lib/extension-bundle.d.cts

@@ -10,7 +10,9 @@ import { ColorOptions as ColorOptions_2 } from '@tiptap/extension-color';
 import { default as default_2 } from 'mammoth';
 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 { Extensions } from '@tiptap/core';
 import { FocusOptions as FocusOptions_2 } from '@tiptap/extension-focus';
 import { FontFamilyOptions as FontFamilyOptions_2 } from '@tiptap/extension-font-family';
 import { HardBreakOptions } from '@tiptap/extension-hard-break';
@@ -29,6 +31,7 @@ import { Node as Node_2 } from '@tiptap/core';
 import { OrderedListOptions as OrderedListOptions_2 } from '@tiptap/extension-ordered-list';
 import { ParagraphOptions } from '@tiptap/extension-paragraph';
 import { PlaceholderOptions } from '@tiptap/extension-placeholder';
+import { Range as Range_2 } from '@tiptap/core';
 import { StrikeOptions as StrikeOptions_2 } from '@tiptap/extension-strike';
 import { SubscriptExtensionOptions } from '@tiptap/extension-subscript';
 import { SuperscriptExtensionOptions } from '@tiptap/extension-superscript';
@@ -259,6 +262,20 @@ export declare const Column: Node_2<any, any>;
 
 export declare const ColumnActionButton: Extension<any, any>;
 
+declare interface Command {
+    name: string;
+    label: string;
+    description?: string;
+    aliases?: string[];
+    iconName?: any;
+    iconUrl?: string;
+    action: ({ editor, range }: {
+        editor: Editor_2;
+        range: Range_2;
+    }) => void;
+    shouldBeHidden?: (editor: Editor_2) => boolean;
+}
+
 export declare const Drawer: Node_2<DrawerOptions, any>;
 
 declare interface DrawerOptions extends GeneralOptions<DrawerOptions> {
@@ -326,6 +343,12 @@ declare interface GeneralOptions<T> {
     toolbar?: boolean;
 }
 
+declare interface Group {
+    name: string;
+    title: string;
+    commands: Command[];
+}
+
 export declare const Heading: Node_2<HeadingOptions, any>;
 
 export declare interface HeadingOptions extends HeadingOptions_2, GeneralOptions<HeadingOptions> {
@@ -503,7 +526,11 @@ export declare interface SetImageAttrsOptions {
     flipY?: boolean;
 }
 
-export declare const SlashCommand: Extension<any, any>;
+export declare const SlashCommand: Extension<SlashCommandOptions, any>;
+
+declare interface SlashCommandOptions {
+    renderGroupItem?: (extension: Extensions[number], groups: Group[]) => void;
+}
 
 export declare const Strike: Mark<StrikeOptions, any>;
 
@@ -714,6 +741,21 @@ declare module '@tiptap/core' {
 }
 
 
+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> {
         lineHeight: {
@@ -763,35 +805,6 @@ declare module '@tiptap/core' {
 }
 
 
-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> {
-        iframe: {
-            /**
-             * Add an iframe
-             */
-            setIframe: (options: {
-                src: string;
-                service: string;
-            }) => ReturnType;
-        };
-    }
-}
-
-
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         search: {
@@ -819,6 +832,20 @@ declare module '@tiptap/core' {
 }
 
 
+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> {
         katex: {
@@ -839,9 +866,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        tableOfContents: {
-            setTableOfContents: () => ReturnType;
-            removeTableOfContents: () => ReturnType;
+        excalidraw: {
+            setExcalidraw: (attrs?: IExcalidrawAttrs) => ReturnType;
         };
     }
 }
@@ -849,8 +875,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        attachment: {
-            setAttachment: (attrs?: unknown) => ReturnType;
+        tableOfContents: {
+            setTableOfContents: () => ReturnType;
+            removeTableOfContents: () => ReturnType;
         };
     }
 }
@@ -858,9 +885,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        drawer: {
-            setDrawer: (options: any, replace?: any) => ReturnType;
-            setAlignImageDrawer: (align: 'left' | 'center' | 'right') => ReturnType;
+        attachment: {
+            setAttachment: (attrs?: unknown) => ReturnType;
         };
     }
 }
@@ -868,8 +894,19 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        excalidraw: {
-            setExcalidraw: (attrs?: IExcalidrawAttrs) => 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;
         };
     }
 }
@@ -892,9 +929,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        mermaid: {
-            setMermaid: (options: any, replace?: any) => ReturnType;
-            setAlignImageMermaid: (align: 'left' | 'center' | 'right') => ReturnType;
+        drawer: {
+            setDrawer: (options: any, replace?: any) => ReturnType;
+            setAlignImageDrawer: (align: 'left' | 'center' | 'right') => ReturnType;
         };
     }
 }
@@ -902,19 +939,9 @@ 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;
+        mermaid: {
+            setMermaid: (options: any, replace?: any) => ReturnType;
+            setAlignImageMermaid: (align: 'left' | 'center' | 'right') => ReturnType;
         };
     }
 }

package/lib/extension-bundle.d.ts

@@ -10,7 +10,9 @@ import { ColorOptions as ColorOptions_2 } from '@tiptap/extension-color';
 import { default as default_2 } from 'mammoth';
 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 { Extensions } from '@tiptap/core';
 import { FocusOptions as FocusOptions_2 } from '@tiptap/extension-focus';
 import { FontFamilyOptions as FontFamilyOptions_2 } from '@tiptap/extension-font-family';
 import { HardBreakOptions } from '@tiptap/extension-hard-break';
@@ -29,6 +31,7 @@ import { Node as Node_2 } from '@tiptap/core';
 import { OrderedListOptions as OrderedListOptions_2 } from '@tiptap/extension-ordered-list';
 import { ParagraphOptions } from '@tiptap/extension-paragraph';
 import { PlaceholderOptions } from '@tiptap/extension-placeholder';
+import { Range as Range_2 } from '@tiptap/core';
 import { StrikeOptions as StrikeOptions_2 } from '@tiptap/extension-strike';
 import { SubscriptExtensionOptions } from '@tiptap/extension-subscript';
 import { SuperscriptExtensionOptions } from '@tiptap/extension-superscript';
@@ -259,6 +262,20 @@ export declare const Column: Node_2<any, any>;
 
 export declare const ColumnActionButton: Extension<any, any>;
 
+declare interface Command {
+    name: string;
+    label: string;
+    description?: string;
+    aliases?: string[];
+    iconName?: any;
+    iconUrl?: string;
+    action: ({ editor, range }: {
+        editor: Editor_2;
+        range: Range_2;
+    }) => void;
+    shouldBeHidden?: (editor: Editor_2) => boolean;
+}
+
 export declare const Drawer: Node_2<DrawerOptions, any>;
 
 declare interface DrawerOptions extends GeneralOptions<DrawerOptions> {
@@ -326,6 +343,12 @@ declare interface GeneralOptions<T> {
     toolbar?: boolean;
 }
 
+declare interface Group {
+    name: string;
+    title: string;
+    commands: Command[];
+}
+
 export declare const Heading: Node_2<HeadingOptions, any>;
 
 export declare interface HeadingOptions extends HeadingOptions_2, GeneralOptions<HeadingOptions> {
@@ -503,7 +526,11 @@ export declare interface SetImageAttrsOptions {
     flipY?: boolean;
 }
 
-export declare const SlashCommand: Extension<any, any>;
+export declare const SlashCommand: Extension<SlashCommandOptions, any>;
+
+declare interface SlashCommandOptions {
+    renderGroupItem?: (extension: Extensions[number], groups: Group[]) => void;
+}
 
 export declare const Strike: Mark<StrikeOptions, any>;
 
@@ -714,6 +741,21 @@ declare module '@tiptap/core' {
 }
 
 
+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> {
         lineHeight: {
@@ -763,35 +805,6 @@ declare module '@tiptap/core' {
 }
 
 
-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> {
-        iframe: {
-            /**
-             * Add an iframe
-             */
-            setIframe: (options: {
-                src: string;
-                service: string;
-            }) => ReturnType;
-        };
-    }
-}
-
-
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         search: {
@@ -819,6 +832,20 @@ declare module '@tiptap/core' {
 }
 
 
+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> {
         katex: {
@@ -839,9 +866,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        tableOfContents: {
-            setTableOfContents: () => ReturnType;
-            removeTableOfContents: () => ReturnType;
+        excalidraw: {
+            setExcalidraw: (attrs?: IExcalidrawAttrs) => ReturnType;
         };
     }
 }
@@ -849,8 +875,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        attachment: {
-            setAttachment: (attrs?: unknown) => ReturnType;
+        tableOfContents: {
+            setTableOfContents: () => ReturnType;
+            removeTableOfContents: () => ReturnType;
         };
     }
 }
@@ -858,9 +885,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        drawer: {
-            setDrawer: (options: any, replace?: any) => ReturnType;
-            setAlignImageDrawer: (align: 'left' | 'center' | 'right') => ReturnType;
+        attachment: {
+            setAttachment: (attrs?: unknown) => ReturnType;
         };
     }
 }
@@ -868,8 +894,19 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        excalidraw: {
-            setExcalidraw: (attrs?: IExcalidrawAttrs) => 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;
         };
     }
 }
@@ -892,9 +929,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        mermaid: {
-            setMermaid: (options: any, replace?: any) => ReturnType;
-            setAlignImageMermaid: (align: 'left' | 'center' | 'right') => ReturnType;
+        drawer: {
+            setDrawer: (options: any, replace?: any) => ReturnType;
+            setAlignImageDrawer: (align: 'left' | 'center' | 'right') => ReturnType;
         };
     }
 }
@@ -902,19 +939,9 @@ 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;
+        mermaid: {
+            setMermaid: (options: any, replace?: any) => ReturnType;
+            setAlignImageMermaid: (align: 'left' | 'center' | 'right') => ReturnType;
         };
     }
 }