reactjs-tiptap-editor 1.0.0 → 1.0.2

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

@@ -0,0 +1,14 @@
+import { default as React } from 'react';
+import { ButtonViewReturnComponentProps } from '../../../types';
+export interface Item {
+    title: string;
+    icon?: any;
+    isActive: NonNullable<ButtonViewReturnComponentProps['isActive']>;
+    action?: ButtonViewReturnComponentProps['action'];
+    style?: React.CSSProperties;
+    shortcutKeys?: string[];
+    disabled?: boolean;
+    divider?: boolean;
+    default?: boolean;
+}
+export declare function RichTextMoreMark(): import("react/jsx-runtime").JSX.Element;

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

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

package/lib/extensions/OrderedList/OrderedList.d.ts

@@ -0,0 +1,6 @@
+import { OrderedListOptions as TiptapOrderedListOptions } from '@tiptap/extension-list';
+import { GeneralOptions } from '../../types';
+export * from './components/RichTextOrderedList';
+export interface OrderedListOptions extends TiptapOrderedListOptions, GeneralOptions<OrderedListOptions> {
+}
+export declare const OrderedList: import('@tiptap/core').Node<OrderedListOptions, any>;

package/lib/extensions/OrderedList/components/RichTextOrderedList.d.ts

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

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

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

package/lib/extensions/SearchAndReplace/SearchAndReplace.d.ts

@@ -0,0 +1,36 @@
+import { Extension, Range } from '@tiptap/core';
+export * from './components/RichTextSearchAndReplace';
+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;
+        };
+    }
+}
+export interface SearchAndReplaceOptions {
+    searchResultClass: string;
+    disableRegex: boolean;
+}
+export interface SearchAndReplaceStorage {
+    searchTerm: string;
+    replaceTerm: string;
+    results: Range[];
+    lastSearchTerm: string;
+    caseSensitive: boolean;
+    lastCaseSensitive: boolean;
+    resultIndex: number;
+    lastResultIndex: number;
+}
+declare module '@tiptap/core' {
+    interface Storage {
+        searchAndReplace: SearchAndReplaceStorage;
+    }
+}
+export declare const SearchAndReplace: Extension<SearchAndReplaceOptions, SearchAndReplaceStorage>;

package/lib/extensions/SearchAndReplace/components/RichTextSearchAndReplace.d.ts

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

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

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

package/lib/extensions/SlashCommand/SlashCommand.d.ts

@@ -0,0 +1,4 @@
+import { Extension } from '@tiptap/core';
+export * from './components/SlashCommandList';
+export * from './renderCommandListDefault';
+export declare const SlashCommand: Extension<any, any>;

package/lib/extensions/SlashCommand/components/SlashCommandList.d.ts

@@ -0,0 +1,6 @@
+import { CommandList } from '../types';
+interface SlashCommandListProps {
+    commandList?: CommandList[];
+}
+export declare function SlashCommandList({ commandList }: SlashCommandListProps): import("react/jsx-runtime").JSX.Element;
+export {};

package/lib/extensions/SlashCommand/components/SlashCommandNodeView.d.ts

@@ -0,0 +1,3 @@
+import { default as React } from 'react';
+declare const _default: React.ForwardRefExoticComponent<Omit<any, "ref"> & React.RefAttributes<unknown>>;
+export default _default;

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

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

package/lib/extensions/SlashCommand/renderCommandListDefault.d.ts

@@ -0,0 +1,7 @@
+import { CommandList } from './types';
+export declare function renderCommandListDefault({ t }: any): CommandList[];
+export declare function useFilterCommandList(commandList: CommandList[], query: string): {
+    commands: import('./types').Command[];
+    name: string;
+    title: string;
+}[];

package/lib/extensions/SlashCommand/types.d.ts

@@ -0,0 +1,19 @@
+import { Editor, Range } from '@tiptap/core';
+export interface CommandList {
+    name: string;
+    title: string;
+    commands: Command[];
+}
+export interface Command {
+    name: string;
+    label: string;
+    description?: string;
+    aliases?: string[];
+    iconName?: any;
+    iconUrl?: string;
+    action: ({ editor, range }: {
+        editor: Editor;
+        range: Range;
+    }) => void;
+    shouldBeHidden?: (editor: Editor) => boolean;
+}

package/lib/extensions/Strike/Strike.d.ts

@@ -0,0 +1,6 @@
+import { StrikeOptions as TiptapStrikeOptions } from '@tiptap/extension-strike';
+import { GeneralOptions } from '../../types';
+export * from './components/RichTextStrike';
+export interface StrikeOptions extends TiptapStrikeOptions, GeneralOptions<StrikeOptions> {
+}
+export declare const Strike: import('@tiptap/core').Mark<StrikeOptions, any>;

package/lib/extensions/Strike/components/RichTextStrike.d.ts

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

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

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

package/lib/extensions/Table/Table.d.ts

@@ -0,0 +1,21 @@
+import { TableCellOptions, TableRowOptions, TableHeaderOptions } from '@tiptap/extension-table';
+import { GeneralOptions } from '../../types';
+import { TableCellBackgroundOptions } from './TableCellBackground';
+export interface TableOptions extends GeneralOptions<TableOptions> {
+    HTMLAttributes: Record<string, any>;
+    resizable: boolean;
+    handleWidth: number;
+    cellMinWidth: number;
+    lastColumnResizable: boolean;
+    allowTableNodeSelection: boolean;
+    /** options for table rows */
+    tableRow: Partial<TableRowOptions>;
+    /** options for table headers */
+    tableHeader: Partial<TableHeaderOptions>;
+    /** options for table cells */
+    tableCell: Partial<TableCellOptions>;
+    /** options for table cell background */
+    tableCellBackground: Partial<TableCellBackgroundOptions>;
+}
+export * from './components/RichTextTable';
+export declare const Table: import('@tiptap/core').Node<TableOptions, any>;

package/lib/extensions/Table/TableCellBackground.d.ts

@@ -0,0 +1,14 @@
+import { Extension } from '@tiptap/core';
+export interface TableCellBackgroundOptions {
+    HTMLAttributes: Record<string, any>;
+    types?: any;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        tableCellBackground: {
+            setTableCellBackground: (color: string) => ReturnType;
+            unsetTableCellBackground: () => ReturnType;
+        };
+    }
+}
+export declare const TableCellBackground: Extension<TableCellBackgroundOptions, any>;

package/lib/extensions/Table/components/CreateTablePopover.d.ts

@@ -0,0 +1,7 @@
+interface IPropsCreateTablePopover {
+    createTable: any;
+    children: any;
+    dataState?: any;
+}
+declare function CreateTablePopover(props: IPropsCreateTablePopover): import("react/jsx-runtime").JSX.Element;
+export default CreateTablePopover;

package/lib/extensions/Table/components/RichTextTable.d.ts

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

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

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

package/lib/extensions/TaskList/TaskList.d.ts

@@ -0,0 +1,11 @@
+import { TaskItemOptions, TaskListOptions as TiptapTaskListOptions } from '@tiptap/extension-list';
+import { GeneralOptions } from '../../types';
+export * from './components/RichTextTaskList';
+/**
+ * Represents the interface for task list options, extending TiptapTaskListOptions and GeneralOptions.
+ */
+export interface TaskListOptions extends TiptapTaskListOptions, GeneralOptions<TaskListOptions> {
+    /** options for task items */
+    taskItem: Partial<TaskItemOptions>;
+}
+export declare const TaskList: import('@tiptap/core').Node<TaskListOptions, any>;

package/lib/extensions/TaskList/components/RichTextTaskList.d.ts

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

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

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

package/lib/extensions/TextAlign/TextAlign.d.ts

@@ -0,0 +1,17 @@
+import { Extension } from '@tiptap/core';
+import { TextAlignOptions as TiptapTextAlignOptions } from '@tiptap/extension-text-align';
+import { GeneralOptions } from '../../types';
+export * from './components/RichTextAlign';
+type Alignments = 'left' | 'center' | 'right' | 'justify';
+/**
+ * Represents the interface for text align options, extending TiptapTextAlignOptions and GeneralOptions.
+ */
+export interface TextAlignOptions extends TiptapTextAlignOptions, GeneralOptions<TextAlignOptions> {
+    /**
+     * List of available alignment options
+     *
+     * @default ['left', 'center', 'right', 'justify']
+     */
+    alignments: Alignments[];
+}
+export declare const TextAlign: Extension<TextAlignOptions, any>;

package/lib/extensions/TextAlign/components/RichTextAlign.d.ts

@@ -0,0 +1,14 @@
+import { default as React } from 'react';
+import { ButtonViewReturnComponentProps } from '../../../types';
+export interface Item {
+    title: string;
+    icon?: any;
+    isActive: NonNullable<ButtonViewReturnComponentProps['isActive']>;
+    action?: ButtonViewReturnComponentProps['action'];
+    style?: React.CSSProperties;
+    shortcutKeys?: string[];
+    disabled?: boolean;
+    divider?: boolean;
+    default?: boolean;
+}
+export declare function RichTextAlign(): import("react/jsx-runtime").JSX.Element;

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

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

package/lib/extensions/TextDirection/TextDirection.d.ts

@@ -0,0 +1,5 @@
+import { Extension } from '@tiptap/core';
+export * from './components/RichTextTextDirection';
+export * from './components/RichTextTextDirection';
+declare const TextDirection: Extension<any, any>;
+export { TextDirection };

package/lib/extensions/TextDirection/components/RichTextTextDirection.d.ts

@@ -0,0 +1,15 @@
+import { default as React } from 'react';
+import { ButtonViewReturnComponentProps } from '../../../types';
+export interface Item {
+    title: string;
+    value?: string;
+    icon?: any;
+    isActive: NonNullable<ButtonViewReturnComponentProps['isActive']>;
+    action?: ButtonViewReturnComponentProps['action'];
+    style?: React.CSSProperties;
+    shortcutKeys?: string[];
+    disabled?: boolean;
+    divider?: boolean;
+    default?: boolean;
+}
+export declare function RichTextTextDirection(): import("react/jsx-runtime").JSX.Element;

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

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

package/lib/extensions/TextUnderline/TextUnderline.d.ts

@@ -0,0 +1,6 @@
+import { UnderlineOptions as TiptapUnderlineOptions } from '@tiptap/extension-underline';
+import { GeneralOptions } from '../../types';
+export * from './components/RichTextUnderline';
+export interface UnderlineOptions extends TiptapUnderlineOptions, GeneralOptions<UnderlineOptions> {
+}
+export declare const TextUnderline: import('@tiptap/core').Mark<UnderlineOptions, any>;

package/lib/extensions/TextUnderline/components/RichTextUnderline.d.ts

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

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

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

package/lib/extensions/Twitter/Twitter.d.ts

@@ -0,0 +1,46 @@
+import { Node } from '@tiptap/core';
+export * from './components/RichTextTwitter';
+interface TwitterOptions {
+    /**
+     * Controls if the paste handler for tweets should be added.
+     * @default true
+     * @example false
+     */
+    addPasteHandler: boolean;
+    HTMLAttributes: Record<string, any>;
+    /**
+     * Controls if the twitter node should be inline or not.
+     * @default false
+     * @example true
+     */
+    inline: boolean;
+    /**
+     * The origin of the tweet.
+     * @default ''
+     * @example 'https://tiptap.dev'
+     */
+    origin: string;
+}
+/**
+ * The options for setting a tweet.
+ */
+interface SetTweetOptions {
+    src: string;
+}
+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;
+        };
+    }
+}
+/**
+ * This extension adds support for tweets.
+ */
+export declare const Twitter: Node<TwitterOptions, any>;

package/lib/extensions/Twitter/components/FormEditLinkTwitter.d.ts

@@ -0,0 +1,6 @@
+interface IPropsFormEditLinkTwitter {
+    editor: any;
+    onSetLink: (src: string) => void;
+}
+declare function FormEditLinkTwitter(props: IPropsFormEditLinkTwitter): import("react/jsx-runtime").JSX.Element;
+export default FormEditLinkTwitter;

package/lib/extensions/Twitter/components/NodeViewTweet.d.ts

@@ -0,0 +1,8 @@
+import { ReactNodeViewRendererOptions } from '@tiptap/react';
+export declare const TWITTER_REGEX_GLOBAL: RegExp;
+export declare const TWITTER_REGEX: RegExp;
+export declare function isValidTwitterUrl(url: string): RegExpMatchArray | null;
+declare function NodeViewTweet({ node }: {
+    node: Partial<ReactNodeViewRendererOptions>;
+}): import("react/jsx-runtime").JSX.Element | null;
+export default NodeViewTweet;

package/lib/extensions/Twitter/components/RichTextTwitter.d.ts

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

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

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

package/lib/extensions/Video/Video.d.ts

@@ -0,0 +1,66 @@
+import { Node } from '@tiptap/core';
+import { GeneralOptions, VideoAlignment } from '../../types';
+export * from './components/RichTextVideo';
+/**
+ * Represents the interface for video options, extending GeneralOptions.
+ */
+export interface VideoOptions extends GeneralOptions<VideoOptions> {
+    /**
+     * Indicates whether fullscreen play is allowed
+     *
+     * @default true
+     */
+    allowFullscreen: boolean;
+    /**
+     * Indicates whether to display the frameborder
+     *
+     * @default false
+     */
+    frameborder: boolean;
+    /**
+     * Width of the video, can be a number or string
+     *
+     * @default VIDEO_SIZE['size-medium']
+     */
+    width: number | string;
+    /** HTML attributes object for passing additional attributes */
+    HTMLAttributes: {
+        [key: string]: any;
+    };
+    /** Function for uploading files */
+    upload?: (file: File) => Promise<string>;
+    /** The source URL of the video */
+    resourceVideo: 'upload' | 'link' | 'both';
+    /**
+     * List of allowed video hosting providers
+     * Use ['.'] to allow any URL, or specify providers like ['youtube', 'vimeo']
+     *
+     * @default ['.']
+     */
+    videoProviders?: string[];
+}
+/**
+ * Represents the type for setting video options
+ */
+interface SetVideoOptions {
+    /** The source URL of the video */
+    src: string;
+    /** The width of the video */
+    width: string | number;
+    align: VideoAlignment;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        video: {
+            /**
+             * Add an video
+             */
+            setVideo: (options: Partial<SetVideoOptions>) => ReturnType;
+            /**
+             * Update an video
+             */
+            updateVideo: (options: Partial<SetVideoOptions>) => ReturnType;
+        };
+    }
+}
+export declare const Video: Node<VideoOptions, any>;

package/lib/extensions/Video/components/RichTextVideo.d.ts

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

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

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

package/lib/extensions/Video/store.d.ts

@@ -0,0 +1,4 @@
+export declare function useDialogVideo(): boolean;
+export declare const actionDialogVideo: {
+    setOpen: (id: any, value: boolean) => void;
+};

package/lib/hooks/useActive.d.ts

@@ -0,0 +1,21 @@
+export declare function useActive(isActive?: () => boolean): {
+    disabled: boolean;
+    dataState: any;
+    editorDisabled: boolean;
+};
+/**
+ * export type Mark =
+  | "bold"
+  | "italic"
+  | "strike"
+  | "code"
+  | "underline"
+  | "superscript"
+  | "subscript"
+ */
+export declare function useToggleActive(isActive?: () => boolean): {
+    disabled: boolean;
+    dataState: boolean;
+    editorDisabled: boolean;
+    update: () => void;
+};

package/lib/hooks/useAttributes.d.ts

@@ -0,0 +1,2 @@
+import { Editor } from '@tiptap/core';
+export declare function useAttributes<T, R = T>(editor: Editor, attrbute: string, defaultValue?: T, map?: (arg: T) => R): R;

package/lib/hooks/useButtonProps.d.ts

@@ -0,0 +1 @@
+export declare function useButtonProps(extensionName: string): any;

package/lib/hooks/useCopy.d.ts

@@ -0,0 +1,5 @@
+declare function useCopy(): {
+    isCopied: boolean;
+    copyToClipboard: (text: string) => Promise<void>;
+};
+export default useCopy;

package/lib/hooks/useExtension.d.ts

@@ -0,0 +1 @@
+export declare function useExtension(extensionName: string): import('@tiptap/core').AnyExtension | null | undefined;

package/lib/hooks/useLocalStorage.d.ts

@@ -0,0 +1,13 @@
+import { Dispatch, SetStateAction } from 'react';
+declare global {
+    interface WindowEventMap {
+        'local-storage': CustomEvent;
+    }
+}
+type UseLocalStorageOptions<T> = {
+    serializer?: (value: T) => string;
+    deserializer?: (value: string) => T;
+    initializeWithValue?: boolean;
+};
+export declare function useLocalStorage<T>(key: string, initialValue: T | (() => T), options?: UseLocalStorageOptions<T>): [T, Dispatch<SetStateAction<T>>, () => void];
+export {};