@tldraw/editor 3.16.0-canary.dfdf6b7de8c2 → 3.16.0-canary.e5e61b17cef3

package/src/lib/editor/managers/TextManager/TextManager.test.ts

@@ -1,17 +1,21 @@
+import { vi } from 'vitest'
 import { Editor } from '../../Editor'
 import { TextManager, TLMeasureTextSpanOpts } from './TextManager'
 
 // Create a simple mock DOM environment
 const mockElement = {
-	classList: { add: jest.fn() },
+	classList: { add: vi.fn() },
 	tabIndex: -1,
-	cloneNode: jest.fn(),
+	cloneNode: vi.fn(),
 	innerHTML: '',
 	textContent: '',
-	setAttribute: jest.fn(),
-	style: { setProperty: jest.fn() },
+	setAttribute: vi.fn(),
+	style: {
+		setProperty: vi.fn(),
+		getPropertyValue: vi.fn(() => ''),
+	},
 	scrollWidth: 100,
-	getBoundingClientRect: jest.fn(() => ({
+	getBoundingClientRect: vi.fn(() => ({
 		width: 100,
 		height: 20,
 		left: 0,
@@ -19,22 +23,44 @@ const mockElement = {
 		right: 100,
 		bottom: 20,
 	})),
-	remove: jest.fn(),
-	insertAdjacentElement: jest.fn(),
+	remove: vi.fn(),
+	insertAdjacentElement: vi.fn(),
 	childNodes: [],
 }
 
 // Mock document.createElement to return our mock element
-const mockCreateElement = jest.fn(() => {
+const mockCreateElement = vi.fn(() => {
 	const element = { ...mockElement }
-	element.cloneNode = jest.fn(() => ({ ...element }))
+	element.cloneNode = vi.fn(() => ({ ...element }))
+
+	// Make textContent and innerHTML reactive like real DOM elements
+	let _textContent = ''
+	let _innerHTML = ''
+
+	Object.defineProperty(element, 'textContent', {
+		get: () => _textContent,
+		set: (value) => {
+			_textContent = value || ''
+			// When textContent is set, innerHTML should be the escaped version
+			_innerHTML = _textContent
+		},
+	})
+
+	Object.defineProperty(element, 'innerHTML', {
+		get: () => _innerHTML,
+		set: (value) => {
+			_innerHTML = value || ''
+			_textContent = _innerHTML // Simple approximation
+		},
+	})
+
 	return element
 })
 
 // Mock editor
 const mockEditor = {
-	getContainer: jest.fn(() => ({
-		appendChild: jest.fn(),
+	getContainer: vi.fn(() => ({
+		appendChild: vi.fn(),
 	})),
 } as unknown as Editor
 
@@ -43,10 +69,10 @@ global.document = {
 	createElement: mockCreateElement,
 } as any
 
-global.Range = jest.fn(() => ({
-	setStart: jest.fn(),
-	setEnd: jest.fn(),
-	getClientRects: jest.fn(() => [
+global.Range = vi.fn(() => ({
+	setStart: vi.fn(),
+	setEnd: vi.fn(),
+	getClientRects: vi.fn(() => [
 		{
 			width: 10,
 			height: 16,
@@ -62,7 +88,7 @@ describe('TextManager', () => {
 	let textManager: TextManager
 
 	beforeEach(() => {
-		jest.clearAllMocks()
+		vi.clearAllMocks()
 		textManager = new TextManager(mockEditor)
 	})
 
@@ -86,13 +112,13 @@ describe('TextManager', () => {
 		}
 
 		it('should call measureHtml with normalized text', () => {
-			const spy = jest.spyOn(textManager, 'measureHtml')
+			const spy = vi.spyOn(textManager, 'measureHtml')
 			textManager.measureText('Hello World', defaultOpts)
 			expect(spy).toHaveBeenCalledWith('Hello World', defaultOpts)
 		})
 
 		it('should normalize line breaks', () => {
-			const spy = jest.spyOn(textManager, 'measureHtml')
+			const spy = vi.spyOn(textManager, 'measureHtml')
 			textManager.measureText('Hello\nWorld\r\nTest', defaultOpts)
 			// The text should be normalized to use consistent line breaks
 			expect(spy).toHaveBeenCalled()
@@ -247,7 +273,7 @@ describe('TextManager', () => {
 
 		it('should return array of text spans for non-empty text', () => {
 			// Mock measureElementTextNodeSpans to return some spans
-			jest.spyOn(textManager, 'measureElementTextNodeSpans').mockReturnValue({
+			vi.spyOn(textManager, 'measureElementTextNodeSpans').mockReturnValue({
 				spans: [
 					{
 						text: 'Hello World',
@@ -266,7 +292,7 @@ describe('TextManager', () => {
 		})
 
 		it('should handle wrap overflow', () => {
-			jest.spyOn(textManager, 'measureElementTextNodeSpans').mockReturnValue({
+			vi.spyOn(textManager, 'measureElementTextNodeSpans').mockReturnValue({
 				spans: [
 					{
 						text: 'Hello World',
@@ -284,8 +310,7 @@ describe('TextManager', () => {
 
 		it('should handle truncate-ellipsis overflow', () => {
 			// Mock the calls for ellipsis handling
-			jest
-				.spyOn(textManager, 'measureElementTextNodeSpans')
+			vi.spyOn(textManager, 'measureElementTextNodeSpans')
 				.mockReturnValueOnce({
 					spans: [
 						{
@@ -321,7 +346,7 @@ describe('TextManager', () => {
 		})
 
 		it('should handle truncate-clip overflow', () => {
-			jest.spyOn(textManager, 'measureElementTextNodeSpans').mockReturnValue({
+			vi.spyOn(textManager, 'measureElementTextNodeSpans').mockReturnValue({
 				spans: [
 					{
 						text: 'Hello Wo',
@@ -338,7 +363,7 @@ describe('TextManager', () => {
 		})
 
 		it('should handle different text alignments', () => {
-			jest.spyOn(textManager, 'measureElementTextNodeSpans').mockReturnValue({
+			vi.spyOn(textManager, 'measureElementTextNodeSpans').mockReturnValue({
 				spans: [
 					{
 						text: 'Test',
@@ -358,7 +383,7 @@ describe('TextManager', () => {
 		})
 
 		it('should handle custom font properties', () => {
-			jest.spyOn(textManager, 'measureElementTextNodeSpans').mockReturnValue({
+			vi.spyOn(textManager, 'measureElementTextNodeSpans').mockReturnValue({
 				spans: [
 					{
 						text: 'Test',
@@ -382,7 +407,7 @@ describe('TextManager', () => {
 		})
 
 		it('should handle other styles', () => {
-			jest.spyOn(textManager, 'measureElementTextNodeSpans').mockReturnValue({
+			vi.spyOn(textManager, 'measureElementTextNodeSpans').mockReturnValue({
 				spans: [
 					{
 						text: 'Test',

package/src/lib/editor/managers/TickManager/TickManager.test.ts

@@ -1,28 +1,29 @@
+import { Mock, Mocked, vi } from 'vitest'
 import { Vec } from '../../../primitives/Vec'
 import { Editor } from '../../Editor'
 import { TickManager } from './TickManager'
 
 // Mock the Editor class
-jest.mock('../../Editor')
+vi.mock('../../Editor')
 
 // Mock Date.now to control time
-const mockDateNow = jest.fn()
+const mockDateNow = vi.fn()
 Date.now = mockDateNow
 
 // Mock requestAnimationFrame and cancelAnimationFrame
-const mockRequestAnimationFrame = jest.fn()
-const mockCancelAnimationFrame = jest.fn()
+const mockRequestAnimationFrame = vi.fn()
+const mockCancelAnimationFrame = vi.fn()
 global.requestAnimationFrame = mockRequestAnimationFrame
 global.cancelAnimationFrame = mockCancelAnimationFrame
 
 describe('TickManager', () => {
-	let editor: jest.Mocked<Editor>
+	let editor: Mocked<Editor>
 	let tickManager: TickManager
-	let mockEmit: jest.Mock
-	let mockDisposablesAdd: jest.Mock
+	let mockEmit: Mock
+	let mockDisposablesAdd: Mock
 
 	beforeEach(() => {
-		jest.clearAllMocks()
+		vi.clearAllMocks()
 
 		// Reset time
 		mockDateNow.mockReturnValue(1000)
@@ -37,8 +38,8 @@ describe('TickManager', () => {
 
 		mockCancelAnimationFrame.mockImplementation(() => {})
 
-		mockEmit = jest.fn()
-		mockDisposablesAdd = jest.fn()
+		mockEmit = vi.fn()
+		mockDisposablesAdd = vi.fn()
 
 		editor = {
 			emit: mockEmit,
@@ -90,7 +91,7 @@ describe('TickManager', () => {
 		})
 
 		it('should cancel existing RAF before starting new one', () => {
-			const mockCancel = jest.fn()
+			const mockCancel = vi.fn()
 			tickManager.cancelRaf = mockCancel
 
 			tickManager.start()
@@ -143,7 +144,7 @@ describe('TickManager', () => {
 		})
 
 		it('should update pointer velocity', () => {
-			const updatePointerVelocitySpy = jest.spyOn(tickManager as any, 'updatePointerVelocity')
+			const updatePointerVelocitySpy = vi.spyOn(tickManager as any, 'updatePointerVelocity')
 			tickManager.now = 1000
 			mockDateNow.mockReturnValue(1016)
 
@@ -176,7 +177,7 @@ describe('TickManager', () => {
 		})
 
 		it('should cancel RAF if exists', () => {
-			const mockCancel = jest.fn()
+			const mockCancel = vi.fn()
 			tickManager.cancelRaf = mockCancel
 
 			tickManager.dispose()

package/src/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.test.ts

@@ -1,17 +1,15 @@
 import { atom } from '@tldraw/state'
+import { Mocked, vi } from 'vitest'
 import { TLUserPreferences, defaultUserPreferences } from '../../../config/TLUserPreferences'
 import { TLUser } from '../../../config/createTLUser'
 import { UserPreferencesManager } from './UserPreferencesManager'
 
 // Mock window.matchMedia
-const mockMatchMedia = jest.fn()
-Object.defineProperty(window, 'matchMedia', {
-	writable: true,
-	value: mockMatchMedia,
-})
+const mockMatchMedia = vi.fn()
+window.matchMedia = mockMatchMedia
 
 describe('UserPreferencesManager', () => {
-	let mockUser: jest.Mocked<TLUser>
+	let mockUser: Mocked<TLUser>
 	let mockUserPreferences: TLUserPreferences
 	let userPreferencesAtom: any
 	let userPreferencesManager: UserPreferencesManager
@@ -25,6 +23,7 @@ describe('UserPreferencesManager', () => {
 		locale: 'en',
 		animationSpeed: 1,
 		areKeyboardShortcutsEnabled: true,
+		showUiLabels: false,
 		edgeScrollSpeed: 1,
 		colorScheme: 'light',
 		isSnapMode: false,
@@ -35,14 +34,14 @@ describe('UserPreferencesManager', () => {
 	})
 
 	beforeEach(() => {
-		jest.clearAllMocks()
+		vi.clearAllMocks()
 
 		mockUserPreferences = createMockUserPreferences()
 		userPreferencesAtom = atom('userPreferences', mockUserPreferences)
 
 		mockUser = {
 			userPreferences: userPreferencesAtom,
-			setUserPreferences: jest.fn((prefs) => {
+			setUserPreferences: vi.fn((prefs) => {
 				userPreferencesAtom.set(prefs)
 			}),
 		}
@@ -50,8 +49,8 @@ describe('UserPreferencesManager', () => {
 		// Default matchMedia mock - no dark mode preference
 		mockMatchMedia.mockReturnValue({
 			matches: false,
-			addEventListener: jest.fn(),
-			removeEventListener: jest.fn(),
+			addEventListener: vi.fn(),
+			removeEventListener: vi.fn(),
 		})
 	})
 
@@ -65,17 +64,14 @@ describe('UserPreferencesManager', () => {
 			expect(userPreferencesManager.systemColorScheme.get()).toBe('light')
 
 			// Restore matchMedia
-			Object.defineProperty(window, 'matchMedia', {
-				writable: true,
-				value: mockMatchMedia,
-			})
+			window.matchMedia = mockMatchMedia
 		})
 
 		it('should initialize with light system color scheme when dark mode not preferred', () => {
 			mockMatchMedia.mockReturnValue({
 				matches: false,
-				addEventListener: jest.fn(),
-				removeEventListener: jest.fn(),
+				addEventListener: vi.fn(),
+				removeEventListener: vi.fn(),
 			})
 
 			userPreferencesManager = new UserPreferencesManager(mockUser, false)
@@ -86,8 +82,8 @@ describe('UserPreferencesManager', () => {
 		it('should initialize with dark system color scheme when dark mode preferred', () => {
 			mockMatchMedia.mockReturnValue({
 				matches: true,
-				addEventListener: jest.fn(),
-				removeEventListener: jest.fn(),
+				addEventListener: vi.fn(),
+				removeEventListener: vi.fn(),
 			})
 
 			userPreferencesManager = new UserPreferencesManager(mockUser, false)
@@ -96,8 +92,8 @@ describe('UserPreferencesManager', () => {
 		})
 
 		it('should set up media query listener for color scheme changes', () => {
-			const mockAddEventListener = jest.fn()
-			const mockRemoveEventListener = jest.fn()
+			const mockAddEventListener = vi.fn()
+			const mockRemoveEventListener = vi.fn()
 
 			mockMatchMedia.mockReturnValue({
 				matches: false,
@@ -111,7 +107,7 @@ describe('UserPreferencesManager', () => {
 		})
 
 		it('should handle media query change events', () => {
-			const mockAddEventListener = jest.fn()
+			const mockAddEventListener = vi.fn()
 			let changeHandler: (e: MediaQueryListEvent) => void
 
 			mockMatchMedia.mockReturnValue({
@@ -122,7 +118,7 @@ describe('UserPreferencesManager', () => {
 					}
 					mockAddEventListener(event, handler)
 				},
-				removeEventListener: jest.fn(),
+				removeEventListener: vi.fn(),
 			})
 
 			userPreferencesManager = new UserPreferencesManager(mockUser, false)
@@ -152,11 +148,11 @@ describe('UserPreferencesManager', () => {
 
 	describe('dispose', () => {
 		it('should remove media query listener on dispose', () => {
-			const mockRemoveEventListener = jest.fn()
+			const mockRemoveEventListener = vi.fn()
 
 			mockMatchMedia.mockReturnValue({
 				matches: false,
-				addEventListener: jest.fn(),
+				addEventListener: vi.fn(),
 				removeEventListener: mockRemoveEventListener,
 			})
 
@@ -169,8 +165,8 @@ describe('UserPreferencesManager', () => {
 		it('should call all disposables', () => {
 			userPreferencesManager = new UserPreferencesManager(mockUser, false)
 
-			const mockDisposable1 = jest.fn()
-			const mockDisposable2 = jest.fn()
+			const mockDisposable1 = vi.fn()
+			const mockDisposable2 = vi.fn()
 
 			userPreferencesManager.disposables.add(mockDisposable1)
 			userPreferencesManager.disposables.add(mockDisposable2)
@@ -231,6 +227,7 @@ describe('UserPreferencesManager', () => {
 				color: mockUserPreferences.color,
 				animationSpeed: mockUserPreferences.animationSpeed,
 				areKeyboardShortcutsEnabled: mockUserPreferences.areKeyboardShortcutsEnabled,
+				showUiLabels: mockUserPreferences.showUiLabels,
 				isSnapMode: mockUserPreferences.isSnapMode,
 				colorScheme: mockUserPreferences.colorScheme,
 				isDarkMode: false, // light mode
@@ -379,6 +376,17 @@ describe('UserPreferencesManager', () => {
 			})
 		})
 
+		describe('getShowUiLabels', () => {
+			it('should return user show ui labels setting', () => {
+				expect(userPreferencesManager.getShowUiLabels()).toBe(mockUserPreferences.showUiLabels)
+			})
+
+			it('should return default show ui labels when null', () => {
+				userPreferencesAtom.set({ ...mockUserPreferences, showUiLabels: null })
+				expect(userPreferencesManager.getShowUiLabels()).toBe(defaultUserPreferences.showUiLabels)
+			})
+		})
+
 		describe('getEdgeScrollSpeed', () => {
 			it('should return user edge scroll speed', () => {
 				expect(userPreferencesManager.getEdgeScrollSpeed()).toBe(

package/src/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.ts

@@ -13,7 +13,7 @@ export class UserPreferencesManager {
 		private readonly user: TLUser,
 		private readonly inferDarkMode: boolean
 	) {
-		if (typeof window === 'undefined' || !('matchMedia' in window)) return
+		if (typeof window === 'undefined' || !window.matchMedia) return
 
 		const darkModeMediaQuery = window.matchMedia('(prefers-color-scheme: dark)')
 		if (darkModeMediaQuery?.matches) {
@@ -49,6 +49,7 @@ export class UserPreferencesManager {
 			isDarkMode: this.getIsDarkMode(),
 			isWrapMode: this.getIsWrapMode(),
 			isDynamicResizeMode: this.getIsDynamicResizeMode(),
+			showUiLabels: this.getShowUiLabels(),
 		}
 	}
 
@@ -119,4 +120,8 @@ export class UserPreferencesManager {
 			defaultUserPreferences.isPasteAtCursorMode
 		)
 	}
+
+	@computed getShowUiLabels() {
+		return this.user.userPreferences.get().showUiLabels ?? defaultUserPreferences.showUiLabels
+	}
 }

package/src/lib/editor/shapes/ShapeUtil.ts

@@ -283,6 +283,17 @@ export abstract class ShapeUtil<Shape extends TLUnknownShape = TLUnknownShape> {
 		return true
 	}
 
+	/**
+	 * Whether this shape can be culled. By default, shapes are culled for
+	 * performance reasons when they are outside of the viewport. Culled shapes are still rendered
+	 * to the DOM, but have their `display` property set to `none`.
+	 *
+	 * @param shape - The shape.
+	 */
+	canCull(_shape: Shape): boolean {
+		return true
+	}
+
 	/**
 	 * Does this shape provide a background for its children? If this is true,
 	 * then any children with a `renderBackground` method will have their
@@ -296,6 +307,27 @@ export abstract class ShapeUtil<Shape extends TLUnknownShape = TLUnknownShape> {
 		return false
 	}
 
+	/**
+	 * Get the clip path to apply to this shape's children.
+	 *
+	 * @param shape - The shape to get the clip path for
+	 * @returns Array of points defining the clipping polygon in local coordinates, or undefined if no clipping
+	 * @public
+	 */
+	getClipPath?(shape: Shape): Vec[] | undefined
+
+	/**
+	 * Whether a specific child shape should be clipped by this shape.
+	 * Only called if getClipPath returns a valid polygon.
+	 *
+	 * If not defined, the default behavior is to clip all children.
+	 *
+	 * @param child - The child shape to check
+	 * @returns boolean indicating if this child should be clipped
+	 * @public
+	 */
+	shouldClipChild?(child: TLShape): boolean
+
 	/**
 	 * Whether the shape should hide its resize handles when selected.
 	 *
@@ -341,6 +373,20 @@ export abstract class ShapeUtil<Shape extends TLUnknownShape = TLUnknownShape> {
 		return false
 	}
 
+	/**
+	 * By default, the bounds of an image export are the bounds of all the shapes it contains, plus
+	 * some padding. If an export includes a shape where `isExportBoundsContainer` is true, then the
+	 * padding is skipped _if the bounds of that shape contains all the other shapes_. This is
+	 * useful in cases like annotating on top of an image, where you usually want to avoid extra
+	 * padding around the image if you don't need it.
+	 *
+	 * @param _shape - The shape to check
+	 * @returns True if this shape should be treated as an export bounds container
+	 */
+	isExportBoundsContainer(_shape: Shape): boolean {
+		return false
+	}
+
 	/**
 	 * Get a JSX element for the shape (as an HTML element) to be rendered as part of the canvas background - behind any other shape content.
 	 *

package/src/lib/editor/types/misc-types.ts

@@ -1,4 +1,4 @@
-import { BoxModel } from '@tldraw/tlschema'
+import { BoxModel, TLShape } from '@tldraw/tlschema'
 import { Box } from '../../primitives/Box'
 import { VecLike } from '../../primitives/Vec'
 
@@ -72,12 +72,6 @@ export interface TLImageExportOptions extends TLSvgExportOptions {
 	format?: TLExportType
 }
 
-/**
- * @public
- * @deprecated use {@link TLImageExportOptions} instead
- */
-export type TLSvgOptions = TLImageExportOptions
-
 /** @public */
 export interface TLCameraMoveOptions {
 	/** Whether to move the camera immediately, rather than on the next tick. */
@@ -206,3 +200,56 @@ export interface TLUpdatePointerOptions {
 	isPen?: boolean
 	button?: number
 }
+
+/**
+ * Options to {@link Editor.getShapeAtPoint}.
+ *
+ * @public
+ */
+export interface TLGetShapeAtPointOptions {
+	/**
+	 * The margin to apply to the shape.
+	 * If a number, it will be applied to both the inside and outside of the shape.
+	 * If an array, the first element will be applied to the inside of the shape, and the second element will be applied to the outside.
+	 *
+	 * @example
+	 * ```ts
+	 * // Get the shape at the center of the screen
+	 * const shape = editor.getShapeAtProps({
+	 *   margin: 10,
+	 * })
+	 *
+	 * // Get the shape at the center of the screen with a 10px inner margin and a 5px outer margin
+	 * const shape = editor.getShapeAtProps({
+	 *   margin: [10, 5],
+	 * })
+	 * ```
+	 */
+	margin?: number | [number, number]
+	/**
+	 * Whether to register hits inside of shapes (beyond the margin), such as the inside of a solid shape.
+	 */
+	hitInside?: boolean
+	/**
+	 * Whether to register hits on locked shapes.
+	 */
+	hitLocked?: boolean
+	/**
+	 * Whether to register hits on labels.
+	 */
+	hitLabels?: boolean
+	/**
+	 * Whether to only return hits on shapes that are currently being rendered.
+	 * todo: rename this to hitCulled or hitNotRendering
+	 */
+	renderingOnly?: boolean
+	/**
+	 * Whether to register hits on the inside of frame shapes.
+	 * todo: rename this to hitInsideFrames
+	 */
+	hitFrameInside?: boolean
+	/**
+	 * A filter function to apply to the shapes.
+	 */
+	filter?(shape: TLShape): boolean
+}