reactjs-tiptap-editor 1.0.1 → 1.0.2

package/lib/extensions/ImageGif/components/services.d.ts

@@ -0,0 +1,458 @@
+export interface IResGiphy {
+    data: IDataGiphy[];
+    meta: Meta;
+    pagination: Pagination;
+}
+export interface IDataGiphy {
+    type: string;
+    id: string;
+    url: string;
+    slug: string;
+    bitly_gif_url: string;
+    bitly_url: string;
+    embed_url: string;
+    username: string;
+    source: string;
+    title: string;
+    rating: string;
+    content_url: string;
+    source_tld: string;
+    source_post_url: string;
+    source_caption: string;
+    is_sticker: number;
+    import_datetime: string;
+    trending_datetime: string;
+    images: Images;
+    user?: User;
+    analytics_response_payload: string;
+    analytics: Analytics;
+    alt_text: string;
+    is_low_contrast: boolean;
+}
+export interface Images {
+    original: Original;
+    downsized: Downsized;
+    downsized_large: DownsizedLarge;
+    downsized_medium: DownsizedMedium;
+    downsized_small: DownsizedSmall;
+    downsized_still: DownsizedStill;
+    fixed_height: FixedHeight;
+    fixed_height_downsampled: FixedHeightDownsampled;
+    fixed_height_small: FixedHeightSmall;
+    fixed_height_small_still: FixedHeightSmallStill;
+    fixed_height_still: FixedHeightStill;
+    fixed_width: FixedWidth;
+    fixed_width_downsampled: FixedWidthDownsampled;
+    fixed_width_small: FixedWidthSmall;
+    fixed_width_small_still: FixedWidthSmallStill;
+    fixed_width_still: FixedWidthStill;
+    looping: Looping;
+    original_still: OriginalStill;
+    original_mp4: OriginalMp4;
+    preview: Preview;
+    preview_gif: PreviewGif;
+    preview_webp: PreviewWebp;
+    '480w_still': N480wStill;
+    hd?: Hd;
+}
+export interface Original {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+    mp4_size: string;
+    mp4: string;
+    webp_size: string;
+    webp: string;
+    frames: string;
+    hash: string;
+}
+export interface Downsized {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+}
+export interface DownsizedLarge {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+}
+export interface DownsizedMedium {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+}
+export interface DownsizedSmall {
+    height: string;
+    width: string;
+    mp4_size: string;
+    mp4: string;
+}
+export interface DownsizedStill {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+}
+export interface FixedHeight {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+    mp4_size: string;
+    mp4: string;
+    webp_size: string;
+    webp: string;
+}
+export interface FixedHeightDownsampled {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+    webp_size: string;
+    webp: string;
+}
+export interface FixedHeightSmall {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+    mp4_size: string;
+    mp4: string;
+    webp_size: string;
+    webp: string;
+}
+export interface FixedHeightSmallStill {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+}
+export interface FixedHeightStill {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+}
+export interface FixedWidth {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+    mp4_size: string;
+    mp4: string;
+    webp_size: string;
+    webp: string;
+}
+export interface FixedWidthDownsampled {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+    webp_size: string;
+    webp: string;
+}
+export interface FixedWidthSmall {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+    mp4_size: string;
+    mp4: string;
+    webp_size: string;
+    webp: string;
+}
+export interface FixedWidthSmallStill {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+}
+export interface FixedWidthStill {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+}
+export interface Looping {
+    mp4_size?: string;
+    mp4?: string;
+}
+export interface OriginalStill {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+}
+export interface OriginalMp4 {
+    height: string;
+    width: string;
+    mp4_size: string;
+    mp4: string;
+}
+export interface Preview {
+    height: string;
+    width: string;
+    mp4_size: string;
+    mp4: string;
+}
+export interface PreviewGif {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+}
+export interface PreviewWebp {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+}
+export interface N480wStill {
+    height: string;
+    width: string;
+    size: string;
+    url: string;
+}
+export interface Hd {
+    height: string;
+    width: string;
+    mp4_size: string;
+    mp4: string;
+}
+export interface User {
+    avatar_url: string;
+    banner_image: string;
+    banner_url: string;
+    profile_url: string;
+    username: string;
+    display_name: string;
+    description: string;
+    instagram_url: string;
+    website_url: string;
+    is_verified: boolean;
+}
+export interface Analytics {
+    onload: Onload;
+    onclick: Onclick;
+    onsent: Onsent;
+}
+export interface Onload {
+    url: string;
+}
+export interface Onclick {
+    url: string;
+}
+export interface Onsent {
+    url: string;
+}
+export interface Meta {
+    status: number;
+    msg: string;
+    response_id: string;
+}
+export interface Pagination {
+    total_count: number;
+    count: number;
+    offset: number;
+}
+export interface GifItem {
+    id: string;
+    src: string;
+    width: number;
+    height: number;
+}
+export interface IResTenor {
+    results: IDataTenor[];
+    next: string;
+}
+export interface IDataTenor {
+    id: string;
+    title: string;
+    media_formats: MediaFormats;
+    created: number;
+    content_description: string;
+    itemurl: string;
+    url: string;
+    tags: string[];
+    flags: string[];
+    hasaudio: boolean;
+    content_description_source: string;
+}
+export interface MediaFormats {
+    mp4: Mp4;
+    loopedmp4: Loopedmp4;
+    nanogif: Nanogif;
+    nanomp4: Nanomp4;
+    tinygif: Tinygif;
+    tinywebm: Tinywebm;
+    webm: Webm;
+    mediumgif: Mediumgif;
+    nanowebm: Nanowebm;
+    nanogifpreview: Nanogifpreview;
+    tinymp4: Tinymp4;
+    gifpreview: Gifpreview;
+    tinygifpreview: Tinygifpreview;
+    gif: Gif;
+    webp: Webp;
+    nanowebppreview_transparent?: NanowebppreviewTransparent;
+    tinywebp_transparent?: TinywebpTransparent;
+    nanowebp_transparent?: NanowebpTransparent;
+    webp_transparent?: WebpTransparent;
+    webppreview_transparent?: WebppreviewTransparent;
+    tinywebppreview_transparent?: TinywebppreviewTransparent;
+}
+export interface Mp4 {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Loopedmp4 {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Nanogif {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Nanomp4 {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Tinygif {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Tinywebm {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Webm {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Mediumgif {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Nanowebm {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Nanogifpreview {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Tinymp4 {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Gifpreview {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Tinygifpreview {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Gif {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface Webp {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface NanowebppreviewTransparent {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface TinywebpTransparent {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface NanowebpTransparent {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface WebpTransparent {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface WebppreviewTransparent {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export interface TinywebppreviewTransparent {
+    url: string;
+    duration: number;
+    preview: string;
+    dims: number[];
+    size: number;
+}
+export declare function serviceGetTrendingGiphy(apiKey: string): Promise<GifItem[]>;
+export declare function serviceSearchGiphy(term: string, apiKey: string): Promise<GifItem[]>;
+export declare function serviceGetTrendingTenor(apiKey: string): Promise<GifItem[]>;
+export declare function serviceSearchTenor(term: string, apiKey: string): Promise<GifItem[]>;

package/lib/extensions/ImageGif/index.d.ts

@@ -0,0 +1 @@
+export * from './ImageGif';

package/lib/extensions/ImportWord/ImportWord.d.ts

@@ -0,0 +1,18 @@
+import { Extension } from '@tiptap/core';
+import { default as Mammoth } from 'mammoth';
+import { GeneralOptions } from '../../types';
+export * from './components/RichTextImportWord';
+interface ImportWordOptions extends GeneralOptions<ImportWordOptions> {
+    /** Function for converting Word files to HTML */
+    convert?: (file: File) => Promise<string>;
+    /** Function for uploading images */
+    upload?: (files: File[]) => Promise<unknown>;
+    /**
+     * File Size limit(10 MB)
+     *
+     * @default 1024 * 1024 * 10
+     */
+    limit?: number;
+    mammothOptions?: Parameters<typeof Mammoth['convertToHtml']>[1];
+}
+export declare const ImportWord: Extension<ImportWordOptions, any>;

package/lib/extensions/ImportWord/components/RichTextImportWord.d.ts

@@ -0,0 +1 @@
+export declare function RichTextImportWord(): import("react/jsx-runtime").JSX.Element;

package/lib/extensions/ImportWord/index.d.ts

@@ -0,0 +1 @@
+export * from './ImportWord';

package/lib/extensions/Indent/Indent.d.ts

@@ -0,0 +1,23 @@
+import { Extension } from '@tiptap/core';
+import { GeneralOptions } from '../../types';
+export * from './components/RichTextIndent';
+export interface IndentOptions extends GeneralOptions<IndentOptions> {
+    types: string[];
+    minIndent: number;
+    maxIndent: number;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        indent: {
+            /**
+             * Set the indent attribute
+             */
+            indent: () => ReturnType;
+            /**
+             * Set the outdent attribute
+             */
+            outdent: () => ReturnType;
+        };
+    }
+}
+export declare const Indent: Extension<IndentOptions, any>;

package/lib/extensions/Indent/components/RichTextIndent.d.ts

@@ -0,0 +1 @@
+export declare function RichTextIndent(): import("react/jsx-runtime").JSX.Element;

package/lib/extensions/Indent/index.d.ts

@@ -0,0 +1 @@
+export * from './Indent';

package/lib/extensions/Italic/Italic.d.ts

@@ -0,0 +1,6 @@
+import { ItalicOptions as TiptapItalicOptions } from '@tiptap/extension-italic';
+import { GeneralOptions } from '../../types';
+export * from './components/RichTextItalic';
+export interface ItalicOptions extends TiptapItalicOptions, GeneralOptions<ItalicOptions> {
+}
+export declare const Italic: import('@tiptap/core').Mark<ItalicOptions, any>;

package/lib/extensions/Italic/components/RichTextItalic.d.ts

@@ -0,0 +1 @@
+export declare function RichTextItalic(): import("react/jsx-runtime").JSX.Element;

package/lib/extensions/Italic/index.d.ts

@@ -0,0 +1 @@
+export * from './Italic';

package/lib/extensions/Katex/Katex.d.ts

@@ -0,0 +1,17 @@
+import { Node } from '@tiptap/core';
+export * from './components/RichTextKatex';
+export interface IKatexAttrs {
+    text?: string;
+    defaultShowPicker?: boolean;
+}
+interface IKatexOptions {
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        katex: {
+            setKatex: (arg?: IKatexAttrs) => ReturnType;
+        };
+    }
+}
+export declare const Katex: Node<IKatexOptions, any>;

package/lib/extensions/Katex/components/KatexWrapper.d.ts

@@ -0,0 +1 @@
+export declare function KatexNodeView({ node }: any): import("react/jsx-runtime").JSX.Element;

package/lib/extensions/Katex/components/RichTextKatex.d.ts

@@ -0,0 +1 @@
+export declare function RichTextKatex(): import("react/jsx-runtime").JSX.Element;

package/lib/extensions/Katex/index.d.ts

@@ -0,0 +1 @@
+export * from './Katex';

package/lib/extensions/LineHeight/LineHeight.d.ts

@@ -0,0 +1,7 @@
+import { LineHeightOptions as TiptapLineHeightOptions } from '@tiptap/extension-text-style';
+import { GeneralOptions } from '../../types';
+export * from './components/RichTextLightHeight';
+export interface LineHeightOptions extends GeneralOptions<TiptapLineHeightOptions> {
+    lineHeights: string[];
+}
+export declare const LineHeight: import('@tiptap/core').Extension<LineHeightOptions, any>;

package/lib/extensions/LineHeight/components/RichTextLightHeight.d.ts

@@ -0,0 +1 @@
+export declare function RichTextLineHeight(): import("react/jsx-runtime").JSX.Element;

package/lib/extensions/LineHeight/index.d.ts

@@ -0,0 +1 @@
+export * from './LineHeight';

package/lib/extensions/Link/Link.d.ts

@@ -0,0 +1,6 @@
+import { LinkOptions as TiptapLinkOptions } from '@tiptap/extension-link';
+import { GeneralOptions } from '../../types';
+export * from './components/RichTextLink';
+export interface LinkOptions extends TiptapLinkOptions, GeneralOptions<LinkOptions> {
+}
+export declare const Link: import('@tiptap/core').Mark<LinkOptions, any>;

package/lib/extensions/Link/components/LinkEditBlock.d.ts

@@ -0,0 +1,8 @@
+interface IPropsLinkEditBlock {
+    editor: any;
+    onSetLink: (link: string, text?: string, openInNewTab?: boolean) => void;
+    open?: boolean;
+    target?: string;
+}
+declare function LinkEditBlock(props: IPropsLinkEditBlock): import("react/jsx-runtime").JSX.Element;
+export default LinkEditBlock;

package/lib/extensions/Link/components/LinkViewBlock.d.ts

@@ -0,0 +1,8 @@
+interface IPropsLinkViewBlock {
+    editor: any;
+    link: string;
+    onClear?: any;
+    onEdit?: any;
+}
+declare function LinkViewBlock(props: IPropsLinkViewBlock): import("react/jsx-runtime").JSX.Element;
+export default LinkViewBlock;

package/lib/extensions/Link/components/RichTextLink.d.ts

@@ -0,0 +1 @@
+export declare function RichTextLink(): import("react/jsx-runtime").JSX.Element;

package/lib/extensions/Link/index.d.ts

@@ -0,0 +1 @@
+export * from './Link';

package/lib/extensions/Mention/Mention.d.ts

@@ -0,0 +1 @@
+export declare const Mention: import('@tiptap/core').Node<import('@tiptap/extension-mention').MentionOptions<any, import('@tiptap/extension-mention').MentionNodeAttrs>, any>;

package/lib/extensions/Mention/components/NodeViewMentionList.d.ts

@@ -0,0 +1,10 @@
+import { default as React } from 'react';
+import { Editor } from '@tiptap/core';
+interface IProps {
+    editor: Editor;
+    items: Array<string>;
+    command: any;
+    onClose?: () => void;
+}
+export declare const NodeViewMentionList: React.FC<IProps>;
+export {};

package/lib/extensions/Mention/index.d.ts

@@ -0,0 +1 @@
+export * from './Mention';

package/lib/extensions/Mermaid/Mermaid.d.ts

@@ -0,0 +1,15 @@
+import { GeneralOptions } from '../../types';
+export * from './components/RichTextMermaid';
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        mermaid: {
+            setMermaid: (options: any, replace?: any) => ReturnType;
+            setAlignImageMermaid: (align: 'left' | 'center' | 'right') => ReturnType;
+        };
+    }
+}
+export interface MermaidOptions extends GeneralOptions<MermaidOptions> {
+    /** Function for uploading files */
+    upload?: (file: File) => Promise<string>;
+}
+export declare const Mermaid: import('@tiptap/core').Node<MermaidOptions, any>;

package/lib/extensions/Mermaid/components/EditMermaidBlock.d.ts

@@ -0,0 +1,8 @@
+import { Editor } from '@tiptap/core';
+interface IProps {
+    editor: Editor;
+    attrs?: any;
+    extension?: any;
+}
+export declare const EditMermaidBlock: React.FC<IProps>;
+export {};

package/lib/extensions/Mermaid/components/NodeViewMermaid/NodeViewMermaid.d.ts

@@ -0,0 +1 @@
+export declare function NodeViewMermaid({ editor, node, updateAttributes, getPos, selected }: any): import("react/jsx-runtime").JSX.Element;

package/lib/extensions/Mermaid/components/RichTextMermaid.d.ts

@@ -0,0 +1 @@
+export declare function RichTextMermaid(): import("react/jsx-runtime").JSX.Element;

package/lib/extensions/Mermaid/index.d.ts

@@ -0,0 +1 @@
+export * from './Mermaid';

package/lib/extensions/MoreMark/MoreMark.d.ts

@@ -0,0 +1,20 @@
+import { Extension } from '@tiptap/core';
+import { SubscriptExtensionOptions as TiptapSubscriptOptions } from '@tiptap/extension-subscript';
+import { SuperscriptExtensionOptions as TiptapSuperscriptOptions } from '@tiptap/extension-superscript';
+import { GeneralOptions } from '../../types';
+export * from './components/RichTextMoreMark';
+export interface MoreMarkOptions extends GeneralOptions<MoreMarkOptions> {
+    /**
+     * // options for Subscript Extension
+     *
+     * @default true
+     */
+    subscript: Partial<TiptapSubscriptOptions> | false;
+    /**
+     * // options for Superscript Extension
+     *
+     * @default true
+     */
+    superscript: Partial<TiptapSuperscriptOptions> | false;
+}
+export declare const MoreMark: Extension<MoreMarkOptions, any>;