@tiptap/react 3.0.0-next.3 → 3.0.0-next.5

package/dist/index.d.ts

@@ -1,26 +1,11 @@
-import { BubbleMenuPluginProps } from '@tiptap/extension-bubble-menu';
-import * as React from 'react';
-import React__default, { DependencyList, ReactNode, HTMLAttributes, HTMLProps, ForwardedRef, ComponentType as ComponentType$1 } from 'react';
-import { EditorOptions, Editor, NodeViewRendererOptions, NodeViewProps, NodeView, NodeViewRenderer } from '@tiptap/core';
+import * as react_jsx_runtime_js from 'react/jsx-runtime.js';
+import { EditorOptions, Editor, MarkViewRendererOptions, MarkView, MarkViewProps, MarkViewRenderer, NodeViewRendererOptions, NodeViewProps, NodeView, NodeViewRenderer } from '@tiptap/core';
 export * from '@tiptap/core';
-import { FloatingMenuPluginProps } from '@tiptap/extension-floating-menu';
+import * as React from 'react';
+import React__default, { DependencyList, ReactNode, HTMLAttributes, HTMLProps, ForwardedRef, ComponentProps, ComponentType as ComponentType$1 } from 'react';
 import { Node } from '@tiptap/pm/model';
 import { Decoration, DecorationSource } from '@tiptap/pm/view';
 
-type Optional$1<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
-type BubbleMenuProps = Omit<Optional$1<BubbleMenuPluginProps, 'pluginKey'>, 'element' | 'editor'> & {
-    editor: BubbleMenuPluginProps['editor'] | null;
-    updateDelay?: number;
-    resizeDelay?: number;
-    options?: BubbleMenuPluginProps['options'];
-} & React__default.HTMLAttributes<HTMLDivElement>;
-declare const BubbleMenu: React__default.ForwardRefExoticComponent<Omit<Optional$1<BubbleMenuPluginProps, "pluginKey">, "editor" | "element"> & {
-    editor: BubbleMenuPluginProps["editor"] | null;
-    updateDelay?: number;
-    resizeDelay?: number;
-    options?: BubbleMenuPluginProps["options"];
-} & React__default.HTMLAttributes<HTMLDivElement> & React__default.RefAttributes<HTMLDivElement>>;
-
 /**
  * The options for the `useEditor` hook.
  */
@@ -78,7 +63,7 @@ type EditorProviderProps = {
  * It allows the editor to be accessible across the entire component tree
  * with `useCurrentEditor`.
  */
-declare function EditorProvider({ children, slotAfter, slotBefore, editorContainerProps, ...editorOptions }: EditorProviderProps): React__default.JSX.Element | null;
+declare function EditorProvider({ children, slotAfter, slotBefore, editorContainerProps, ...editorOptions }: EditorProviderProps): react_jsx_runtime_js.JSX.Element | null;
 
 interface EditorContentProps extends HTMLProps<HTMLDivElement> {
     editor: Editor | null;
@@ -95,25 +80,14 @@ declare class PureEditorContent extends React__default.Component<EditorContentPr
     componentDidUpdate(): void;
     init(): void;
     componentWillUnmount(): void;
-    render(): React__default.JSX.Element;
+    render(): react_jsx_runtime_js.JSX.Element;
 }
 declare const EditorContent: React__default.MemoExoticComponent<React__default.ForwardRefExoticComponent<Omit<EditorContentProps, "ref"> & React__default.RefAttributes<HTMLDivElement>>>;
 
-type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>;
-type FloatingMenuProps = Omit<Optional<FloatingMenuPluginProps, 'pluginKey'>, 'element' | 'editor'> & {
-    editor: FloatingMenuPluginProps['editor'] | null;
-    options?: FloatingMenuPluginProps['options'];
-} & React__default.HTMLAttributes<HTMLDivElement>;
-declare const FloatingMenu: React__default.ForwardRefExoticComponent<Omit<Optional<FloatingMenuPluginProps, "pluginKey">, "editor" | "element"> & {
-    editor: FloatingMenuPluginProps["editor"] | null;
-    options?: FloatingMenuPluginProps["options"];
-} & React__default.HTMLAttributes<HTMLDivElement> & React__default.RefAttributes<HTMLDivElement>>;
-
-interface NodeViewContentProps {
-    [key: string]: any;
-    as?: React__default.ElementType;
-}
-declare const NodeViewContent: React__default.FC<NodeViewContentProps>;
+type NodeViewContentProps<T extends keyof React__default.JSX.IntrinsicElements = 'div'> = {
+    as?: NoInfer<T>;
+} & ComponentProps<T>;
+declare function NodeViewContent<T extends keyof React__default.JSX.IntrinsicElements = 'div'>({ as: Tag, ...props }: NodeViewContentProps<T>): react_jsx_runtime_js.JSX.Element;
 
 interface NodeViewWrapperProps {
     [key: string]: any;
@@ -158,8 +132,8 @@ type ComponentType<R, P> = React__default.ComponentClass<P> | React__default.Fun
  *   },
  *   as: 'span',
  * })
-*/
-declare class ReactRenderer<R = unknown, P extends Record<string, any> = {}> {
+ */
+declare class ReactRenderer<R = unknown, P extends Record<string, any> = object> {
     id: string;
     editor: Editor;
     component: any;
@@ -170,7 +144,7 @@ declare class ReactRenderer<R = unknown, P extends Record<string, any> = {}> {
     /**
      * Immediately creates element and renders the provided React component.
      */
-    constructor(component: ComponentType<R, P>, { editor, props, as, className, }: ReactRendererOptions);
+    constructor(component: ComponentType<R, P>, { editor, props, as, className }: ReactRendererOptions);
     /**
      * Render the React component.
      */
@@ -189,6 +163,34 @@ declare class ReactRenderer<R = unknown, P extends Record<string, any> = {}> {
     updateAttributes(attributes: Record<string, string>): void;
 }
 
+interface MarkViewContextProps {
+    markViewContentRef: (element: HTMLElement | null) => void;
+}
+declare const ReactMarkViewContext: React__default.Context<MarkViewContextProps>;
+type MarkViewContentProps<T extends keyof React__default.JSX.IntrinsicElements = 'span'> = {
+    as?: NoInfer<T>;
+} & React__default.ComponentProps<T>;
+declare const MarkViewContent: React__default.FC<MarkViewContentProps>;
+interface ReactMarkViewRendererOptions extends MarkViewRendererOptions {
+    /**
+     * The tag name of the element wrapping the React component.
+     */
+    as?: string;
+    className?: string;
+    attrs?: {
+        [key: string]: string;
+    };
+}
+declare class ReactMarkView extends MarkView<React__default.ComponentType<MarkViewProps>, ReactMarkViewRendererOptions> {
+    renderer: ReactRenderer;
+    contentDOMElement: HTMLElement | null;
+    didMountContentDomElement: boolean;
+    constructor(component: React__default.ComponentType<MarkViewProps>, props: MarkViewProps, options?: Partial<ReactMarkViewRendererOptions>);
+    get dom(): HTMLElement;
+    get contentDOM(): HTMLElement | null;
+}
+declare function ReactMarkViewRenderer(component: React__default.ComponentType<MarkViewProps>, options?: Partial<ReactMarkViewRendererOptions>): MarkViewRenderer;
+
 interface ReactNodeViewRendererOptions extends NodeViewRendererOptions {
     /**
      * This function is called when the node view is updated.
@@ -325,10 +327,19 @@ declare function useEditorState<TSelectorResult>(options: UseEditorStateOptions<
 declare function useEditorState<TSelectorResult>(options: UseEditorStateOptions<TSelectorResult, Editor | null>): TSelectorResult | null;
 
 interface ReactNodeViewContextProps {
-    onDragStart: (event: DragEvent) => void;
-    nodeViewContentRef: (element: HTMLElement | null) => void;
+    onDragStart?: (event: DragEvent) => void;
+    nodeViewContentRef?: (element: HTMLElement | null) => void;
+    /**
+     * This allows you to add children into the NodeViewContent component.
+     * This is useful when statically rendering the content of a node view.
+     */
+    nodeViewContentChildren?: ReactNode;
 }
-declare const ReactNodeViewContext: React.Context<Partial<ReactNodeViewContextProps>>;
-declare const useReactNodeView: () => Partial<ReactNodeViewContextProps>;
+declare const ReactNodeViewContext: React.Context<ReactNodeViewContextProps>;
+declare const ReactNodeViewContentProvider: ({ children, content }: {
+    children: ReactNode;
+    content: ReactNode;
+}) => React.FunctionComponentElement<React.ProviderProps<ReactNodeViewContextProps>>;
+declare const useReactNodeView: () => ReactNodeViewContextProps;
 
-export { BubbleMenu, type BubbleMenuProps, EditorConsumer, EditorContent, type EditorContentProps, EditorContext, type EditorContextValue, EditorProvider, type EditorProviderProps, type EditorStateSnapshot, FloatingMenu, type FloatingMenuProps, NodeViewContent, type NodeViewContentProps, NodeViewWrapper, type NodeViewWrapperProps, PureEditorContent, ReactNodeView, ReactNodeViewContext, type ReactNodeViewContextProps, ReactNodeViewRenderer, type ReactNodeViewRendererOptions, ReactRenderer, type ReactRendererOptions, type UseEditorOptions, type UseEditorStateOptions, useCurrentEditor, useEditor, useEditorState, useReactNodeView };
+export { EditorConsumer, EditorContent, type EditorContentProps, EditorContext, type EditorContextValue, EditorProvider, type EditorProviderProps, type EditorStateSnapshot, MarkViewContent, type MarkViewContentProps, type MarkViewContextProps, NodeViewContent, type NodeViewContentProps, NodeViewWrapper, type NodeViewWrapperProps, PureEditorContent, ReactMarkView, ReactMarkViewContext, ReactMarkViewRenderer, type ReactMarkViewRendererOptions, ReactNodeView, ReactNodeViewContentProvider, ReactNodeViewContext, type ReactNodeViewContextProps, ReactNodeViewRenderer, type ReactNodeViewRendererOptions, ReactRenderer, type ReactRendererOptions, type UseEditorOptions, type UseEditorStateOptions, useCurrentEditor, useEditor, useEditorState, useReactNodeView };