reactjs-tiptap-editor 0.4.1 → 1.0.0

package/lib/SubAndSuperScript.d.ts

@@ -1,377 +0,0 @@
-import { Editor } from '@tiptap/react';
-import { Extension } from '@tiptap/core';
-import { SubscriptExtensionOptions } from '@tiptap/extension-subscript';
-import { SuperscriptExtensionOptions } from '@tiptap/extension-superscript';
-
-/**
- * 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[][];
-}
-
-export declare const SubAndSuperScript: Extension<SubAndSuperScriptOptions, any>;
-
-/**
- * Represents the interface for subscript and superscript options, extending GeneralOptions.
- */
-export declare interface SubAndSuperScriptOptions extends GeneralOptions<SubAndSuperScriptOptions> {
-    /**
-     * subscript options or false, indicating whether subscript is enabled
-     *
-     * @default true
-     */
-    subscript: Partial<SubscriptExtensionOptions> | false;
-    /**
-     * superscript options or false, indicating whether superscript is enabled
-     *
-     * @default true
-     */
-    superscript: Partial<SuperscriptExtensionOptions> | false;
-}
-
-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;
-        };
-    }
-}

package/lib/SubAndSuperScript.js

@@ -1,43 +0,0 @@
-import { E as a } from "./index-kbO3iWqL.js";
-import { S as b, a as l } from "./index-D_L6n8O8.js";
-import { A as r } from "./RichTextEditor-DGcKEUGr.js";
-const g = /* @__PURE__ */ a.create({
-  name: "subAndSuperScript",
-  // eslint-disable-next-line @typescript-eslint/ban-ts-comment
-  //@ts-expect-error
-  addOptions() {
-    var s;
-    return {
-      ...(s = this.parent) == null ? void 0 : s.call(this),
-      button: ({ editor: t, extension: p, t: o }) => {
-        const c = p.options.subscript, n = p.options.superscript, e = {
-          component: r,
-          componentProps: {
-            action: () => t.commands.toggleSubscript(),
-            isActive: () => t.isActive("subscript") || !1,
-            disabled: !t.can().toggleSubscript(),
-            icon: "Subscript",
-            tooltip: o("editor.subscript.tooltip")
-          }
-        }, u = {
-          component: r,
-          componentProps: {
-            action: () => t.commands.toggleSuperscript(),
-            isActive: () => t.isActive("superscript") || !1,
-            disabled: !t.can().toggleSuperscript(),
-            icon: "Superscript",
-            tooltip: o("editor.superscript.tooltip")
-          }
-        }, i = [];
-        return c !== !1 && i.push(e), n !== !1 && i.push(u), i;
-      }
-    };
-  },
-  addExtensions() {
-    const s = [];
-    return this.options.subscript !== !1 && s.push(b.configure(this.options.subscript)), this.options.superscript !== !1 && s.push(l.configure(this.options.superscript)), s;
-  }
-});
-export {
-  g as SubAndSuperScript
-};

package/lib/TableOfContent.cjs

@@ -1 +0,0 @@
-"use strict";Object.defineProperty(exports,Symbol.toStringTag,{value:"Module"});const h=require("./index-DF2Lp4HZ.cjs"),p=require("./dom-dataset-_6-diIRQ.cjs"),l=require("react/jsx-runtime"),c=require("react"),C=require("./index-6D1J-A-o.cjs"),b=require("./RichTextEditor-CxvwGvQG.cjs"),g="_toc_aag8a_1",x="_visible_aag8a_7",T="_list_aag8a_11",O="_item_aag8a_16",f={toc:g,visible:x,list:T,item:O};function _(e){const s=[],o=[s];return e.forEach(a=>{let t=-1,n=o[a.level+t];for(;!n;)t-=1,n=o[a.level+t];n.push({...a,children:o[a.level]=[]})}),s}function y({editor:e}){const s=b.useEditableEditor(),[o,a]=c.useState([]),{t}=C.useLocale(),n=c.useCallback(()=>{const i=[],r=e.state.tr;e.state.doc.descendants((u,v)=>{if(u.type.name==="heading"){const d=`heading-${i.length+1}`;u.attrs.id!==d&&r.setNodeMarkup(v,void 0,{...u.attrs,id:d}),i.push({level:u.attrs.level,text:u.textContent,id:d})}}),r.setMeta("addToHistory",!1),r.setMeta("preventUpdate",!0),e.view.dispatch(r),a(i),e.eventEmitter&&e.eventEmitter.emit("TableOfContents",_(i))},[e]);return c.useEffect(()=>{if(e){if(!e.options.editable){n();return}return e.on("update",n),()=>{e.off("update",n)}}},[e,n]),c.useEffect(()=>{n()},[]),l.jsx(p.NodeViewWrapper,{className:p.clsx("tableOfContent",f.toc,s&&f.visible),children:s?l.jsxs("div",{style:{position:"relative"},children:[l.jsx("p",{className:"text-[20px] richtext-mb-[8px] richtext-font-semibold",children:t("editor.table_of_content")}),l.jsx("ul",{className:f.list,children:o.map((i,r)=>l.jsx("li",{className:f.item,style:{paddingLeft:`${i.level-1}rem`},children:l.jsx("a",{href:`#${i.id}`,children:i.text})},`table-of-content-${r}`))})]}):null})}function N(e,...s){const[o,a]=c.useState(!1);return c.useEffect(()=>{const t=()=>{a(e.isActive.apply(e,s))};return e.on("selectionUpdate",t),e.on("transaction",t),()=>{e.off("selectionUpdate",t),e.off("transaction",t)}},[e,s,a]),o}function A({editor:e,icon:s,tooltip:o,tooltipOptions:a}){const t=N(e,m.name),n=c.useCallback(()=>{if(t){e.chain().focus().removeTableOfContents().run();return}e.chain().focus().setTableOfContents().run()},[e,t]);return l.jsx(b.ActionButton,{action:n,isActive:()=>t||!1,icon:s,tooltip:o,tooltipOptions:a})}function j(e){return e&&e.type.name==="title"}function E(e,s){const a=[e.getJSON()],t=[];for(;a.length>0;){const n=a.shift();n.type===s&&t.push(n),n.content&&n.content.length>0&&a.push(...n.content)}return t}const m=h.Node3.create({name:"tableOfContents",group:"block",atom:!0,addOptions(){var e;return{...(e=this.parent)==null?void 0:e.call(this),onHasOneBeforeInsert:()=>{},resizable:!0,lastColumnResizable:!0,allowTableNodeSelection:!1,button:({editor:s,t:o})=>({component:A,componentProps:{disabled:!1,icon:"BookMarked",tooltip:o("editor.table_of_content"),editor:s}})}},parseHTML(){return[{tag:"toc"}]},renderHTML({HTMLAttributes:e}){return["toc",h.mergeAttributes(e)]},addNodeView(){return p.ReactNodeViewRenderer(y)},addCommands(){return{setTableOfContents:()=>({commands:e,editor:s,view:o})=>{if(E(s,this.name).length>0){this.options.onHasOneBeforeInsert();return}const t=o.props.state.doc.content.firstChild;if(j(t)){const n=(t.firstChild&&t.firstChild.nodeSize||0)+1;return e.insertContentAt(n,{type:this.name})}return e.insertContent({type:this.name})},removeTableOfContents:()=>({state:e,dispatch:s})=>{const{tr:o}=e,a=e.schema.nodes.tableOfContents;return e.doc.descendants((t,n)=>{if(t.type===a){const i=n,r=n+t.nodeSize;o.delete(i,r)}}),o.docChanged?(s(o),!0):!1}}},addGlobalAttributes(){return[{types:["heading"],attributes:{id:{default:null}}}]}});exports.TableOfContents=m;

package/lib/TableOfContent.d.cts

@@ -1,291 +0,0 @@
-import { Node as Node_2 } from '@tiptap/core';
-
-declare interface Options {
-    onHasOneBeforeInsert?: () => void;
-}
-
-export declare const TableOfContents: Node_2<Options, any>;
-
-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;
-        };
-    }
-}