@tldraw/editor 4.3.0 → 4.4.0-canary.09e80a09d230

package/src/lib/editor/managers/SpatialIndexManager/RBushIndex.ts

@@ -0,0 +1,144 @@
+import type { TLShapeId } from '@tldraw/tlschema'
+import RBush from 'rbush'
+import { Box } from '../../../primitives/Box'
+
+/**
+ * Element stored in the R-tree spatial index.
+ * Contains bounds (minX, minY, maxX, maxY) and shape ID.
+ */
+export interface SpatialElement {
+	minX: number
+	minY: number
+	maxX: number
+	maxY: number
+	id: TLShapeId
+}
+
+/**
+ * Custom RBush class for tldraw shapes.
+ */
+class TldrawRBush extends RBush<SpatialElement> {}
+
+/**
+ * Wrapper around RBush R-tree for efficient spatial queries.
+ * Maintains a map of elements currently in the tree for efficient updates.
+ */
+export class RBushIndex {
+	private rBush: TldrawRBush
+	private elementsInTree: Map<TLShapeId, SpatialElement>
+
+	constructor() {
+		this.rBush = new TldrawRBush()
+		this.elementsInTree = new Map()
+	}
+
+	/**
+	 * Search for shapes within the given bounds.
+	 * Returns set of shape IDs that intersect with the bounds.
+	 */
+	search(bounds: Box): Set<TLShapeId> {
+		const results = this.rBush.search({
+			minX: bounds.minX,
+			minY: bounds.minY,
+			maxX: bounds.maxX,
+			maxY: bounds.maxY,
+		})
+		return new Set(results.map((e: SpatialElement) => e.id))
+	}
+
+	/**
+	 * Insert or update a shape in the spatial index.
+	 * If the shape already exists, it will be removed first to prevent duplicates.
+	 */
+	upsert(id: TLShapeId, bounds: Box): void {
+		// Remove existing entry to prevent map-tree desync
+		const existing = this.elementsInTree.get(id)
+		if (existing) {
+			this.rBush.remove(existing)
+		}
+
+		const element: SpatialElement = {
+			minX: bounds.minX,
+			minY: bounds.minY,
+			maxX: bounds.maxX,
+			maxY: bounds.maxY,
+			id,
+		}
+		this.rBush.insert(element)
+		this.elementsInTree.set(id, element)
+	}
+
+	/**
+	 * Remove a shape from the spatial index.
+	 */
+	remove(id: TLShapeId): void {
+		const element = this.elementsInTree.get(id)
+		if (element) {
+			this.rBush.remove(element)
+			this.elementsInTree.delete(id)
+		}
+	}
+
+	/**
+	 * Bulk load elements into the spatial index.
+	 * More efficient than individual inserts for initial loading.
+	 */
+	bulkLoad(elements: SpatialElement[]): void {
+		this.rBush.load(elements)
+		for (const element of elements) {
+			this.elementsInTree.set(element.id, element)
+		}
+	}
+
+	/**
+	 * Clear all elements from the spatial index.
+	 */
+	clear(): void {
+		this.rBush.clear()
+		this.elementsInTree.clear()
+	}
+
+	/**
+	 * Check if a shape is in the spatial index.
+	 */
+	has(id: TLShapeId): boolean {
+		return this.elementsInTree.has(id)
+	}
+
+	/**
+	 * Get the number of elements in the spatial index.
+	 */
+	getSize(): number {
+		return this.elementsInTree.size
+	}
+
+	/**
+	 * Get all shape IDs currently in the spatial index.
+	 */
+	getAllShapeIds(): TLShapeId[] {
+		return Array.from(this.elementsInTree.keys())
+	}
+
+	/**
+	 * Get the bounds currently stored in the spatial index for a shape.
+	 * Returns undefined if the shape is not in the index.
+	 */
+	getBounds(id: TLShapeId): Box | undefined {
+		const element = this.elementsInTree.get(id)
+		if (!element) return undefined
+		return new Box(
+			element.minX,
+			element.minY,
+			element.maxX - element.minX,
+			element.maxY - element.minY
+		)
+	}
+
+	/**
+	 * Dispose of the spatial index.
+	 * Clears all data structures to prevent memory leaks.
+	 */
+	dispose(): void {
+		this.clear()
+	}
+}

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

@@ -0,0 +1,214 @@
+import { Computed, RESET_VALUE, computed, isUninitialized } from '@tldraw/state'
+import type { RecordsDiff } from '@tldraw/store'
+import type { TLRecord } from '@tldraw/tlschema'
+import { TLPageId, TLShape, TLShapeId, isShape } from '@tldraw/tlschema'
+import { objectMapValues } from '@tldraw/utils'
+import { Box } from '../../../primitives/Box'
+import type { Editor } from '../../Editor'
+import { RBushIndex, type SpatialElement } from './RBushIndex'
+
+/**
+ * Manages spatial indexing for efficient shape location queries.
+ *
+ * Uses an R-tree (via RBush) to enable O(log n) spatial queries instead of O(n) iteration.
+ * Handles shapes with computed bounds (arrows, groups, custom shapes) by checking all shapes'
+ * bounds on each update using the reactive bounds cache.
+ *
+ * Key features:
+ * - Incremental updates using filterHistory pattern
+ * - Leverages existing bounds cache reactivity for dependency tracking
+ * - Works with any custom shape type with computed bounds
+ * - Per-page index (rebuilds on page change)
+ * - Optimized for viewport culling queries
+ *
+ * @internal
+ */
+export class SpatialIndexManager {
+	private rbush: RBushIndex
+	private spatialIndexComputed: Computed<number>
+	private lastPageId: TLPageId | null = null
+
+	constructor(public readonly editor: Editor) {
+		this.rbush = new RBushIndex()
+		this.spatialIndexComputed = this.createSpatialIndexComputed()
+	}
+
+	private createSpatialIndexComputed() {
+		const shapeHistory = this.editor.store.query.filterHistory('shape')
+
+		return computed<number>('spatialIndex', (_prevValue, lastComputedEpoch) => {
+			if (isUninitialized(_prevValue)) {
+				return this.buildFromScratch(lastComputedEpoch)
+			}
+
+			const shapeDiff = shapeHistory.getDiffSince(lastComputedEpoch)
+
+			if (shapeDiff === RESET_VALUE) {
+				return this.buildFromScratch(lastComputedEpoch)
+			}
+
+			const currentPageId = this.editor.getCurrentPageId()
+			if (this.lastPageId !== currentPageId) {
+				return this.buildFromScratch(lastComputedEpoch)
+			}
+
+			// No shape changes - index is already up to date
+			if (shapeDiff.length === 0) {
+				return lastComputedEpoch
+			}
+
+			// Process incremental updates
+			this.processIncrementalUpdate(shapeDiff)
+
+			return lastComputedEpoch
+		})
+	}
+
+	private buildFromScratch(epoch: number): number {
+		this.rbush.clear()
+		this.lastPageId = this.editor.getCurrentPageId()
+
+		const shapes = this.editor.getCurrentPageShapes()
+		const elements: SpatialElement[] = []
+
+		// Collect all shape elements for bulk loading
+		for (const shape of shapes) {
+			const bounds = this.editor.getShapePageBounds(shape.id)
+			if (bounds) {
+				elements.push({
+					minX: bounds.minX,
+					minY: bounds.minY,
+					maxX: bounds.maxX,
+					maxY: bounds.maxY,
+					id: shape.id,
+				})
+			}
+		}
+
+		// Bulk load for efficiency
+		this.rbush.bulkLoad(elements)
+
+		return epoch
+	}
+
+	private processIncrementalUpdate(shapeDiff: RecordsDiff<TLRecord>[]): void {
+		// Track shapes we've already processed from the diff
+		const processedShapeIds = new Set<TLShapeId>()
+
+		// 1. Process shape additions, removals, and updates from diff
+		for (const changes of shapeDiff) {
+			// Handle additions (only for shapes on current page)
+			for (const shape of objectMapValues(changes.added) as TLShape[]) {
+				if (isShape(shape) && this.editor.getAncestorPageId(shape) === this.lastPageId) {
+					const bounds = this.editor.getShapePageBounds(shape.id)
+					if (bounds) {
+						this.rbush.upsert(shape.id, bounds)
+					}
+					processedShapeIds.add(shape.id)
+				}
+			}
+
+			// Handle removals
+			for (const shape of objectMapValues(changes.removed) as TLShape[]) {
+				if (isShape(shape)) {
+					this.rbush.remove(shape.id)
+					processedShapeIds.add(shape.id)
+				}
+			}
+
+			// Handle updated shapes: page changes and bounds updates
+			for (const [, to] of objectMapValues(changes.updated) as [TLShape, TLShape][]) {
+				if (!isShape(to)) continue
+				processedShapeIds.add(to.id)
+
+				const isOnPage = this.editor.getAncestorPageId(to) === this.lastPageId
+
+				if (isOnPage) {
+					const bounds = this.editor.getShapePageBounds(to.id)
+					if (bounds) {
+						this.rbush.upsert(to.id, bounds)
+					}
+				} else {
+					this.rbush.remove(to.id)
+				}
+			}
+		}
+
+		// 2. Check remaining shapes in index for bounds changes
+		// This handles shapes with computed bounds (arrows bound to moved shapes, groups with moved children, etc.)
+		const allShapeIds = this.rbush.getAllShapeIds()
+
+		for (const shapeId of allShapeIds) {
+			if (processedShapeIds.has(shapeId)) continue
+
+			const currentBounds = this.editor.getShapePageBounds(shapeId)
+			const indexedBounds = this.rbush.getBounds(shapeId)
+
+			if (!this.areBoundsEqual(currentBounds, indexedBounds)) {
+				if (currentBounds) {
+					this.rbush.upsert(shapeId, currentBounds)
+				} else {
+					this.rbush.remove(shapeId)
+				}
+			}
+		}
+	}
+
+	private areBoundsEqual(a: Box | undefined, b: Box | undefined): boolean {
+		if (!a && !b) return true
+		if (!a || !b) return false
+		return a.minX === b.minX && a.minY === b.minY && a.maxX === b.maxX && a.maxY === b.maxY
+	}
+
+	/**
+	 * Get shape IDs within the given bounds.
+	 * Optimized for viewport culling queries.
+	 *
+	 * Note: Results are unordered. If you need z-order, combine with sorted shapes:
+	 * ```ts
+	 * const candidates = editor.spatialIndex.getShapeIdsInsideBounds(bounds)
+	 * const sorted = editor.getCurrentPageShapesSorted().filter(s => candidates.has(s.id))
+	 * ```
+	 *
+	 * @param bounds - The bounds to search within
+	 * @returns Unordered set of shape IDs within the bounds
+	 *
+	 * @public
+	 */
+	getShapeIdsInsideBounds(bounds: Box): Set<TLShapeId> {
+		this.spatialIndexComputed.get()
+		return this.rbush.search(bounds)
+	}
+
+	/**
+	 * Get shape IDs at a point (with optional margin).
+	 * Creates a small bounding box around the point and searches the spatial index.
+	 *
+	 * Note: Results are unordered. If you need z-order, combine with sorted shapes:
+	 * ```ts
+	 * const candidates = editor.spatialIndex.getShapeIdsAtPoint(point, margin)
+	 * const sorted = editor.getCurrentPageShapesSorted().filter(s => candidates.has(s.id))
+	 * ```
+	 *
+	 * @param point - The point to search at
+	 * @param margin - The margin around the point to search (default: 0)
+	 * @returns Unordered set of shape IDs that could potentially contain the point
+	 *
+	 * @public
+	 */
+	getShapeIdsAtPoint(point: { x: number; y: number }, margin = 0): Set<TLShapeId> {
+		this.spatialIndexComputed.get()
+		return this.rbush.search(new Box(point.x - margin, point.y - margin, margin * 2, margin * 2))
+	}
+
+	/**
+	 * Dispose of the spatial index manager.
+	 * Clears the R-tree to prevent memory leaks.
+	 *
+	 * @public
+	 */
+	dispose(): void {
+		this.rbush.dispose()
+		this.lastPageId = null
+	}
+}

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

@@ -31,6 +31,7 @@ describe('UserPreferencesManager', () => {
 		isDynamicSizeMode: false,
 		isPasteAtCursorMode: false,
 		inputMode: null,
+		isZoomDirectionInverted: false,
 		...overrides,
 	})
 
@@ -235,6 +236,7 @@ describe('UserPreferencesManager', () => {
 				isWrapMode: mockUserPreferences.isWrapMode,
 				isDynamicResizeMode: mockUserPreferences.isDynamicSizeMode,
 				inputMode: mockUserPreferences.inputMode,
+				isZoomDirectionInverted: mockUserPreferences.isZoomDirectionInverted,
 			})
 		})
 
@@ -475,6 +477,24 @@ describe('UserPreferencesManager', () => {
 				expect(userPreferencesManager.getInputMode()).toBe('mouse')
 			})
 		})
+
+		describe('getIsZoomDirectionInverted', () => {
+			it('should return user zoom direction inverted setting', () => {
+				expect(userPreferencesManager.getIsZoomDirectionInverted()).toBe(false)
+			})
+
+			it('should return default when null', () => {
+				userPreferencesAtom.set({ ...mockUserPreferences, isZoomDirectionInverted: null })
+				expect(userPreferencesManager.getIsZoomDirectionInverted()).toBe(
+					defaultUserPreferences.isZoomDirectionInverted
+				)
+			})
+
+			it('should return true when inverted', () => {
+				userPreferencesAtom.set({ ...mockUserPreferences, isZoomDirectionInverted: true })
+				expect(userPreferencesManager.getIsZoomDirectionInverted()).toBe(true)
+			})
+		})
 	})
 
 	describe('reactive behavior', () => {
@@ -536,6 +556,7 @@ describe('UserPreferencesManager', () => {
 				isWrapMode: null,
 				isDynamicSizeMode: null,
 				isPasteAtCursorMode: null,
+				isZoomDirectionInverted: null,
 			})
 
 			userPreferencesAtom.set(nullPrefs)
@@ -558,6 +579,9 @@ describe('UserPreferencesManager', () => {
 			expect(userPreferencesManager.getIsPasteAtCursorMode()).toBe(
 				defaultUserPreferences.isPasteAtCursorMode
 			)
+			expect(userPreferencesManager.getIsZoomDirectionInverted()).toBe(
+				defaultUserPreferences.isZoomDirectionInverted
+			)
 		})
 
 		it('should handle matchMedia with null response', () => {

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

@@ -51,6 +51,7 @@ export class UserPreferencesManager {
 			isDynamicResizeMode: this.getIsDynamicResizeMode(),
 			enhancedA11yMode: this.getEnhancedA11yMode(),
 			inputMode: this.getInputMode(),
+			isZoomDirectionInverted: this.getIsZoomDirectionInverted(),
 		}
 	}
 
@@ -131,4 +132,11 @@ export class UserPreferencesManager {
 	@computed getInputMode() {
 		return this.user.userPreferences.get().inputMode ?? defaultUserPreferences.inputMode
 	}
+
+	@computed getIsZoomDirectionInverted() {
+		return (
+			this.user.userPreferences.get().isZoomDirectionInverted ??
+			defaultUserPreferences.isZoomDirectionInverted
+		)
+	}
 }

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

@@ -75,6 +75,19 @@ export interface TLShapeUtilCanvasSvgDef {
 	component: React.ComponentType
 }
 
+/**
+ * Return type for {@link ShapeUtil.getIndicatorPath}. Can be either a simple Path2D
+ * or an object with additional rendering info like clip paths for complex indicators.
+ * @public
+ */
+export type TLIndicatorPath =
+	| Path2D
+	| {
+			path: Path2D
+			clipPath?: Path2D
+			additionalPaths?: Path2D[]
+	  }
+
 /** @public */
 export abstract class ShapeUtil<Shape extends TLShape = TLShape> {
 	/** Configure this shape utils {@link ShapeUtil.options | `options`}. */
@@ -173,6 +186,37 @@ export abstract class ShapeUtil<Shape extends TLShape = TLShape> {
 	 */
 	abstract indicator(shape: Shape): any
 
+	/**
+	 * Whether to use the legacy React-based indicator rendering.
+	 *
+	 * Override this to return `false` if your shape implements {@link ShapeUtil.getIndicatorPath}
+	 * for canvas-based indicator rendering.
+	 *
+	 * @returns `true` to use SVG indicators (default), `false` to use canvas indicators.
+	 * @public
+	 */
+	useLegacyIndicator(): boolean {
+		return true
+	}
+
+	/**
+	 * Get a Path2D for rendering the shape's indicator on the canvas.
+	 *
+	 * When implemented, this is used instead of {@link ShapeUtil.indicator} for more
+	 * efficient canvas-based indicator rendering. Shapes that return `undefined` will
+	 * fall back to SVG-based rendering via {@link ShapeUtil.indicator}.
+	 *
+	 * For complex indicators that need clipping (e.g., arrows with labels), return an
+	 * object with `path`, `clipPath`, and `additionalPaths` properties.
+	 *
+	 * @param shape - The shape.
+	 * @returns A Path2D to stroke, or an object with clipping info, or undefined to use SVG fallback.
+	 * @public
+	 */
+	getIndicatorPath(shape: Shape): TLIndicatorPath | undefined {
+		return undefined
+	}
+
 	/**
 	 * Get the font faces that should be rendered in the document in order for this shape to render
 	 * correctly.

package/src/lib/hooks/usePeerIds.ts

@@ -1,4 +1,10 @@
-import { useComputed, useValue } from '@tldraw/state-react'
+import { useAtom, useComputed, useValue } from '@tldraw/state-react'
+import { isEqual } from '@tldraw/utils'
+import { useEffect } from 'react'
+import {
+	getCollaboratorStateFromElapsedTime,
+	shouldShowCollaborator,
+} from '../utils/collaboratorState'
 import { uniq } from '../utils/uniq'
 import { useEditor } from './useEditor'
 
@@ -19,3 +25,42 @@ export function usePeerIds() {
 
 	return useValue($userIds)
 }
+
+/**
+ * Returns a computed signal of active peer user IDs that should be shown.
+ * Automatically re-evaluates on an interval to handle time-based state transitions
+ * (active -> idle -> inactive).
+ *
+ * @returns A computed signal containing a Set of active peer user IDs
+ * @internal
+ */
+export function useActivePeerIds$() {
+	const $time = useAtom('peerIdsTime', Date.now())
+	const editor = useEditor()
+	useEffect(() => {
+		const interval = editor.timers.setInterval(() => {
+			$time.set(Date.now())
+		}, editor.options.collaboratorCheckIntervalMs)
+
+		return () => clearInterval(interval)
+	}, [editor, $time])
+
+	return useComputed(
+		'activePeerIds',
+		() => {
+			const now = $time.get()
+			return new Set(
+				editor
+					.getCollaborators()
+					.filter((p) => {
+						const elapsed = Math.max(0, now - (p.lastActivityTimestamp ?? Infinity))
+						const state = getCollaboratorStateFromElapsedTime(editor, elapsed)
+						return shouldShowCollaborator(editor, p, state)
+					})
+					.map((p) => p.userId)
+			)
+		},
+		{ isEqual },
+		[editor]
+	)
+}

package/src/lib/options.ts

@@ -54,6 +54,12 @@ export interface TldrawOptions {
 	readonly flattenImageBoundsExpand: number
 	readonly flattenImageBoundsPadding: number
 	readonly laserDelayMs: number
+	/**
+	 * How long (in milliseconds) to fade all laser scribbles after the session ends.
+	 * The total points across all scribbles will be removed proportionally over this duration.
+	 * Defaults to 500ms (0.5 seconds).
+	 */
+	readonly laserFadeoutMs: number
 	readonly maxExportDelayMs: number
 	readonly tooltipDelayMs: number
 	/**
@@ -157,6 +163,7 @@ export const defaultTldrawOptions = {
 	flattenImageBoundsExpand: 64,
 	flattenImageBoundsPadding: 16,
 	laserDelayMs: 1200,
+	laserFadeoutMs: 500,
 	maxExportDelayMs: 5000,
 	tooltipDelayMs: 700,
 	temporaryAssetPreviewLifetimeMs: 180000,

package/src/lib/utils/collaboratorState.ts

@@ -0,0 +1,54 @@
+import { TLInstancePresence } from '@tldraw/tlschema'
+import { Editor } from '../editor/Editor'
+
+/** The activity state of a collaborator */
+export type CollaboratorState = 'active' | 'idle' | 'inactive'
+
+/**
+ * Get the activity state of a collaborator based on elapsed time since their last activity.
+ *
+ * @param editor - The editor instance
+ * @param elapsed - Time in milliseconds since the collaborator's last activity
+ * @returns The collaborator's activity state
+ */
+export function getCollaboratorStateFromElapsedTime(
+	editor: Editor,
+	elapsed: number
+): CollaboratorState {
+	return elapsed > editor.options.collaboratorInactiveTimeoutMs
+		? 'inactive'
+		: elapsed > editor.options.collaboratorIdleTimeoutMs
+			? 'idle'
+			: 'active'
+}
+
+/**
+ * Determine whether a collaborator should be shown based on their activity state
+ * and the current instance state (following, highlighted users, etc.).
+ *
+ * @param editor - The editor instance
+ * @param presence - The collaborator's presence data
+ * @param state - The collaborator's activity state
+ * @returns Whether the collaborator should be shown
+ */
+export function shouldShowCollaborator(
+	editor: Editor,
+	presence: TLInstancePresence,
+	state: CollaboratorState
+): boolean {
+	const { followingUserId, highlightedUserIds } = editor.getInstanceState()
+
+	switch (state) {
+		case 'inactive':
+			// If they're inactive, only show if we're following them or they're highlighted
+			return followingUserId === presence.userId || highlightedUserIds.includes(presence.userId)
+		case 'idle':
+			// If they're idle and following us, hide them unless they have a chat message or are highlighted
+			if (presence.followingUserId === editor.user.getId()) {
+				return !!(presence.chatMessage || highlightedUserIds.includes(presence.userId))
+			}
+			return true
+		case 'active':
+			return true
+	}
+}

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 = '4.3.0'
+export const version = '4.4.0-canary.09e80a09d230'
 export const publishDates = {
 	major: '2025-09-18T14:39:22.803Z',
-	minor: '2026-01-21T11:56:39.106Z',
-	patch: '2026-01-21T11:56:39.106Z',
+	minor: '2026-01-28T13:48:07.522Z',
+	patch: '2026-01-28T13:48:07.522Z',
 }