@tiptap/react 2.0.0-beta.21 → 2.0.0-beta.211

package/src/EditorContent.tsx

@@ -1,12 +1,13 @@
-import React from 'react'
-import ReactDOM from 'react-dom'
+import React, { HTMLProps } from 'react'
+import ReactDOM, { flushSync } from 'react-dom'
+
 import { Editor } from './Editor'
 import { ReactRenderer } from './ReactRenderer'
 
-const Portals: React.FC<{ renderers: Map<string, ReactRenderer> }> = ({ renderers }) => {
+const Portals: React.FC<{ renderers: Record<string, ReactRenderer> }> = ({ renderers }) => {
   return (
     <>
-      {Array.from(renderers).map(([key, renderer]) => {
+      {Object.entries(renderers).map(([key, renderer]) => {
         return ReactDOM.createPortal(
           renderer.reactElement,
           renderer.element,
@@ -17,23 +18,26 @@ const Portals: React.FC<{ renderers: Map<string, ReactRenderer> }> = ({ renderer
   )
 }
 
-export interface EditorContentProps {
+export interface EditorContentProps extends HTMLProps<HTMLDivElement> {
   editor: Editor | null,
 }
 
 export interface EditorContentState {
-  renderers: Map<string, ReactRenderer>
+  renderers: Record<string, ReactRenderer>
 }
 
 export class PureEditorContent extends React.Component<EditorContentProps, EditorContentState> {
   editorContentRef: React.RefObject<any>
 
+  initialized: boolean
+
   constructor(props: EditorContentProps) {
     super(props)
     this.editorContentRef = React.createRef()
+    this.initialized = false
 
     this.state = {
-      renderers: new Map(),
+      renderers: {},
     }
   }
 
@@ -55,7 +59,7 @@ export class PureEditorContent extends React.Component<EditorContentProps, Edito
 
       const element = this.editorContentRef.current
 
-      element.appendChild(editor.options.element.firstChild)
+      element.append(...editor.options.element.childNodes)
 
       editor.setOptions({
         element,
@@ -63,11 +67,47 @@ export class PureEditorContent extends React.Component<EditorContentProps, Edito
 
       editor.contentComponent = this
 
-      // TODO: alternative to setTimeout?
-      setTimeout(() => editor.createNodeViews(), 0)
+      editor.createNodeViews()
+
+      this.initialized = true
+    }
+  }
+
+  maybeFlushSync(fn: () => void) {
+    // Avoid calling flushSync until the editor is initialized.
+    // Initialization happens during the componentDidMount or componentDidUpdate
+    // lifecycle methods, and React doesn't allow calling flushSync from inside
+    // a lifecycle method.
+    if (this.initialized) {
+      flushSync(fn)
+    } else {
+      fn()
     }
   }
 
+  setRenderer(id: string, renderer: ReactRenderer) {
+    this.maybeFlushSync(() => {
+      this.setState(({ renderers }) => ({
+        renderers: {
+          ...renderers,
+          [id]: renderer,
+        },
+      }))
+    })
+  }
+
+  removeRenderer(id: string) {
+    this.maybeFlushSync(() => {
+      this.setState(({ renderers }) => {
+        const nextRenderers = { ...renderers }
+
+        delete nextRenderers[id]
+
+        return { renderers: nextRenderers }
+      })
+    })
+  }
+
   componentWillUnmount() {
     const { editor } = this.props
 
@@ -89,7 +129,7 @@ export class PureEditorContent extends React.Component<EditorContentProps, Edito
 
     const newElement = document.createElement('div')
 
-    newElement.appendChild(editor.options.element.firstChild)
+    newElement.append(...editor.options.element.childNodes)
 
     editor.setOptions({
       element: newElement,
@@ -97,9 +137,12 @@ export class PureEditorContent extends React.Component<EditorContentProps, Edito
   }
 
   render() {
+    const { editor, ...rest } = this.props
+
     return (
       <>
-        <div ref={this.editorContentRef} />
+        <div ref={this.editorContentRef} {...rest} />
+        {/* @ts-ignore */}
         <Portals renderers={this.state.renderers} />
       </>
     )

package/src/FloatingMenu.tsx

@@ -1,29 +1,51 @@
-import React, { useEffect, useRef } from 'react'
-import { FloatingMenuPlugin, FloatingMenuPluginKey, FloatingMenuPluginProps } from '@tiptap/extension-floating-menu'
+import { FloatingMenuPlugin, FloatingMenuPluginProps } from '@tiptap/extension-floating-menu'
+import React, {
+  useEffect, useState,
+} from 'react'
 
-export type FloatingMenuProps = Omit<FloatingMenuPluginProps, 'element'> & {
+type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>
+
+export type FloatingMenuProps = Omit<Optional<FloatingMenuPluginProps, 'pluginKey'>, 'element'> & {
   className?: string,
+  children: React.ReactNode
 }
 
-export const FloatingMenu: React.FC<FloatingMenuProps> = props => {
-  const element = useRef<HTMLDivElement>(null)
+export const FloatingMenu = (props: FloatingMenuProps) => {
+  const [element, setElement] = useState<HTMLDivElement | null>(null)
 
   useEffect(() => {
-    const { editor, tippyOptions } = props
+    if (!element) {
+      return
+    }
+
+    if (props.editor.isDestroyed) {
+      return
+    }
 
-    editor.registerPlugin(FloatingMenuPlugin({
+    const {
+      pluginKey = 'floatingMenu',
       editor,
-      element: element.current as HTMLElement,
+      tippyOptions = {},
+      shouldShow = null,
+    } = props
+
+    const plugin = FloatingMenuPlugin({
+      pluginKey,
+      editor,
+      element,
       tippyOptions,
-    }))
+      shouldShow,
+    })
 
-    return () => {
-      editor.unregisterPlugin(FloatingMenuPluginKey)
-    }
-  }, [])
+    editor.registerPlugin(plugin)
+    return () => editor.unregisterPlugin(pluginKey)
+  }, [
+    props.editor,
+    element,
+  ])
 
   return (
-    <div ref={element} className={props.className} style={{ visibility: 'hidden' }}>
+    <div ref={setElement} className={props.className} style={{ visibility: 'hidden' }}>
       {props.children}
     </div>
   )

package/src/NodeViewContent.tsx

@@ -1,18 +1,25 @@
 import React from 'react'
 
+import { useReactNodeView } from './useReactNodeView'
+
 export interface NodeViewContentProps {
-  className?: string,
+  [key: string]: any,
   as?: React.ElementType,
 }
 
 export const NodeViewContent: React.FC<NodeViewContentProps> = props => {
   const Tag = props.as || 'div'
+  const { nodeViewContentRef } = useReactNodeView()
 
   return (
     <Tag
-      className={props.className}
+      {...props}
+      ref={nodeViewContentRef}
       data-node-view-content=""
-      style={{ whiteSpace: 'pre-wrap' }}
+      style={{
+        whiteSpace: 'pre-wrap',
+        ...props.style,
+      }}
     />
   )
 }

package/src/NodeViewWrapper.tsx

@@ -1,23 +1,26 @@
 import React from 'react'
+
 import { useReactNodeView } from './useReactNodeView'
 
 export interface NodeViewWrapperProps {
-  className?: string,
+  [key: string]: any,
   as?: React.ElementType,
 }
 
-export const NodeViewWrapper: React.FC<NodeViewWrapperProps> = props => {
+export const NodeViewWrapper: React.FC<NodeViewWrapperProps> = React.forwardRef((props, ref) => {
   const { onDragStart } = useReactNodeView()
   const Tag = props.as || 'div'
 
   return (
     <Tag
-      className={props.className}
+      {...props}
+      ref={ref}
       data-node-view-wrapper=""
       onDragStart={onDragStart}
-      style={{ whiteSpace: 'normal' }}
-    >
-     {props.children}
-    </Tag>
+      style={{
+        whiteSpace: 'normal',
+        ...props.style,
+      }}
+    />
   )
-}
+})

package/src/ReactNodeViewRenderer.tsx

@@ -1,26 +1,40 @@
-import React from 'react'
 import {
   NodeView,
   NodeViewProps,
   NodeViewRenderer,
+  NodeViewRendererOptions,
   NodeViewRendererProps,
 } from '@tiptap/core'
-import { Decoration, NodeView as ProseMirrorNodeView } from 'prosemirror-view'
-import { Node as ProseMirrorNode } from 'prosemirror-model'
+import { Node as ProseMirrorNode } from '@tiptap/pm/model'
+import { Decoration, NodeView as ProseMirrorNodeView } from '@tiptap/pm/view'
+import React from 'react'
+
 import { Editor } from './Editor'
 import { ReactRenderer } from './ReactRenderer'
-import { ReactNodeViewContext } from './useReactNodeView'
-
-interface ReactNodeViewRendererOptions {
-  stopEvent: ((event: Event) => boolean) | null,
-  update: ((node: ProseMirrorNode, decorations: Decoration[]) => boolean) | null,
+import { ReactNodeViewContext, ReactNodeViewContextProps } from './useReactNodeView'
+
+export interface ReactNodeViewRendererOptions extends NodeViewRendererOptions {
+  update:
+    | ((props: {
+        oldNode: ProseMirrorNode
+        oldDecorations: Decoration[]
+        newNode: ProseMirrorNode
+        newDecorations: Decoration[]
+        updateProps: () => void
+      }) => boolean)
+    | null
+  as?: string
+  className?: string
 }
 
-class ReactNodeView extends NodeView<React.FunctionComponent, Editor> {
-
+class ReactNodeView extends NodeView<
+  React.FunctionComponent,
+  Editor,
+  ReactNodeViewRendererOptions
+> {
   renderer!: ReactRenderer
 
-  contentDOMElement!: Element | null
+  contentDOMElement!: HTMLElement | null
 
   mount() {
     const props: NodeViewProps = {
@@ -31,6 +45,7 @@ class ReactNodeView extends NodeView<React.FunctionComponent, Editor> {
       extension: this.extension,
       getPos: () => this.getPos(),
       updateAttributes: (attributes = {}) => this.updateAttributes(attributes),
+      deleteNode: () => this.deleteNode(),
     }
 
     if (!(this.component as any).displayName) {
@@ -42,13 +57,22 @@ class ReactNodeView extends NodeView<React.FunctionComponent, Editor> {
     }
 
     const ReactNodeViewProvider: React.FunctionComponent = componentProps => {
-      const onDragStart = this.onDragStart.bind(this)
       const Component = this.component
+      const onDragStart = this.onDragStart.bind(this)
+      const nodeViewContentRef: ReactNodeViewContextProps['nodeViewContentRef'] = element => {
+        if (element && this.contentDOMElement && element.firstChild !== this.contentDOMElement) {
+          element.appendChild(this.contentDOMElement)
+        }
+      }
 
       return (
-        <ReactNodeViewContext.Provider value={{ onDragStart }}>
-          <Component {...componentProps} />
-        </ReactNodeViewContext.Provider>
+        <>
+          {/* @ts-ignore */}
+          <ReactNodeViewContext.Provider value={{ onDragStart, nodeViewContentRef }}>
+            {/* @ts-ignore */}
+            <Component {...componentProps} />
+          </ReactNodeViewContext.Provider>
+        </>
       )
     }
 
@@ -58,12 +82,26 @@ class ReactNodeView extends NodeView<React.FunctionComponent, Editor> {
       ? null
       : document.createElement(this.node.isInline ? 'span' : 'div')
 
+    if (this.contentDOMElement) {
+      // For some reason the whiteSpace prop is not inherited properly in Chrome and Safari
+      // With this fix it seems to work fine
+      // See: https://github.com/ueberdosis/tiptap/issues/1197
+      this.contentDOMElement.style.whiteSpace = 'inherit'
+    }
+
+    let as = this.node.isInline ? 'span' : 'div'
+
+    if (this.options.as) {
+      as = this.options.as
+    }
+
+    const { className = '' } = this.options
+
     this.renderer = new ReactRenderer(ReactNodeViewProvider, {
       editor: this.editor,
       props,
-      as: this.node.isInline
-        ? 'span'
-        : 'div',
+      as,
+      className: `node-${this.node.type.name} ${className}`.trim(),
     })
   }
 
@@ -75,7 +113,7 @@ class ReactNodeView extends NodeView<React.FunctionComponent, Editor> {
       throw Error('Please use the NodeViewWrapper component for your node view.')
     }
 
-    return this.renderer.element
+    return this.renderer.element as HTMLElement
   }
 
   get contentDOM() {
@@ -83,35 +121,42 @@ class ReactNodeView extends NodeView<React.FunctionComponent, Editor> {
       return null
     }
 
-    const contentElement = this.dom.querySelector('[data-node-view-content]')
-
-    if (
-      this.contentDOMElement
-      && contentElement
-      && !contentElement.contains(this.contentDOMElement)
-    ) {
-      contentElement.appendChild(this.contentDOMElement)
-    }
-
     return this.contentDOMElement
   }
 
   update(node: ProseMirrorNode, decorations: Decoration[]) {
-    if (typeof this.options.update === 'function') {
-      return this.options.update(node, decorations)
+    const updateProps = (props?: Record<string, any>) => {
+      this.renderer.updateProps(props)
     }
 
     if (node.type !== this.node.type) {
       return false
     }
 
+    if (typeof this.options.update === 'function') {
+      const oldNode = this.node
+      const oldDecorations = this.decorations
+
+      this.node = node
+      this.decorations = decorations
+
+      return this.options.update({
+        oldNode,
+        oldDecorations,
+        newNode: node,
+        newDecorations: decorations,
+        updateProps: () => updateProps({ node, decorations }),
+      })
+    }
+
     if (node === this.node && this.decorations === decorations) {
       return true
     }
 
     this.node = node
     this.decorations = decorations
-    this.renderer.updateProps({ node, decorations })
+
+    updateProps({ node, decorations })
 
     return true
   }
@@ -134,7 +179,10 @@ class ReactNodeView extends NodeView<React.FunctionComponent, Editor> {
   }
 }
 
-export function ReactNodeViewRenderer(component: any, options?: Partial<ReactNodeViewRendererOptions>): NodeViewRenderer {
+export function ReactNodeViewRenderer(
+  component: any,
+  options?: Partial<ReactNodeViewRendererOptions>,
+): NodeViewRenderer {
   return (props: NodeViewRendererProps) => {
     // try to get the parent component
     // this is important for vue devtools to show the component hierarchy correctly
@@ -143,6 +191,6 @@ export function ReactNodeViewRenderer(component: any, options?: Partial<ReactNod
       return {}
     }
 
-    return new ReactNodeView(component, props, options) as ProseMirrorNodeView
+    return new ReactNodeView(component, props, options) as unknown as ProseMirrorNodeView
   }
 }

package/src/ReactRenderer.tsx

@@ -1,6 +1,7 @@
+import { Editor } from '@tiptap/core'
 import React from 'react'
-import { AnyObject } from '@tiptap/core'
-import { Editor } from './Editor'
+
+import { Editor as ExtendedEditor } from './Editor'
 
 function isClassComponent(Component: any) {
   return !!(
@@ -10,34 +11,57 @@ function isClassComponent(Component: any) {
   )
 }
 
+function isForwardRefComponent(Component: any) {
+  return !!(
+    typeof Component === 'object'
+    && Component.$$typeof?.toString() === 'Symbol(react.forward_ref)'
+  )
+}
+
 export interface ReactRendererOptions {
   editor: Editor,
-  props?: AnyObject,
+  props?: Record<string, any>,
   as?: string,
+  className?: string,
 }
 
-export class ReactRenderer {
+type ComponentType<R, P> =
+  React.ComponentClass<P> |
+  React.FunctionComponent<P> |
+  React.ForwardRefExoticComponent<React.PropsWithoutRef<P> & React.RefAttributes<R>>;
+
+export 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 = null
+  ref: R | null = null
 
-  constructor(component: React.Component | React.FunctionComponent, { editor, props = {}, as = 'div' }: ReactRendererOptions) {
+  constructor(component: ComponentType<R, P>, {
+    editor,
+    props = {},
+    as = 'div',
+    className = '',
+  }: ReactRendererOptions) {
     this.id = Math.floor(Math.random() * 0xFFFFFFFF).toString()
     this.component = component
-    this.editor = editor
+    this.editor = editor as ExtendedEditor
     this.props = props
     this.element = document.createElement(as)
     this.element.classList.add('react-renderer')
+
+    if (className) {
+      this.element.classList.add(...className.split(' '))
+    }
+
     this.render()
   }
 
@@ -45,25 +69,18 @@ export class ReactRenderer {
     const Component = this.component
     const props = this.props
 
-    if (isClassComponent(Component)) {
-      props.ref = (ref: React.Component) => {
+    if (isClassComponent(Component) || isForwardRefComponent(Component)) {
+      props.ref = (ref: R) => {
         this.ref = ref
       }
     }
 
     this.reactElement = <Component {...props } />
 
-    if (this.editor?.contentComponent) {
-      this.editor.contentComponent.setState({
-        renderers: this.editor.contentComponent.state.renderers.set(
-          this.id,
-          this,
-        ),
-      })
-    }
+    this.editor?.contentComponent?.setRenderer(this.id, this)
   }
 
-  updateProps(props: AnyObject = {}): void {
+  updateProps(props: Record<string, any> = {}): void {
     this.props = {
       ...this.props,
       ...props,
@@ -73,14 +90,6 @@ export class ReactRenderer {
   }
 
   destroy(): void {
-    if (this.editor?.contentComponent) {
-      const { renderers } = this.editor.contentComponent.state
-
-      renderers.delete(this.id)
-
-      this.editor.contentComponent.setState({
-        renderers,
-      })
-    }
+    this.editor?.contentComponent?.removeRenderer(this.id)
   }
 }

package/src/index.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/src/useEditor.ts

@@ -1,5 +1,6 @@
-import { useState, useEffect } from 'react'
 import { EditorOptions } from '@tiptap/core'
+import { DependencyList, useEffect, useState } from 'react'
+
 import { Editor } from './Editor'
 
 function useForceUpdate() {
@@ -8,21 +9,32 @@ function useForceUpdate() {
   return () => setValue(value => value + 1)
 }
 
-export const useEditor = (options: Partial<EditorOptions> = {}) => {
+export const useEditor = (options: Partial<EditorOptions> = {}, deps: DependencyList = []) => {
   const [editor, setEditor] = useState<Editor | null>(null)
   const forceUpdate = useForceUpdate()
 
   useEffect(() => {
+    let isMounted = true
+
     const instance = new Editor(options)
 
     setEditor(instance)
 
-    instance.on('transaction', forceUpdate)
+    instance.on('transaction', () => {
+      requestAnimationFrame(() => {
+        requestAnimationFrame(() => {
+          if (isMounted) {
+            forceUpdate()
+          }
+        })
+      })
+    })
 
     return () => {
       instance.destroy()
+      isMounted = false
     }
-  }, [])
+  }, deps)
 
   return editor
 }

package/src/useReactNodeView.ts

@@ -2,6 +2,7 @@ import { createContext, useContext } from 'react'
 
 export interface ReactNodeViewContextProps {
   onDragStart: (event: DragEvent) => void,
+  nodeViewContentRef: (element: HTMLElement | null) => void,
 }
 
 export const ReactNodeViewContext = createContext<Partial<ReactNodeViewContextProps>>({