@tiptap/react 2.0.0-beta.8 → 2.0.0-beta.83

package/dist/packages/extension-table/src/utilities/isCellSelection.d.ts

@@ -0,0 +1,2 @@
+import { CellSelection } from 'prosemirror-tables';
+export declare function isCellSelection(value: unknown): value is CellSelection;

package/dist/packages/extension-table-cell/src/index.d.ts

@@ -0,0 +1,3 @@
+import { TableCell } from './table-cell';
+export * from './table-cell';
+export default TableCell;

package/dist/packages/extension-table-cell/src/table-cell.d.ts

@@ -0,0 +1,5 @@
+import { Node } from '@tiptap/core';
+export interface TableCellOptions {
+    HTMLAttributes: Record<string, any>;
+}
+export declare const TableCell: Node<TableCellOptions>;

package/dist/packages/extension-table-header/src/index.d.ts

@@ -0,0 +1,3 @@
+import { TableHeader } from './table-header';
+export * from './table-header';
+export default TableHeader;

package/dist/packages/extension-table-header/src/table-header.d.ts

@@ -0,0 +1,5 @@
+import { Node } from '@tiptap/core';
+export interface TableHeaderOptions {
+    HTMLAttributes: Record<string, any>;
+}
+export declare const TableHeader: Node<TableHeaderOptions>;

package/dist/packages/extension-table-row/src/index.d.ts

@@ -0,0 +1,3 @@
+import { TableRow } from './table-row';
+export * from './table-row';
+export default TableRow;

package/dist/packages/extension-table-row/src/table-row.d.ts

@@ -0,0 +1,5 @@
+import { Node } from '@tiptap/core';
+export interface TableRowOptions {
+    HTMLAttributes: Record<string, any>;
+}
+export declare const TableRow: Node<TableRowOptions>;

package/dist/packages/extension-task-item/src/index.d.ts

@@ -0,0 +1,3 @@
+import { TaskItem } from './task-item';
+export * from './task-item';
+export default TaskItem;

package/dist/packages/extension-task-item/src/task-item.d.ts

@@ -0,0 +1,7 @@
+import { Node } from '@tiptap/core';
+export interface TaskItemOptions {
+    nested: boolean;
+    HTMLAttributes: Record<string, any>;
+}
+export declare const inputRegex: RegExp;
+export declare const TaskItem: Node<TaskItemOptions>;

package/dist/packages/extension-task-list/src/index.d.ts

@@ -0,0 +1,3 @@
+import { TaskList } from './task-list';
+export * from './task-list';
+export default TaskList;

package/dist/packages/extension-task-list/src/task-list.d.ts

@@ -0,0 +1,15 @@
+import { Node } from '@tiptap/core';
+export interface TaskListOptions {
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        taskList: {
+            /**
+             * Toggle a task list
+             */
+            toggleTaskList: () => ReturnType;
+        };
+    }
+}
+export declare const TaskList: Node<TaskListOptions>;

package/dist/packages/extension-text/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Text } from './text';
+export * from './text';
+export default Text;

package/dist/packages/extension-text/src/text.d.ts

@@ -0,0 +1,2 @@
+import { Node } from '@tiptap/core';
+export declare const Text: Node<unknown>;

package/dist/packages/extension-text-align/src/index.d.ts

@@ -0,0 +1,3 @@
+import { TextAlign } from './text-align';
+export * from './text-align';
+export default TextAlign;

package/dist/packages/extension-text-align/src/text-align.d.ts

@@ -0,0 +1,21 @@
+import { Extension } from '@tiptap/core';
+export interface TextAlignOptions {
+    types: string[];
+    alignments: string[];
+    defaultAlignment: string;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        textAlign: {
+            /**
+             * Set the text align attribute
+             */
+            setTextAlign: (alignment: string) => ReturnType;
+            /**
+             * Unset the text align attribute
+             */
+            unsetTextAlign: () => ReturnType;
+        };
+    }
+}
+export declare const TextAlign: Extension<TextAlignOptions>;

package/dist/packages/extension-text-style/src/index.d.ts

@@ -0,0 +1,3 @@
+import { TextStyle } from './text-style';
+export * from './text-style';
+export default TextStyle;

package/dist/packages/extension-text-style/src/text-style.d.ts

@@ -0,0 +1,15 @@
+import { Mark } from '@tiptap/core';
+export interface TextStyleOptions {
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        textStyle: {
+            /**
+             * Remove spans without inline style attributes.
+             */
+            removeEmptyTextStyle: () => ReturnType;
+        };
+    }
+}
+export declare const TextStyle: Mark<TextStyleOptions>;

package/dist/packages/extension-typography/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Typography } from './typography';
+export * from './typography';
+export default Typography;

package/dist/packages/extension-typography/src/typography.d.ts

@@ -0,0 +1,23 @@
+import { Extension } from '@tiptap/core';
+export declare const emDash: import("@tiptap/core").InputRule;
+export declare const ellipsis: import("@tiptap/core").InputRule;
+export declare const openDoubleQuote: import("@tiptap/core").InputRule;
+export declare const closeDoubleQuote: import("@tiptap/core").InputRule;
+export declare const openSingleQuote: import("@tiptap/core").InputRule;
+export declare const closeSingleQuote: import("@tiptap/core").InputRule;
+export declare const leftArrow: import("@tiptap/core").InputRule;
+export declare const rightArrow: import("@tiptap/core").InputRule;
+export declare const copyright: import("@tiptap/core").InputRule;
+export declare const trademark: import("@tiptap/core").InputRule;
+export declare const registeredTrademark: import("@tiptap/core").InputRule;
+export declare const oneHalf: import("@tiptap/core").InputRule;
+export declare const plusMinus: import("@tiptap/core").InputRule;
+export declare const notEqual: import("@tiptap/core").InputRule;
+export declare const laquo: import("@tiptap/core").InputRule;
+export declare const raquo: import("@tiptap/core").InputRule;
+export declare const multiplication: import("@tiptap/core").InputRule;
+export declare const superscriptTwo: import("@tiptap/core").InputRule;
+export declare const superscriptThree: import("@tiptap/core").InputRule;
+export declare const oneQuarter: import("@tiptap/core").InputRule;
+export declare const threeQuarters: import("@tiptap/core").InputRule;
+export declare const Typography: Extension<unknown>;

package/dist/packages/extension-underline/src/index.d.ts

@@ -0,0 +1,3 @@
+import { Underline } from './underline';
+export * from './underline';
+export default Underline;

package/dist/packages/extension-underline/src/underline.d.ts

@@ -0,0 +1,23 @@
+import { Mark } from '@tiptap/core';
+export interface UnderlineOptions {
+    HTMLAttributes: Record<string, any>;
+}
+declare module '@tiptap/core' {
+    interface Commands<ReturnType> {
+        underline: {
+            /**
+             * Set an underline mark
+             */
+            setUnderline: () => ReturnType;
+            /**
+             * Toggle an underline mark
+             */
+            toggleUnderline: () => ReturnType;
+            /**
+             * Unset an underline mark
+             */
+            unsetUnderline: () => ReturnType;
+        };
+    }
+}
+export declare const Underline: Mark<UnderlineOptions>;

package/dist/packages/html/src/generateHTML.d.ts

@@ -0,0 +1,2 @@
+import { Extensions, JSONContent } from '@tiptap/core';
+export default function generateHTML(doc: JSONContent, extensions: Extensions): string;

package/dist/packages/html/src/generateJSON.d.ts

@@ -0,0 +1,2 @@
+import { Extensions } from '@tiptap/core';
+export default function generateJSON(html: string, extensions: Extensions): Record<string, any>;

package/dist/packages/html/src/getHTMLFromFragment.d.ts

@@ -0,0 +1,2 @@
+import { Node, Schema } from 'prosemirror-model';
+export default function getHTMLFromFragment(doc: Node, schema: Schema): string;

package/dist/packages/html/src/index.d.ts

@@ -0,0 +1,2 @@
+export { default as generateHTML } from './generateHTML';
+export { default as generateJSON } from './generateJSON';

package/dist/packages/react/src/BubbleMenu.d.ts

@@ -1,6 +1,8 @@
 import React from 'react';
 import { BubbleMenuPluginProps } from '@tiptap/extension-bubble-menu';
-export declare type BubbleMenuProps = Omit<BubbleMenuPluginProps, 'element'> & {
+declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
+export declare type BubbleMenuProps = Omit<Optional<BubbleMenuPluginProps, 'pluginKey'>, 'element'> & {
     className?: string;
 };
 export declare const BubbleMenu: React.FC<BubbleMenuProps>;
+export {};

package/dist/packages/react/src/EditorContent.d.ts

@@ -1,7 +1,7 @@
-import React from 'react';
+import React, { HTMLProps } from 'react';
 import { Editor } from './Editor';
 import { ReactRenderer } from './ReactRenderer';
-export interface EditorContentProps {
+export interface EditorContentProps extends HTMLProps<HTMLDivElement> {
     editor: Editor | null;
 }
 export interface EditorContentState {

package/dist/packages/react/src/FloatingMenu.d.ts

@@ -0,0 +1,8 @@
+import React from 'react';
+import { FloatingMenuPluginProps } from '@tiptap/extension-floating-menu';
+declare type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
+export declare type FloatingMenuProps = Omit<Optional<FloatingMenuPluginProps, 'pluginKey'>, 'element'> & {
+    className?: string;
+};
+export declare const FloatingMenu: React.FC<FloatingMenuProps>;
+export {};

package/dist/packages/react/src/NodeViewContent.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 export interface NodeViewContentProps {
-    className?: string;
-    as: React.ElementType;
+    [key: string]: any;
+    as?: React.ElementType;
 }
 export declare const NodeViewContent: React.FC<NodeViewContentProps>;

package/dist/packages/react/src/NodeViewWrapper.d.ts

@@ -1,6 +1,6 @@
 import React from 'react';
 export interface NodeViewWrapperProps {
-    className?: string;
-    as: React.ElementType;
+    [key: string]: any;
+    as?: React.ElementType;
 }
 export declare const NodeViewWrapper: React.FC<NodeViewWrapperProps>;

package/dist/packages/react/src/ReactNodeViewRenderer.d.ts

@@ -1,9 +1,13 @@
-import { NodeViewRenderer } from '@tiptap/core';
+import { NodeViewRenderer, NodeViewRendererOptions } from '@tiptap/core';
 import { Decoration } from 'prosemirror-view';
 import { Node as ProseMirrorNode } from 'prosemirror-model';
-interface ReactNodeViewRendererOptions {
-    stopEvent: ((event: Event) => boolean) | null;
-    update: ((node: ProseMirrorNode, decorations: Decoration[]) => boolean) | null;
+export interface ReactNodeViewRendererOptions extends NodeViewRendererOptions {
+    update: ((props: {
+        oldNode: ProseMirrorNode;
+        oldDecorations: Decoration[];
+        newNode: ProseMirrorNode;
+        newDecorations: Decoration[];
+        updateProps: () => void;
+    }) => boolean) | null;
 }
 export declare function ReactNodeViewRenderer(component: any, options?: Partial<ReactNodeViewRendererOptions>): NodeViewRenderer;
-export {};

package/dist/packages/react/src/ReactRenderer.d.ts

@@ -1,21 +1,26 @@
 import React from 'react';
-import { AnyObject } from '@tiptap/core';
-import { Editor } from './Editor';
+import { Editor } from '@tiptap/core';
+import { Editor as ExtendedEditor } from './Editor';
 export interface ReactRendererOptions {
-    as?: string;
     editor: Editor;
-    props?: AnyObject;
+    props?: Record<string, any>;
+    as?: string;
 }
-export declare class ReactRenderer {
+declare type ComponentType<R> = React.ComponentClass | React.FunctionComponent | React.ForwardRefExoticComponent<{
+    items: any[];
+    command: any;
+} & React.RefAttributes<R>>;
+export declare class ReactRenderer<R = unknown> {
     id: string;
-    editor: Editor;
+    editor: ExtendedEditor;
     component: any;
     element: Element;
-    props: AnyObject;
+    props: Record<string, any>;
     reactElement: React.ReactNode;
-    ref: React.Component | null;
-    constructor(component: React.Component | React.FunctionComponent, { props, editor }: ReactRendererOptions);
+    ref: R | null;
+    constructor(component: ComponentType<R>, { editor, props, as }: ReactRendererOptions);
     render(): void;
-    updateProps(props?: AnyObject): void;
+    updateProps(props?: Record<string, any>): void;
     destroy(): void;
 }
+export {};

package/dist/packages/react/src/index.d.ts

@@ -1,6 +1,7 @@
 export * from '@tiptap/core';
 export * from './BubbleMenu';
 export { Editor } from './Editor';
+export * from './FloatingMenu';
 export * from './useEditor';
 export * from './ReactRenderer';
 export * from './ReactNodeViewRenderer';

package/dist/packages/react/src/useEditor.d.ts

@@ -1,3 +1,4 @@
+import { DependencyList } from 'react';
 import { EditorOptions } from '@tiptap/core';
 import { Editor } from './Editor';
-export declare const useEditor: (options?: Partial<EditorOptions>) => Editor | null;
+export declare const useEditor: (options?: Partial<EditorOptions>, deps?: DependencyList) => Editor | null;

package/dist/packages/react/src/useReactNodeView.d.ts

@@ -1,7 +1,7 @@
 /// <reference types="react" />
 export interface ReactNodeViewContextProps {
-    isEditable: boolean;
     onDragStart: (event: DragEvent) => void;
+    nodeViewContentRef: (element: HTMLElement | null) => void;
 }
 export declare const ReactNodeViewContext: import("react").Context<Partial<ReactNodeViewContextProps>>;
 export declare const useReactNodeView: () => Partial<ReactNodeViewContextProps>;

package/dist/packages/starter-kit/src/index.d.ts

@@ -0,0 +1,3 @@
+import { StarterKit } from './starter-kit';
+export type { StarterKitOptions } from './starter-kit';
+export default StarterKit;

package/dist/packages/starter-kit/src/starter-kit.d.ts

@@ -0,0 +1,37 @@
+import { Extension } from '@tiptap/core';
+import { BlockquoteOptions } from '@tiptap/extension-blockquote';
+import { BoldOptions } from '@tiptap/extension-bold';
+import { BulletListOptions } from '@tiptap/extension-bullet-list';
+import { CodeOptions } from '@tiptap/extension-code';
+import { CodeBlockOptions } from '@tiptap/extension-code-block';
+import { DropcursorOptions } from '@tiptap/extension-dropcursor';
+import { HardBreakOptions } from '@tiptap/extension-hard-break';
+import { HeadingOptions } from '@tiptap/extension-heading';
+import { HistoryOptions } from '@tiptap/extension-history';
+import { HorizontalRuleOptions } from '@tiptap/extension-horizontal-rule';
+import { ItalicOptions } from '@tiptap/extension-italic';
+import { ListItemOptions } from '@tiptap/extension-list-item';
+import { OrderedListOptions } from '@tiptap/extension-ordered-list';
+import { ParagraphOptions } from '@tiptap/extension-paragraph';
+import { StrikeOptions } from '@tiptap/extension-strike';
+export interface StarterKitOptions {
+    blockquote: Partial<BlockquoteOptions> | false;
+    bold: Partial<BoldOptions> | false;
+    bulletList: Partial<BulletListOptions> | false;
+    code: Partial<CodeOptions> | false;
+    codeBlock: Partial<CodeBlockOptions> | false;
+    document: false;
+    dropcursor: Partial<DropcursorOptions> | false;
+    gapcursor: false;
+    hardBreak: Partial<HardBreakOptions> | false;
+    heading: Partial<HeadingOptions> | false;
+    history: Partial<HistoryOptions> | false;
+    horizontalRule: Partial<HorizontalRuleOptions> | false;
+    italic: Partial<ItalicOptions> | false;
+    listItem: Partial<ListItemOptions> | false;
+    orderedList: Partial<OrderedListOptions> | false;
+    paragraph: Partial<ParagraphOptions> | false;
+    strike: Partial<StrikeOptions> | false;
+    text: false;
+}
+export declare const StarterKit: Extension<StarterKitOptions>;

package/dist/packages/suggestion/src/findSuggestionMatch.d.ts

@@ -0,0 +1,15 @@
+import { Range } from '@tiptap/core';
+import { ResolvedPos } from 'prosemirror-model';
+export interface Trigger {
+    char: string;
+    allowSpaces: boolean;
+    prefixSpace: boolean;
+    startOfLine: boolean;
+    $position: ResolvedPos;
+}
+export declare type SuggestionMatch = {
+    range: Range;
+    query: string;
+    text: string;
+} | null;
+export declare function findSuggestionMatch(config: Trigger): SuggestionMatch;

package/dist/packages/suggestion/src/index.d.ts

@@ -0,0 +1,4 @@
+import { Suggestion } from './suggestion';
+export * from './findSuggestionMatch';
+export * from './suggestion';
+export default Suggestion;

package/dist/packages/suggestion/src/suggestion.d.ts

@@ -0,0 +1,46 @@
+import { Editor, Range } from '@tiptap/core';
+import { Plugin, PluginKey } from 'prosemirror-state';
+import { EditorView } from 'prosemirror-view';
+export interface SuggestionOptions {
+    pluginKey?: PluginKey;
+    editor: Editor;
+    char?: string;
+    allowSpaces?: boolean;
+    startOfLine?: boolean;
+    prefixSpace?: boolean;
+    decorationTag?: string;
+    decorationClass?: string;
+    command?: (props: {
+        editor: Editor;
+        range: Range;
+        props: any;
+    }) => void;
+    items?: (query: string) => any[] | Promise<any[]>;
+    render?: () => {
+        onStart?: (props: SuggestionProps) => void;
+        onUpdate?: (props: SuggestionProps) => void;
+        onExit?: (props: SuggestionProps) => void;
+        onKeyDown?: (props: SuggestionKeyDownProps) => boolean;
+    };
+    allow?: (props: {
+        editor: Editor;
+        range: Range;
+    }) => boolean;
+}
+export interface SuggestionProps {
+    editor: Editor;
+    range: Range;
+    query: string;
+    text: string;
+    items: any[];
+    command: (props: any) => void;
+    decorationNode: Element | null;
+    clientRect: (() => DOMRect) | null;
+}
+export interface SuggestionKeyDownProps {
+    view: EditorView;
+    event: KeyboardEvent;
+    range: Range;
+}
+export declare const SuggestionPluginKey: PluginKey<any, any>;
+export declare function Suggestion({ pluginKey, editor, char, allowSpaces, prefixSpace, startOfLine, decorationTag, decorationClass, command, items, render, allow, }: SuggestionOptions): Plugin<any, any>;

package/dist/tests/cypress/integration/core/can.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/core/editorProps.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/core/extendExtensions.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/core/extendMarkRange.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/core/extensionOptions.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/core/fromString.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/core/generateHTML.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/core/generateJSON.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/core/isActive.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/core/isClass.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/core/mergeAttributes.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/core/mergeDeep.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/core/pluginOrder.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/extensions/bold.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/extensions/codeBlockLowlight.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/html/generateHTML.spec.d.ts

@@ -0,0 +1 @@
+export {};

package/dist/tests/cypress/integration/html/generateJSON.spec.d.ts

@@ -0,0 +1 @@
+export {};