@tiptap/react 2.5.8 → 3.0.0-next.0

package/dist/packages/extension-bubble-menu/src/bubble-menu-plugin.d.ts

@@ -1,7 +1,7 @@
+import { type ArrowOptions, type AutoPlacementOptions, type FlipOptions, type HideOptions, type InlineOptions, type OffsetOptions, type Placement, type ShiftOptions, type SizeOptions, type Strategy } from '@floating-ui/dom';
 import { Editor } from '@tiptap/core';
 import { EditorState, Plugin, PluginKey } from '@tiptap/pm/state';
 import { EditorView } from '@tiptap/pm/view';
-import { Instance, Props } from 'tippy.js';
 export interface BubbleMenuPluginProps {
     /**
      * The plugin key.
@@ -19,11 +19,6 @@ export interface BubbleMenuPluginProps {
      * @default null
      */
     element: HTMLElement;
-    /**
-     * The options for the tippy.js instance.
-     * @see https://atomiks.github.io/tippyjs/v6/all-props/
-     */
-    tippyOptions?: Partial<Props>;
     /**
      * The delay in milliseconds before the menu should be updated.
      * This can be useful to prevent performance issues.
@@ -31,11 +26,18 @@ export interface BubbleMenuPluginProps {
      * @default 250
      */
     updateDelay?: number;
+    /**
+     * The delay in milliseconds before the menu position should be updated on window resize.
+     * This can be useful to prevent performance issues.
+     * @type {number}
+     * @default 60
+     */
+    resizeDelay?: number;
     /**
      * A function that determines whether the menu should be shown or not.
      * If this function returns `false`, the menu will be hidden, otherwise it will be shown.
      */
-    shouldShow?: ((props: {
+    shouldShow: ((props: {
         editor: Editor;
         view: EditorView;
         state: EditorState;
@@ -43,6 +45,21 @@ export interface BubbleMenuPluginProps {
         from: number;
         to: number;
     }) => boolean) | null;
+    /**
+     * FloatingUI options.
+     */
+    options?: {
+        strategy?: Strategy;
+        placement?: Placement;
+        offset?: OffsetOptions | boolean;
+        flip?: FlipOptions | boolean;
+        shift?: ShiftOptions | boolean;
+        arrow?: ArrowOptions | false;
+        size?: SizeOptions | boolean;
+        autoPlacement?: AutoPlacementOptions | boolean;
+        hide?: HideOptions | boolean;
+        inline?: InlineOptions | boolean;
+    };
 }
 export type BubbleMenuViewProps = BubbleMenuPluginProps & {
     view: EditorView;
@@ -52,22 +69,28 @@ export declare class BubbleMenuView {
     element: HTMLElement;
     view: EditorView;
     preventHide: boolean;
-    tippy: Instance | undefined;
-    tippyOptions?: Partial<Props>;
     updateDelay: number;
+    resizeDelay: number;
     private updateDebounceTimer;
+    private resizeDebounceTimer;
+    private floatingUIOptions;
     shouldShow: Exclude<BubbleMenuPluginProps['shouldShow'], null>;
-    constructor({ editor, element, view, tippyOptions, updateDelay, shouldShow, }: BubbleMenuViewProps);
+    get middlewares(): {
+        name: string;
+        options?: any;
+        fn: (state: import("@floating-ui/dom").MiddlewareState) => import("@floating-ui/core").MiddlewareReturn | Promise<import("@floating-ui/core").MiddlewareReturn>;
+    }[];
+    constructor({ editor, element, view, updateDelay, resizeDelay, shouldShow, options, }: BubbleMenuViewProps);
     mousedownHandler: () => void;
     dragstartHandler: () => void;
     focusHandler: () => void;
     blurHandler: ({ event }: {
         event: FocusEvent;
     }) => void;
-    tippyBlurHandler: (event: FocusEvent) => void;
-    createTooltip(): void;
+    updatePosition(): void;
     update(view: EditorView, oldState?: EditorState): void;
     handleDebouncedUpdate: (view: EditorView, oldState?: EditorState) => void;
+    getShouldShow(oldState?: EditorState): boolean;
     updateHandler: (view: EditorView, selectionChanged: boolean, docChanged: boolean, oldState?: EditorState) => void;
     show(): void;
     hide(): void;

package/dist/packages/extension-floating-menu/src/floating-menu-plugin.d.ts

@@ -1,7 +1,7 @@
+import { type ArrowOptions, type AutoPlacementOptions, type FlipOptions, type HideOptions, type InlineOptions, type OffsetOptions, type Placement, type ShiftOptions, type SizeOptions, type Strategy } from '@floating-ui/dom';
 import { Editor } from '@tiptap/core';
 import { EditorState, Plugin, PluginKey } from '@tiptap/pm/state';
 import { EditorView } from '@tiptap/pm/view';
-import { Instance, Props } from 'tippy.js';
 export interface FloatingMenuPluginProps {
     /**
      * The plugin key for the floating menu.
@@ -18,23 +18,33 @@ export interface FloatingMenuPluginProps {
      * @default null
      */
     element: HTMLElement;
-    /**
-     * The options for the tippy instance.
-     * @default {}
-     * @see https://atomiks.github.io/tippyjs/v6/all-props/
-     */
-    tippyOptions?: Partial<Props>;
     /**
      * A function that determines whether the menu should be shown or not.
      * If this function returns `false`, the menu will be hidden, otherwise it will be shown.
-     * @default null
      */
-    shouldShow?: ((props: {
+    shouldShow: ((props: {
         editor: Editor;
         view: EditorView;
         state: EditorState;
         oldState?: EditorState;
+        from: number;
+        to: number;
     }) => boolean) | null;
+    /**
+   * FloatingUI options.
+   */
+    options?: {
+        strategy?: Strategy;
+        placement?: Placement;
+        offset?: OffsetOptions | boolean;
+        flip?: FlipOptions | boolean;
+        shift?: ShiftOptions | boolean;
+        arrow?: ArrowOptions | false;
+        size?: SizeOptions | boolean;
+        autoPlacement?: AutoPlacementOptions | boolean;
+        hide?: HideOptions | boolean;
+        inline?: InlineOptions | boolean;
+    };
 }
 export type FloatingMenuViewProps = FloatingMenuPluginProps & {
     /**
@@ -47,17 +57,22 @@ export declare class FloatingMenuView {
     element: HTMLElement;
     view: EditorView;
     preventHide: boolean;
-    tippy: Instance | undefined;
-    tippyOptions?: Partial<Props>;
     shouldShow: Exclude<FloatingMenuPluginProps['shouldShow'], null>;
-    constructor({ editor, element, view, tippyOptions, shouldShow, }: FloatingMenuViewProps);
+    private floatingUIOptions;
+    get middlewares(): {
+        name: string;
+        options?: any;
+        fn: (state: import("@floating-ui/dom").MiddlewareState) => import("@floating-ui/core").MiddlewareReturn | Promise<import("@floating-ui/core").MiddlewareReturn>;
+    }[];
+    constructor({ editor, element, view, options, shouldShow, }: FloatingMenuViewProps);
+    getShouldShow(oldState?: EditorState): boolean;
+    updateHandler: (view: EditorView, selectionChanged: boolean, docChanged: boolean, oldState?: EditorState) => void;
     mousedownHandler: () => void;
     focusHandler: () => void;
     blurHandler: ({ event }: {
         event: FocusEvent;
     }) => void;
-    tippyBlurHandler: (event: FocusEvent) => void;
-    createTooltip(): void;
+    updatePosition(): void;
     update(view: EditorView, oldState?: EditorState): void;
     show(): void;
     hide(): void;

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

@@ -6,6 +6,8 @@ export type BubbleMenuProps = Omit<Optional<BubbleMenuPluginProps, 'pluginKey'>,
     className?: string;
     children: React.ReactNode;
     updateDelay?: number;
+    resizeDelay?: number;
+    options?: BubbleMenuPluginProps['options'];
 };
 export declare const BubbleMenu: (props: BubbleMenuProps) => React.JSX.Element;
 export {};

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

@@ -5,6 +5,7 @@ export type FloatingMenuProps = Omit<Optional<FloatingMenuPluginProps, 'pluginKe
     editor: FloatingMenuPluginProps['editor'] | null;
     className?: string;
     children: React.ReactNode;
+    options?: FloatingMenuPluginProps['options'];
 };
 export declare const FloatingMenu: (props: FloatingMenuProps) => React.JSX.Element;
 export {};

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tiptap/react",
   "description": "React components for tiptap",
-  "version": "2.5.8",
+  "version": "3.0.0-next.0",
   "homepage": "https://tiptap.dev",
   "keywords": [
     "tiptap",
@@ -29,22 +29,22 @@
     "dist"
   ],
   "dependencies": {
-    "@tiptap/extension-bubble-menu": "^2.5.8",
-    "@tiptap/extension-floating-menu": "^2.5.8",
+    "@tiptap/extension-bubble-menu": "^3.0.0-next.0",
+    "@tiptap/extension-floating-menu": "^3.0.0-next.0",
     "@types/use-sync-external-store": "^0.0.6",
     "use-sync-external-store": "^1.2.2"
   },
   "devDependencies": {
-    "@tiptap/core": "^2.5.8",
-    "@tiptap/pm": "^2.5.8",
+    "@tiptap/core": "^3.0.0-next.0",
+    "@tiptap/pm": "^3.0.0-next.0",
     "@types/react": "^18.2.14",
     "@types/react-dom": "^18.2.6",
     "react": "^18.0.0",
     "react-dom": "^18.0.0"
   },
   "peerDependencies": {
-    "@tiptap/core": "^2.5.8",
-    "@tiptap/pm": "^2.5.8",
+    "@tiptap/core": "^3.0.0-next.0",
+    "@tiptap/pm": "^3.0.0-next.0",
     "react": "^17.0.0 || ^18.0.0",
     "react-dom": "^17.0.0 || ^18.0.0"
   },

package/src/BubbleMenu.tsx

@@ -1,5 +1,6 @@
 import { BubbleMenuPlugin, BubbleMenuPluginProps } from '@tiptap/extension-bubble-menu'
-import React, { useEffect, useState } from 'react'
+import React, { useEffect, useRef } from 'react'
+import { createPortal } from 'react-dom'
 
 import { useCurrentEditor } from './Context.js'
 
@@ -10,23 +11,24 @@ export type BubbleMenuProps = Omit<Optional<BubbleMenuPluginProps, 'pluginKey'>,
   className?: string;
   children: React.ReactNode;
   updateDelay?: number;
+  resizeDelay?: number;
+  options?: BubbleMenuPluginProps['options'];
 };
 
 export const BubbleMenu = (props: BubbleMenuProps) => {
-  const [element, setElement] = useState<HTMLDivElement | null>(null)
+  const menuEl = useRef(document.createElement('div'))
   const { editor: currentEditor } = useCurrentEditor()
 
   useEffect(() => {
-    if (!element) {
-      return
-    }
+    menuEl.current.style.visibility = 'hidden'
+    menuEl.current.style.position = 'absolute'
 
     if (props.editor?.isDestroyed || currentEditor?.isDestroyed) {
       return
     }
 
     const {
-      pluginKey = 'bubbleMenu', editor, tippyOptions = {}, updateDelay, shouldShow = null,
+      pluginKey = 'bubbleMenu', editor, updateDelay, resizeDelay, shouldShow = null,
     } = props
 
     const menuEditor = editor || currentEditor
@@ -38,20 +40,35 @@ export const BubbleMenu = (props: BubbleMenuProps) => {
 
     const plugin = BubbleMenuPlugin({
       updateDelay,
+      resizeDelay,
       editor: menuEditor,
-      element,
+      element: menuEl.current,
       pluginKey,
       shouldShow,
-      tippyOptions,
+      options: props.options,
     })
 
     menuEditor.registerPlugin(plugin)
-    return () => menuEditor.unregisterPlugin(pluginKey)
-  }, [props.editor, currentEditor, element])
 
-  return (
-    <div ref={setElement} className={props.className} style={{ visibility: 'hidden' }}>
+    return () => {
+      menuEditor.unregisterPlugin(pluginKey)
+      window.requestAnimationFrame(() => {
+        if (menuEl.current.parentNode) {
+          menuEl.current.parentNode.removeChild(menuEl.current)
+        }
+      })
+    }
+  }, [props.editor, currentEditor])
+
+  const portal = createPortal(
+    (
+    <div className={props.className}>
       {props.children}
     </div>
+    ), menuEl.current,
+  )
+
+  return (
+    <>{portal}</>
   )
 }

package/src/FloatingMenu.tsx

@@ -1,7 +1,8 @@
 import { FloatingMenuPlugin, FloatingMenuPluginProps } from '@tiptap/extension-floating-menu'
 import React, {
-  useEffect, useState,
+  useEffect, useRef,
 } from 'react'
+import { createPortal } from 'react-dom'
 
 import { useCurrentEditor } from './Context.js'
 
@@ -11,16 +12,16 @@ export type FloatingMenuProps = Omit<Optional<FloatingMenuPluginProps, 'pluginKe
   editor: FloatingMenuPluginProps['editor'] | null;
   className?: string,
   children: React.ReactNode
+  options?: FloatingMenuPluginProps['options']
 }
 
 export const FloatingMenu = (props: FloatingMenuProps) => {
-  const [element, setElement] = useState<HTMLDivElement | null>(null)
+  const menuEl = useRef(document.createElement('div'))
   const { editor: currentEditor } = useCurrentEditor()
 
   useEffect(() => {
-    if (!element) {
-      return
-    }
+    menuEl.current.style.visibility = 'hidden'
+    menuEl.current.style.position = 'absolute'
 
     if (props.editor?.isDestroyed || currentEditor?.isDestroyed) {
       return
@@ -29,7 +30,7 @@ export const FloatingMenu = (props: FloatingMenuProps) => {
     const {
       pluginKey = 'floatingMenu',
       editor,
-      tippyOptions = {},
+      options,
       shouldShow = null,
     } = props
 
@@ -43,22 +44,34 @@ export const FloatingMenu = (props: FloatingMenuProps) => {
     const plugin = FloatingMenuPlugin({
       pluginKey,
       editor: menuEditor,
-      element,
-      tippyOptions,
+      element: menuEl.current,
+      options,
       shouldShow,
     })
 
     menuEditor.registerPlugin(plugin)
-    return () => menuEditor.unregisterPlugin(pluginKey)
+    return () => {
+      menuEditor.unregisterPlugin(pluginKey)
+      window.requestAnimationFrame(() => {
+        if (menuEl.current.parentNode) {
+          menuEl.current.parentNode.removeChild(menuEl.current)
+        }
+      })
+    }
   }, [
     props.editor,
     currentEditor,
-    element,
   ])
 
-  return (
-    <div ref={setElement} className={props.className} style={{ visibility: 'hidden' }}>
+  const portal = createPortal(
+    (
+    <div className={props.className}>
       {props.children}
     </div>
+    ), menuEl.current,
+  )
+
+  return (
+    <>{portal}</>
   )
 }