reactjs-tiptap-editor 0.3.31 → 0.4.0

package/lib/index.d.ts

@@ -1,19 +1,9 @@
 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';
 
@@ -35,115 +25,6 @@ declare interface ActionButtonProps {
     initialDisplayedColor?: string;
 }
 
-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 }
-
 /**
  * Represents the BubbleMenuProps.
  */
@@ -253,35 +134,6 @@ declare interface BubbleMenuRenderProps {
     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;
-}
-
 /**
  * Represents the props for the ButtonView component.
  */
@@ -297,38 +149,11 @@ 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;
 }>>;
 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;
-    /** Shortcut keys override */
-    shortcutKeys?: string[] | string[][];
-}
-
 /**
  * Interface for RichTextEditor component props
  */
@@ -377,6 +202,7 @@ declare interface RichTextEditorProps {
     resetCSS?: boolean;
     /** This option gives us the control to enable the default behavior of rendering the editor immediately.*/
     immediatelyRender?: boolean;
+    shouldRerenderOnTransaction?: boolean;
 }
 
 declare interface TableMenuConfig {
@@ -395,9 +221,6 @@ declare interface TableMenuConfig {
     hiddenActions?: string[];
 }
 
-declare interface TextBubbleOptions extends GeneralOptions<TextBubbleOptions> {
-}
-
 /**
  * Represents the ToolbarItemProps.
  */
@@ -422,28 +245,6 @@ 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;
-
-export declare interface UseEditorStateReturn {
-    isReady: boolean;
-    editor: Editor_2 | null;
-    editorRef: React.MutableRefObject<{
-        editor: Editor_2 | null;
-    }>;
-}
-
 export { }
 
 
@@ -479,9 +280,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;
+        excalidraw: {
+            setExcalidraw: (attrs?: IExcalidrawAttrs) => ReturnType;
         };
     }
 }
@@ -489,11 +289,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        emoji: {
-            setEmoji: (emoji: {
-                name: string;
-                emoji: string;
-            }) => ReturnType;
+        drawer: {
+            setDrawer: (options: any, replace?: any) => ReturnType;
+            setAlignImageDrawer: (align: 'left' | 'center' | 'right') => ReturnType;
         };
     }
 }
@@ -501,8 +299,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        excalidraw: {
-            setExcalidraw: (attrs?: IExcalidrawAttrs) => ReturnType;
+        exportPdf: {
+            exportToPdf: () => ReturnType;
         };
     }
 }
@@ -510,8 +308,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        exportPdf: {
-            exportToPdf: () => ReturnType;
+        exportWord: {
+            exportToWord: () => ReturnType;
         };
     }
 }
@@ -519,8 +317,8 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        exportWord: {
-            exportToWord: () => ReturnType;
+        painter: {
+            setPainter: (marks: Mark[]) => ReturnType;
         };
     }
 }
@@ -544,15 +342,6 @@ declare module '@tiptap/core' {
 }
 
 
-declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        painter: {
-            setPainter: (marks: Mark[]) => ReturnType;
-        };
-    }
-}
-
-
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         iframe: {
@@ -608,6 +397,15 @@ declare module '@tiptap/core' {
 }
 
 
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        katex: {
+            setKatex: (arg?: IKatexAttrs) => ReturnType;
+        };
+    }
+}
+
+
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
         indent: {
@@ -626,8 +424,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        katex: {
-            setKatex: (arg?: IKatexAttrs) => ReturnType;
+        lineHeight: {
+            setLineHeight: (lineHeight: string) => ReturnType;
+            unsetLineHeight: () => ReturnType;
         };
     }
 }
@@ -635,9 +434,13 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        lineHeight: {
-            setLineHeight: (lineHeight: string) => ReturnType;
-            unsetLineHeight: () => ReturnType;
+        columns: {
+            insertColumns: (attrs?: {
+                cols: number;
+            }) => ReturnType;
+            addColBefore: () => ReturnType;
+            addColAfter: () => ReturnType;
+            deleteCol: () => ReturnType;
         };
     }
 }
@@ -655,13 +458,9 @@ declare module '@tiptap/core' {
 
 declare module '@tiptap/core' {
     interface Commands<ReturnType> {
-        columns: {
-            insertColumns: (attrs?: {
-                cols: number;
-            }) => ReturnType;
-            addColBefore: () => ReturnType;
-            addColAfter: () => ReturnType;
-            deleteCol: () => ReturnType;
+        tableOfContents: {
+            setTableOfContents: () => ReturnType;
+            removeTableOfContents: () => ReturnType;
         };
     }
 }
@@ -672,22 +471,20 @@ declare module '@tiptap/core' {
         search: {
             setSearchTerm: (searchTerm: string) => ReturnType;
             setReplaceTerm: (replaceTerm: string) => ReturnType;
+            setCaseSensitive: (caseSensitive: boolean) => ReturnType;
+            resetIndex: () => ReturnType;
+            nextSearchResult: () => ReturnType;
+            previousSearchResult: () => ReturnType;
             replace: () => ReturnType;
             replaceAll: () => ReturnType;
-            goToPrevSearchResult: () => void;
-            goToNextSearchResult: () => void;
-            setCaseSensitive: (caseSensitive: boolean) => ReturnType;
         };
     }
 }
 
 
 declare module '@tiptap/core' {
-    interface Commands<ReturnType> {
-        tableOfContents: {
-            setTableOfContents: () => ReturnType;
-            removeTableOfContents: () => ReturnType;
-        };
+    interface Storage {
+        searchAndReplace: SearchAndReplaceStorage;
     }
 }