@tiptap/react 2.0.0-beta.11 → 2.0.0-beta.114

package/LICENSE.md

@@ -1,6 +1,6 @@
 MIT License
 
-Copyright (c) 2020, überdosis GbR
+Copyright (c) 2021, überdosis GbR
 
 Permission is hereby granted, free of charge, to any person obtaining a copy
 of this software and associated documentation files (the "Software"), to deal

package/README.md

@@ -7,8 +7,8 @@
 ## Introduction
 tiptap is a headless wrapper around [ProseMirror](https://ProseMirror.net) – a toolkit for building rich text WYSIWYG editors, which is already in use at many well-known companies such as *New York Times*, *The Guardian* or *Atlassian*.
 
-## Offical Documentation
+## Official Documentation
 Documentation can be found on the [tiptap website](https://tiptap.dev).
 
 ## License
-tiptap is open-sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap-next/blob/main/LICENSE.md).
+tiptap is open sourced software licensed under the [MIT license](https://github.com/ueberdosis/tiptap/blob/main/LICENSE.md).

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

@@ -1,6 +1,9 @@
-import React from 'react';
 import { BubbleMenuPluginProps } from '@tiptap/extension-bubble-menu';
-export declare type BubbleMenuProps = Omit<BubbleMenuPluginProps, 'element'> & {
+import React from 'react';
+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;
+    children: React.ReactNode;
 };
-export declare const BubbleMenu: React.FC<BubbleMenuProps>;
+export declare const BubbleMenu: (props: BubbleMenuProps) => JSX.Element;
+export {};

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

@@ -1,5 +1,5 @@
-import React from 'react';
 import { Editor as CoreEditor } from '@tiptap/core';
+import React from 'react';
 import { EditorContentProps, EditorContentState } from './EditorContent';
 export declare class Editor extends CoreEditor {
     contentComponent: React.Component<EditorContentProps, EditorContentState> | null;

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

@@ -1,6 +1,9 @@
-import React from 'react';
 import { FloatingMenuPluginProps } from '@tiptap/extension-floating-menu';
-export declare type FloatingMenuProps = Omit<FloatingMenuPluginProps, 'element'> & {
+import React from 'react';
+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;
+    children: React.ReactNode;
 };
-export declare const FloatingMenu: React.FC<FloatingMenuProps>;
+export declare const FloatingMenu: (props: FloatingMenuProps) => JSX.Element;
+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,15 @@
-import { NodeViewRenderer } from '@tiptap/core';
-import { Decoration } from 'prosemirror-view';
+import { NodeViewRenderer, NodeViewRendererOptions } from '@tiptap/core';
 import { Node as ProseMirrorNode } from 'prosemirror-model';
-interface ReactNodeViewRendererOptions {
-    stopEvent: ((event: Event) => boolean) | null;
-    update: ((node: ProseMirrorNode, decorations: Decoration[]) => boolean) | null;
+import { Decoration } from 'prosemirror-view';
+export interface ReactNodeViewRendererOptions extends NodeViewRendererOptions {
+    update: ((props: {
+        oldNode: ProseMirrorNode;
+        oldDecorations: Decoration[];
+        newNode: ProseMirrorNode;
+        newDecorations: Decoration[];
+        updateProps: () => void;
+    }) => boolean) | null;
+    as?: string;
+    className?: string;
 }
 export declare function ReactNodeViewRenderer(component: any, options?: Partial<ReactNodeViewRendererOptions>): NodeViewRenderer;
-export {};

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

@@ -1,21 +1,24 @@
+import { Editor } from '@tiptap/core';
 import React from 'react';
-import { AnyObject } from '@tiptap/core';
-import { Editor } from './Editor';
+import { Editor as ExtendedEditor } from './Editor';
 export interface ReactRendererOptions {
-    as?: string;
     editor: Editor;
-    props?: AnyObject;
+    props?: Record<string, any>;
+    as?: string;
+    className?: string;
 }
-export declare class ReactRenderer {
+declare type ComponentType<R, P> = React.ComponentClass<P> | React.FunctionComponent<P> | React.ForwardRefExoticComponent<React.PropsWithoutRef<P> & React.RefAttributes<R>>;
+export declare class ReactRenderer<R = unknown, P = 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, P>, { editor, props, as, className, }: 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,10 +1,10 @@
-export * from '@tiptap/core';
 export * from './BubbleMenu';
 export { Editor } from './Editor';
-export * from './FloatingMenu';
-export * from './useEditor';
-export * from './ReactRenderer';
-export * from './ReactNodeViewRenderer';
 export * from './EditorContent';
-export * from './NodeViewWrapper';
+export * from './FloatingMenu';
 export * from './NodeViewContent';
+export * from './NodeViewWrapper';
+export * from './ReactNodeViewRenderer';
+export * from './ReactRenderer';
+export * from './useEditor';
+export * from '@tiptap/core';

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

@@ -1,3 +1,4 @@
 import { EditorOptions } from '@tiptap/core';
+import { DependencyList } from 'react';
 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>;