@tiptap/react 2.0.0-beta.9 → 2.0.0-beta.91

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/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/react",
   "description": "React components for tiptap",
-  "version": "2.0.0-beta.9",
+  "version": "2.0.0-beta.91",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -15,23 +15,31 @@
   "main": "dist/tiptap-react.cjs.js",
   "umd": "dist/tiptap-react.umd.js",
   "module": "dist/tiptap-react.esm.js",
-  "unpkg": "dist/tiptap-react.bundle.umd.min.js",
   "types": "dist/packages/react/src/index.d.ts",
   "files": [
     "src",
     "dist"
   ],
+  "devDependencies": {
+    "@types/react": "^17.0.34",
+    "@types/react-dom": "^17.0.11",
+    "react": "^17.0.0",
+    "react-dom": "^17.0.0"
+  },
   "peerDependencies": {
     "@tiptap/core": "^2.0.0-beta.1",
-    "react": "^17.0.1",
-    "react-dom": "^17.0.1"
+    "react": "^17.0.0",
+    "react-dom": "^17.0.0"
   },
   "dependencies": {
-    "@tiptap/extension-bubble-menu": "^2.0.0-beta.3",
-    "prosemirror-view": "^1.18.2"
+    "@tiptap/extension-bubble-menu": "^2.0.0-beta.48",
+    "@tiptap/extension-floating-menu": "^2.0.0-beta.42",
+    "prosemirror-view": "^1.22.0"
   },
-  "devDependencies": {
-    "@types/react-dom": "^17.0.3"
+  "repository": {
+    "type": "git",
+    "url": "https://github.com/ueberdosis/tiptap",
+    "directory": "packages/react"
   },
-  "gitHead": "3cf22b02c6cfba27b13f21422546f9076d5653e7"
+  "gitHead": "fce16e805824972834d5a8ce8d60e3ff41d63c7e"
 }

package/src/BubbleMenu.tsx

@@ -1,7 +1,9 @@
 import React, { useEffect, useRef } from 'react'
-import { BubbleMenuPlugin, BubbleMenuPluginKey, BubbleMenuPluginProps } from '@tiptap/extension-bubble-menu'
+import { BubbleMenuPlugin, BubbleMenuPluginProps } from '@tiptap/extension-bubble-menu'
 
-export type BubbleMenuProps = Omit<BubbleMenuPluginProps, 'element'> & {
+type Optional<T, K extends keyof T> = Pick<Partial<T>, K> & Omit<T, K>
+
+export type BubbleMenuProps = Omit<Optional<BubbleMenuPluginProps, 'pluginKey'>, 'element'> & {
   className?: string,
 }
 
@@ -9,21 +11,35 @@ export const BubbleMenu: React.FC<BubbleMenuProps> = props => {
   const element = useRef<HTMLDivElement>(null)
 
   useEffect(() => {
-    const { editor, keepInBounds = true } = props
+    if (!element.current) {
+      return
+    }
+
+    const {
+      pluginKey = 'bubbleMenu',
+      editor,
+      tippyOptions = {},
+      shouldShow = null,
+    } = props
 
     editor.registerPlugin(BubbleMenuPlugin({
+      pluginKey,
       editor,
       element: element.current as HTMLElement,
-      keepInBounds,
+      tippyOptions,
+      shouldShow,
     }))
 
     return () => {
-      editor.unregisterPlugin(BubbleMenuPluginKey)
+      editor.unregisterPlugin(pluginKey)
     }
-  }, [])
+  }, [
+    props.editor,
+    element.current,
+  ])
 
   return (
-    <div ref={element} className={props.className}>
+    <div ref={element} className={props.className} style={{ visibility: 'hidden' }}>
       {props.children}
     </div>
   )

package/src/EditorContent.tsx

@@ -1,4 +1,4 @@
-import React from 'react'
+import React, { HTMLProps } from 'react'
 import ReactDOM from 'react-dom'
 import { Editor } from './Editor'
 import { ReactRenderer } from './ReactRenderer'
@@ -17,7 +17,7 @@ const Portals: React.FC<{ renderers: Map<string, ReactRenderer> }> = ({ renderer
   )
 }
 
-export interface EditorContentProps {
+export interface EditorContentProps extends HTMLProps<HTMLDivElement> {
   editor: Editor | null,
 }
 
@@ -55,7 +55,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,8 +63,7 @@ export class PureEditorContent extends React.Component<EditorContentProps, Edito
 
       editor.contentComponent = this
 
-      // TODO: alternative to setTimeout?
-      setTimeout(() => editor.createNodeViews(), 0)
+      editor.createNodeViews()
     }
   }
 
@@ -89,7 +88,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 +96,11 @@ export class PureEditorContent extends React.Component<EditorContentProps, Edito
   }
 
   render() {
+    const { editor, ...rest } = this.props
+
     return (
       <>
-        <div ref={this.editorContentRef} />
+        <div ref={this.editorContentRef} {...rest} />
         <Portals renderers={this.state.renderers} />
       </>
     )

package/src/FloatingMenu.tsx

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

package/src/NodeViewContent.tsx

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

package/src/NodeViewWrapper.tsx

@@ -2,22 +2,24 @@ import React from 'react'
 import { useReactNodeView } from './useReactNodeView'
 
 export interface NodeViewWrapperProps {
-  className?: string,
-  as: React.ElementType,
+  [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={{
+        ...props.style,
+        whiteSpace: 'normal',
+      }}
+    />
   )
-}
+})

package/src/ReactNodeViewRenderer.tsx

@@ -1,25 +1,33 @@
-import React, { useState, useEffect } from 'react'
+import React from 'react'
 import {
   NodeView,
   NodeViewProps,
   NodeViewRenderer,
   NodeViewRendererProps,
+  NodeViewRendererOptions,
 } from '@tiptap/core'
 import { Decoration, NodeView as ProseMirrorNodeView } from 'prosemirror-view'
 import { Node as ProseMirrorNode } from 'prosemirror-model'
 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,
 }
 
-class ReactNodeView extends NodeView<React.FunctionComponent, Editor> {
+class ReactNodeView extends NodeView<React.FunctionComponent, Editor, ReactNodeViewRendererOptions> {
 
   renderer!: ReactRenderer
 
+  contentDOMElement!: HTMLElement | null
+
   mount() {
     const props: NodeViewProps = {
       editor: this.editor,
@@ -29,6 +37,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) {
@@ -36,26 +45,24 @@ class ReactNodeView extends NodeView<React.FunctionComponent, Editor> {
         return string.charAt(0).toUpperCase() + string.substring(1)
       }
 
-      // @ts-ignore
-      this.component.displayName = capitalizeFirstChar(this.extension.config.name)
+      this.component.displayName = capitalizeFirstChar(this.extension.name)
     }
 
     const ReactNodeViewProvider: React.FunctionComponent = componentProps => {
-      const [isEditable, setIsEditable] = useState(this.editor.isEditable)
-      const onDragStart = this.onDragStart.bind(this)
-      const onViewUpdate = () => setIsEditable(this.editor.isEditable)
       const Component = this.component
-
-      useEffect(() => {
-        this.editor.on('viewUpdate', onViewUpdate)
-
-        return () => {
-          this.editor.off('viewUpdate', onViewUpdate)
+      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, isEditable }}>
+        <ReactNodeViewContext.Provider value={{ onDragStart, nodeViewContentRef }}>
           <Component {...componentProps} />
         </ReactNodeViewContext.Provider>
       )
@@ -63,15 +70,32 @@ class ReactNodeView extends NodeView<React.FunctionComponent, Editor> {
 
     ReactNodeViewProvider.displayName = 'ReactNodeView'
 
+    this.contentDOMElement = this.node.isLeaf
+      ? 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'
+    }
+
     this.renderer = new ReactRenderer(ReactNodeViewProvider, {
       editor: this.editor,
       props,
+      as: this.node.isInline
+        ? 'span'
+        : 'div',
     })
   }
 
   get dom() {
-    if (!this.renderer.element.firstElementChild?.hasAttribute('data-node-view-wrapper')) {
-      throw Error('Please use the ReactViewWrapper component for your node view.')
+    if (
+      this.renderer.element.firstElementChild
+      && !this.renderer.element.firstElementChild?.hasAttribute('data-node-view-wrapper')
+    ) {
+      throw Error('Please use the NodeViewWrapper component for your node view.')
     }
 
     return this.renderer.element
@@ -82,27 +106,42 @@ class ReactNodeView extends NodeView<React.FunctionComponent, Editor> {
       return null
     }
 
-    const contentElement = this.dom.querySelector('[data-node-view-content]')
-
-    return contentElement || this.dom
+    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
   }
@@ -121,6 +160,7 @@ class ReactNodeView extends NodeView<React.FunctionComponent, Editor> {
 
   destroy() {
     this.renderer.destroy()
+    this.contentDOMElement = null
   }
 }
 

package/src/ReactRenderer.tsx

@@ -1,6 +1,6 @@
 import React from 'react'
-import { AnyObject } from '@tiptap/core'
-import { Editor } from './Editor'
+import { Editor } from '@tiptap/core'
+import { Editor as ExtendedEditor } from './Editor'
 
 function isClassComponent(Component: any) {
   return !!(
@@ -10,33 +10,45 @@ function isClassComponent(Component: any) {
   )
 }
 
+function isForwardRefComponent(Component: any) {
+  return !!(
+    typeof Component === 'object'
+    && Component.$$typeof?.toString() === 'Symbol(react.forward_ref)'
+  )
+}
+
 export interface ReactRendererOptions {
-  as?: string,
   editor: Editor,
-  props?: AnyObject,
+  props?: Record<string, any>,
+  as?: string,
 }
 
-export class ReactRenderer {
+type ComponentType<R> =
+  | React.ComponentClass
+  | React.FunctionComponent
+  | React.ForwardRefExoticComponent<{ items: any[], command: any } & React.RefAttributes<R>>
+
+export 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 = null
+  ref: R | null = null
 
-  constructor(component: React.Component | React.FunctionComponent, { props = {}, editor }: ReactRendererOptions) {
+  constructor(component: ComponentType<R>, { editor, props = {}, as = 'div' }: 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('div')
+    this.element = document.createElement(as)
     this.element.classList.add('react-renderer')
     this.render()
   }
@@ -45,8 +57,8 @@ 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
       }
     }
@@ -63,7 +75,7 @@ export class ReactRenderer {
     }
   }
 
-  updateProps(props: AnyObject = {}): void {
+  updateProps(props: Record<string, any> = {}): void {
     this.props = {
       ...this.props,
       ...props,

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

@@ -1,4 +1,4 @@
-import { useState, useEffect } from 'react'
+import { useState, useEffect, DependencyList } from 'react'
 import { EditorOptions } from '@tiptap/core'
 import { Editor } from './Editor'
 
@@ -8,7 +8,7 @@ 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()
 
@@ -17,12 +17,18 @@ export const useEditor = (options: Partial<EditorOptions> = {}) => {
 
     setEditor(instance)
 
-    instance.on('transaction', forceUpdate)
+    instance.on('transaction', () => {
+      requestAnimationFrame(() => {
+        requestAnimationFrame(() => {
+          forceUpdate()
+        })
+      })
+    })
 
     return () => {
       instance.destroy()
     }
-  }, [])
+  }, deps)
 
   return editor
 }

package/src/useReactNodeView.ts

@@ -1,12 +1,11 @@
 import { createContext, useContext } from 'react'
 
 export interface ReactNodeViewContextProps {
-  isEditable: boolean,
   onDragStart: (event: DragEvent) => void,
+  nodeViewContentRef: (element: HTMLElement | null) => void,
 }
 
 export const ReactNodeViewContext = createContext<Partial<ReactNodeViewContextProps>>({
-  isEditable: undefined,
   onDragStart: undefined,
 })