@tldraw/editor 5.3.0-next.d7d8ced023d5 → 5.3.0-next.dec36c5c2930

package/src/lib/test/EditorPortal.test.tsx

@@ -0,0 +1,48 @@
+import { act, render, screen } from '@testing-library/react'
+import { EditorPortal } from '../components/EditorPortal'
+import { createTLStore } from '../config/createTLStore'
+import { TL_CONTAINER_CLASS, TldrawEditor } from '../TldrawEditor'
+
+/** Mounted in a canvas slot — the deep-in-the-tree case the portal exists for. */
+function Portaled() {
+	return (
+		<EditorPortal>
+			<div data-testid="portaled" />
+		</EditorPortal>
+	)
+}
+
+describe('EditorPortal', () => {
+	async function renderEditor() {
+		const store = createTLStore({ shapeUtils: [], bindingUtils: [] })
+		await act(async () => {
+			render(<TldrawEditor store={store} components={{ InFrontOfTheCanvas: Portaled }} />)
+		})
+		return document.querySelector(`.${TL_CONTAINER_CLASS}`)!
+	}
+
+	it('renders its children into the editor container', async () => {
+		const container = await renderEditor()
+		expect(container.contains(screen.getByTestId('portaled'))).toBe(true)
+	})
+
+	it('renders into a host that comes after everything the editor renders', async () => {
+		const container = await renderEditor()
+		const host = container.querySelector('.tl-portal-host')!
+		expect(host.contains(screen.getByTestId('portaled'))).toBe(true)
+		// Last of the container's rendered children. Managers append their own nodes after this one
+		// (the text measurement element, say) but those are `tabIndex = -1` and out of the tab order.
+		const rendered = [...container.children].filter((el) => !el.matches('.tl-text-measure'))
+		expect(rendered.at(-1)).toBe(host)
+	})
+
+	// The tab order guarantee: mounted in a canvas slot, the portaled content still lands after
+	// everything the editor renders itself — including (in tldraw) the UI's skip link, which only
+	// works while nothing precedes it. Portaling straight into the container lands it ahead of them.
+	it('places its children after the rest of the editor in document order', async () => {
+		await renderEditor()
+		const portaled = screen.getByTestId('portaled')
+		const canvas = screen.getByTestId('canvas')
+		expect(canvas.compareDocumentPosition(portaled) & Node.DOCUMENT_POSITION_FOLLOWING).toBeTruthy()
+	})
+})

package/src/version.ts

@@ -1,9 +1,9 @@
 // This file is automatically generated by internal/scripts/refresh-assets.ts.
 // Do not edit manually. Or do, I'm a comment, not a cop.
 
-export const version = '5.3.0-next.d7d8ced023d5'
+export const version = '5.3.0-next.dec36c5c2930'
 export const publishDates = {
 	major: '2026-05-06T16:28:18.473Z',
-	minor: '2026-08-03T09:27:05.718Z',
-	patch: '2026-08-03T09:27:05.718Z',
+	minor: '2026-08-05T10:19:16.457Z',
+	patch: '2026-08-05T10:19:16.457Z',
 }

package/dist-cjs/lib/hooks/usePassThroughMouseOverEvents.js

@@ -1,51 +0,0 @@
-"use strict";
-var __defProp = Object.defineProperty;
-var __getOwnPropDesc = Object.getOwnPropertyDescriptor;
-var __getOwnPropNames = Object.getOwnPropertyNames;
-var __hasOwnProp = Object.prototype.hasOwnProperty;
-var __export = (target, all) => {
-  for (var name in all)
-    __defProp(target, name, { get: all[name], enumerable: true });
-};
-var __copyProps = (to, from, except, desc) => {
-  if (from && typeof from === "object" || typeof from === "function") {
-    for (let key of __getOwnPropNames(from))
-      if (!__hasOwnProp.call(to, key) && key !== except)
-        __defProp(to, key, { get: () => from[key], enumerable: !(desc = __getOwnPropDesc(from, key)) || desc.enumerable });
-  }
-  return to;
-};
-var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: true }), mod);
-var usePassThroughMouseOverEvents_exports = {};
-__export(usePassThroughMouseOverEvents_exports, {
-  usePassThroughMouseOverEvents: () => usePassThroughMouseOverEvents
-});
-module.exports = __toCommonJS(usePassThroughMouseOverEvents_exports);
-var import_react = require("react");
-var import_dom = require("../utils/dom");
-var import_useContainer = require("./useContainer");
-var import_useEditor = require("./useEditor");
-function usePassThroughMouseOverEvents(ref) {
-  if (!ref) throw Error("usePassThroughWheelEvents must be passed a ref");
-  const container = (0, import_useContainer.useContainer)();
-  const editor = (0, import_useEditor.useMaybeEditor)();
-  (0, import_react.useEffect)(() => {
-    function onMouseOver(e) {
-      if (!editor?.getInstanceState().isFocused) return;
-      if (e.isSpecialRedispatchedEvent) return;
-      (0, import_dom.preventDefault)(e);
-      const cvs = container.querySelector(".tl-canvas");
-      if (!cvs) return;
-      const newEvent = new PointerEvent(e.type, e);
-      newEvent.isSpecialRedispatchedEvent = true;
-      cvs.dispatchEvent(newEvent);
-    }
-    const elm = ref.current;
-    if (!elm) return;
-    elm.addEventListener("mouseover", onMouseOver, { passive: false });
-    return () => {
-      elm.removeEventListener("mouseover", onMouseOver);
-    };
-  }, [container, editor, ref]);
-}
-//# sourceMappingURL=usePassThroughMouseOverEvents.js.map

package/dist-cjs/lib/hooks/usePassThroughMouseOverEvents.js.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/lib/hooks/usePassThroughMouseOverEvents.ts"],
-  "sourcesContent": ["import { RefObject, useEffect } from 'react'\nimport { preventDefault } from '../utils/dom'\nimport { useContainer } from './useContainer'\nimport { useMaybeEditor } from './useEditor'\n\n/** @public */\nexport function usePassThroughMouseOverEvents(ref: RefObject<HTMLElement | null>) {\n\tif (!ref) throw Error('usePassThroughWheelEvents must be passed a ref')\n\tconst container = useContainer()\n\tconst editor = useMaybeEditor()\n\n\tuseEffect(() => {\n\t\tfunction onMouseOver(e: MouseEvent) {\n\t\t\tif (!editor?.getInstanceState().isFocused) return\n\t\t\tif ((e as any).isSpecialRedispatchedEvent) return\n\t\t\tpreventDefault(e)\n\t\t\tconst cvs = container.querySelector('.tl-canvas')\n\t\t\tif (!cvs) return\n\t\t\tconst newEvent = new PointerEvent(e.type, e as any)\n\t\t\t;(newEvent as any).isSpecialRedispatchedEvent = true\n\t\t\tcvs.dispatchEvent(newEvent)\n\t\t}\n\n\t\tconst elm = ref.current\n\t\tif (!elm) return\n\n\t\telm.addEventListener('mouseover', onMouseOver, { passive: false })\n\t\treturn () => {\n\t\t\telm.removeEventListener('mouseover', onMouseOver)\n\t\t}\n\t}, [container, editor, ref])\n}\n"],
-  "mappings": ";;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,mBAAqC;AACrC,iBAA+B;AAC/B,0BAA6B;AAC7B,uBAA+B;AAGxB,SAAS,8BAA8B,KAAoC;AACjF,MAAI,CAAC,IAAK,OAAM,MAAM,gDAAgD;AACtE,QAAM,gBAAY,kCAAa;AAC/B,QAAM,aAAS,iCAAe;AAE9B,8BAAU,MAAM;AACf,aAAS,YAAY,GAAe;AACnC,UAAI,CAAC,QAAQ,iBAAiB,EAAE,UAAW;AAC3C,UAAK,EAAU,2BAA4B;AAC3C,qCAAe,CAAC;AAChB,YAAM,MAAM,UAAU,cAAc,YAAY;AAChD,UAAI,CAAC,IAAK;AACV,YAAM,WAAW,IAAI,aAAa,EAAE,MAAM,CAAQ;AACjD,MAAC,SAAiB,6BAA6B;AAChD,UAAI,cAAc,QAAQ;AAAA,IAC3B;AAEA,UAAM,MAAM,IAAI;AAChB,QAAI,CAAC,IAAK;AAEV,QAAI,iBAAiB,aAAa,aAAa,EAAE,SAAS,MAAM,CAAC;AACjE,WAAO,MAAM;AACZ,UAAI,oBAAoB,aAAa,WAAW;AAAA,IACjD;AAAA,EACD,GAAG,CAAC,WAAW,QAAQ,GAAG,CAAC;AAC5B;",
-  "names": []
-}

package/dist-esm/lib/hooks/usePassThroughMouseOverEvents.mjs

@@ -1,31 +0,0 @@
-import { useEffect } from "react";
-import { preventDefault } from "../utils/dom.mjs";
-import { useContainer } from "./useContainer.mjs";
-import { useMaybeEditor } from "./useEditor.mjs";
-function usePassThroughMouseOverEvents(ref) {
-  if (!ref) throw Error("usePassThroughWheelEvents must be passed a ref");
-  const container = useContainer();
-  const editor = useMaybeEditor();
-  useEffect(() => {
-    function onMouseOver(e) {
-      if (!editor?.getInstanceState().isFocused) return;
-      if (e.isSpecialRedispatchedEvent) return;
-      preventDefault(e);
-      const cvs = container.querySelector(".tl-canvas");
-      if (!cvs) return;
-      const newEvent = new PointerEvent(e.type, e);
-      newEvent.isSpecialRedispatchedEvent = true;
-      cvs.dispatchEvent(newEvent);
-    }
-    const elm = ref.current;
-    if (!elm) return;
-    elm.addEventListener("mouseover", onMouseOver, { passive: false });
-    return () => {
-      elm.removeEventListener("mouseover", onMouseOver);
-    };
-  }, [container, editor, ref]);
-}
-export {
-  usePassThroughMouseOverEvents
-};
-//# sourceMappingURL=usePassThroughMouseOverEvents.mjs.map

package/dist-esm/lib/hooks/usePassThroughMouseOverEvents.mjs.map

@@ -1,7 +0,0 @@
-{
-  "version": 3,
-  "sources": ["../../../src/lib/hooks/usePassThroughMouseOverEvents.ts"],
-  "sourcesContent": ["import { RefObject, useEffect } from 'react'\nimport { preventDefault } from '../utils/dom'\nimport { useContainer } from './useContainer'\nimport { useMaybeEditor } from './useEditor'\n\n/** @public */\nexport function usePassThroughMouseOverEvents(ref: RefObject<HTMLElement | null>) {\n\tif (!ref) throw Error('usePassThroughWheelEvents must be passed a ref')\n\tconst container = useContainer()\n\tconst editor = useMaybeEditor()\n\n\tuseEffect(() => {\n\t\tfunction onMouseOver(e: MouseEvent) {\n\t\t\tif (!editor?.getInstanceState().isFocused) return\n\t\t\tif ((e as any).isSpecialRedispatchedEvent) return\n\t\t\tpreventDefault(e)\n\t\t\tconst cvs = container.querySelector('.tl-canvas')\n\t\t\tif (!cvs) return\n\t\t\tconst newEvent = new PointerEvent(e.type, e as any)\n\t\t\t;(newEvent as any).isSpecialRedispatchedEvent = true\n\t\t\tcvs.dispatchEvent(newEvent)\n\t\t}\n\n\t\tconst elm = ref.current\n\t\tif (!elm) return\n\n\t\telm.addEventListener('mouseover', onMouseOver, { passive: false })\n\t\treturn () => {\n\t\t\telm.removeEventListener('mouseover', onMouseOver)\n\t\t}\n\t}, [container, editor, ref])\n}\n"],
-  "mappings": "AAAA,SAAoB,iBAAiB;AACrC,SAAS,sBAAsB;AAC/B,SAAS,oBAAoB;AAC7B,SAAS,sBAAsB;AAGxB,SAAS,8BAA8B,KAAoC;AACjF,MAAI,CAAC,IAAK,OAAM,MAAM,gDAAgD;AACtE,QAAM,YAAY,aAAa;AAC/B,QAAM,SAAS,eAAe;AAE9B,YAAU,MAAM;AACf,aAAS,YAAY,GAAe;AACnC,UAAI,CAAC,QAAQ,iBAAiB,EAAE,UAAW;AAC3C,UAAK,EAAU,2BAA4B;AAC3C,qBAAe,CAAC;AAChB,YAAM,MAAM,UAAU,cAAc,YAAY;AAChD,UAAI,CAAC,IAAK;AACV,YAAM,WAAW,IAAI,aAAa,EAAE,MAAM,CAAQ;AACjD,MAAC,SAAiB,6BAA6B;AAChD,UAAI,cAAc,QAAQ;AAAA,IAC3B;AAEA,UAAM,MAAM,IAAI;AAChB,QAAI,CAAC,IAAK;AAEV,QAAI,iBAAiB,aAAa,aAAa,EAAE,SAAS,MAAM,CAAC;AACjE,WAAO,MAAM;AACZ,UAAI,oBAAoB,aAAa,WAAW;AAAA,IACjD;AAAA,EACD,GAAG,CAAC,WAAW,QAAQ,GAAG,CAAC;AAC5B;",
-  "names": []
-}

package/src/lib/hooks/usePassThroughMouseOverEvents.ts

@@ -1,32 +0,0 @@
-import { RefObject, useEffect } from 'react'
-import { preventDefault } from '../utils/dom'
-import { useContainer } from './useContainer'
-import { useMaybeEditor } from './useEditor'
-
-/** @public */
-export function usePassThroughMouseOverEvents(ref: RefObject<HTMLElement | null>) {
-	if (!ref) throw Error('usePassThroughWheelEvents must be passed a ref')
-	const container = useContainer()
-	const editor = useMaybeEditor()
-
-	useEffect(() => {
-		function onMouseOver(e: MouseEvent) {
-			if (!editor?.getInstanceState().isFocused) return
-			if ((e as any).isSpecialRedispatchedEvent) return
-			preventDefault(e)
-			const cvs = container.querySelector('.tl-canvas')
-			if (!cvs) return
-			const newEvent = new PointerEvent(e.type, e as any)
-			;(newEvent as any).isSpecialRedispatchedEvent = true
-			cvs.dispatchEvent(newEvent)
-		}
-
-		const elm = ref.current
-		if (!elm) return
-
-		elm.addEventListener('mouseover', onMouseOver, { passive: false })
-		return () => {
-			elm.removeEventListener('mouseover', onMouseOver)
-		}
-	}, [container, editor, ref])
-}