@tldraw/editor 4.3.0-canary.2362fd2ebe56 → 4.3.0-canary.2643056dfc8d

package/dist-cjs/index.d.ts

@@ -1,4 +1,5 @@
 import { Atom } from '@tldraw/state';
+import { AtomSet } from '@tldraw/store';
 import { BoxModel } from '@tldraw/tlschema';
 import { ComponentType } from 'react';
 import { Computed } from '@tldraw/state';
@@ -9,10 +10,11 @@ import EventEmitter from 'eventemitter3';
 import { ExoticComponent } from 'react';
 import { ExtractShapeByProps } from '@tldraw/tlschema';
 import { ForwardRefExoticComponent } from 'react';
+import { FragmentProps } from 'react';
 import { HistoryEntry } from '@tldraw/store';
 import { IndexKey } from '@tldraw/utils';
 import { JsonObject } from '@tldraw/utils';
-import { JSX as JSX_2 } from 'react/jsx-runtime';
+import { JSX } from 'react/jsx-runtime';
 import { LegacyMigrations } from '@tldraw/store';
 import { MigrationSequence } from '@tldraw/store';
 import { NamedExoticComponent } from 'react';
@@ -488,6 +490,7 @@ export declare class Box {
     get cornersAndCenter(): Vec[];
     get sides(): Array<[Vec, Vec]>;
     get size(): Vec;
+    isValid(): boolean;
     toFixed(): this;
     setTo(B: Box): this;
     set(x?: number, y?: number, w?: number, h?: number): this;
@@ -655,7 +658,7 @@ export declare function clockwiseAngleDist(a0: number, a1: number): number;
  * @public
  * @react
  */
-export declare function ContainerProvider({ container, children }: ContainerProviderProps): JSX_2.Element;
+export declare function ContainerProvider({ container, children }: ContainerProviderProps): JSX.Element;
 
 /** @public */
 export declare interface ContainerProviderProps {
@@ -796,16 +799,16 @@ export declare interface DebugFlagDefaults<T> {
 /* Excluded from this release type: DEFAULT_CAMERA_OPTIONS */
 
 /** @public @react */
-export declare function DefaultBackground(): JSX_2.Element;
+export declare function DefaultBackground(): JSX.Element;
 
 /** @public @react */
-export declare const DefaultBrush: ({ brush, color, opacity, className }: TLBrushProps) => JSX_2.Element;
+export declare const DefaultBrush: ({ brush, color, opacity, className }: TLBrushProps) => JSX.Element;
 
 /** @public @react */
-export declare function DefaultCanvas({ className }: TLCanvasComponentProps): JSX_2.Element;
+export declare function DefaultCanvas({ className }: TLCanvasComponentProps): JSX.Element;
 
 /** @public @react */
-export declare function DefaultCollaboratorHint({ className, zoom, point, color, viewport, opacity, }: TLCollaboratorHintProps): JSX_2.Element;
+export declare function DefaultCollaboratorHint({ className, zoom, point, color, viewport, opacity, }: TLCollaboratorHintProps): JSX.Element;
 
 /** @public @react */
 export declare const DefaultCursor: NamedExoticComponent<TLCursorProps>;
@@ -814,22 +817,22 @@ export declare const DefaultCursor: NamedExoticComponent<TLCursorProps>;
 export declare const DefaultErrorFallback: TLErrorFallbackComponent;
 
 /** @public @react */
-export declare function DefaultGrid({ x, y, z, size }: TLGridProps): JSX_2.Element;
+export declare function DefaultGrid({ x, y, z, size }: TLGridProps): JSX.Element;
 
 /** @public @react */
-export declare function DefaultHandle({ handle, isCoarse, className, zoom }: TLHandleProps): JSX_2.Element;
+export declare function DefaultHandle({ handle, isCoarse, className, zoom }: TLHandleProps): JSX.Element;
 
 /** @public @react */
-export declare const DefaultHandles: ({ children }: TLHandlesProps) => JSX_2.Element;
+export declare const DefaultHandles: ({ children }: TLHandlesProps) => JSX.Element;
 
 /** @public @react */
-export declare function DefaultScribble({ scribble, zoom, color, opacity, className }: TLScribbleProps): JSX_2.Element | null;
+export declare function DefaultScribble({ scribble, zoom, color, opacity, className }: TLScribbleProps): JSX.Element | null;
 
 /** @public @react */
-export declare function DefaultSelectionBackground({ bounds, rotation }: TLSelectionBackgroundProps): JSX_2.Element;
+export declare function DefaultSelectionBackground({ bounds, rotation }: TLSelectionBackgroundProps): JSX.Element;
 
 /** @public @react */
-export declare function DefaultSelectionForeground({ bounds, rotation }: TLSelectionForegroundProps): JSX_2.Element;
+export declare function DefaultSelectionForeground({ bounds, rotation }: TLSelectionForegroundProps): JSX.Element;
 
 /** @public @react */
 export declare const DefaultShapeIndicator: NamedExoticComponent<TLShapeIndicatorProps>;
@@ -841,10 +844,10 @@ export declare const DefaultShapeIndicators: NamedExoticComponent<TLShapeIndicat
 export declare const DefaultShapeWrapper: ForwardRefExoticComponent<TLShapeWrapperProps & RefAttributes<HTMLDivElement>>;
 
 /** @public @react */
-export declare function DefaultSnapIndicator({ className, line, zoom }: TLSnapIndicatorProps): JSX_2.Element;
+export declare function DefaultSnapIndicator({ className, line, zoom }: TLSnapIndicatorProps): JSX.Element;
 
 /** @public @react */
-export declare function DefaultSpinner(props: React.SVGProps<SVGSVGElement>): JSX_2.Element;
+export declare function DefaultSpinner(props: React.SVGProps<SVGSVGElement>): JSX.Element;
 
 /** @public @react */
 export declare const DefaultSvgDefs: () => null;
@@ -863,6 +866,8 @@ export declare const defaultTldrawOptions: {
     readonly collaboratorIdleTimeoutMs: 3000;
     readonly collaboratorInactiveTimeoutMs: 60000;
     readonly createTextOnCanvasDoubleClick: true;
+    readonly debouncedZoom: true;
+    readonly debouncedZoomThreshold: 500;
     readonly defaultSvgPadding: 32;
     readonly doubleClickDurationMs: 450;
     readonly dragDistanceSquared: 16;
@@ -871,9 +876,7 @@ export declare const defaultTldrawOptions: {
     readonly edgeScrollEaseDuration: 200;
     readonly edgeScrollSpeed: 25;
     readonly enableToolbarKeyboardShortcuts: true;
-    readonly exportProvider: ExoticComponent<    {
-    children?: ReactNode | undefined;
-    }>;
+    readonly exportProvider: ExoticComponent<FragmentProps>;
     readonly flattenImageBoundsExpand: 64;
     readonly flattenImageBoundsPadding: 16;
     readonly followChaseViewportSnap: 2;
@@ -905,11 +908,14 @@ export declare const defaultTldrawOptions: {
     readonly maxShapesPerPage: 4000;
     readonly multiClickDurationMs: 200;
     readonly nonce: undefined;
+    readonly snapThreshold: 8;
+    readonly spacebarPanning: true;
     readonly temporaryAssetPreviewLifetimeMs: 180000;
     readonly textShadowLod: 0.35;
     readonly tooltipDelayMs: 700;
     readonly uiCoarseDragDistanceSquared: 625;
     readonly uiDragDistanceSquared: 16;
+    readonly zoomToFitPadding: 128;
 };
 
 /** @public */
@@ -983,6 +989,7 @@ export declare class EdgeScrollManager {
     constructor(editor: Editor);
     private _isEdgeScrolling;
     private _edgeScrollDuration;
+    getIsEdgeScrolling(): boolean;
     /**
      * Update the camera position when the mouse is close to the edge of the screen.
      * Run this on every tick when in a state where edge scrolling is enabled.
@@ -1041,7 +1048,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      */
     removeTool(Tool: TLStateNodeConstructor, parent?: StateNode): void;
     /**
-     * A set of functions to call when the app is disposed.
+     * A set of functions to call when the editor is disposed.
      *
      * @public
      */
@@ -1054,11 +1061,23 @@ export declare class Editor extends EventEmitter<TLEventMap> {
     isDisposed: boolean;
     /* Excluded from this release type: _tickManager */
     /**
-     * A manager for the app's snapping feature.
+     * A manager for the editor's input state.
+     *
+     * @public
+     */
+    readonly inputs: InputsManager;
+    /**
+     * A manager for the editor's snapping feature.
      *
      * @public
      */
     readonly snaps: SnapManager;
+    /**
+     * A manager for spatial indexing, enabling efficient shape location queries.
+     *
+     * @public
+     */
+    readonly spatialIndex: SpatialIndexManager;
     /**
      * A manager for the any asynchronous events and making sure they're
      * cleaned up upon disposal.
@@ -1195,7 +1214,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
     } | S): BindingUtil<S>;
     getBindingUtil<T extends BindingUtil>(type: T extends BindingUtil<infer R> ? R['type'] : string): T;
     /**
-     * A manager for the app's history.
+     * A manager for the editor's history.
      *
      * @readonly
      */
@@ -1212,10 +1231,11 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      */
     undo(): this;
     /**
-     * Whether the app can undo.
+     * Whether the editor can undo.
      *
      * @public
      */
+    canUndo(): boolean;
     getCanUndo(): boolean;
     /**
      * Redo to the next mark.
@@ -1228,13 +1248,14 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * @public
      */
     redo(): this;
-    clearHistory(): this;
     /**
-     * Whether the app can redo.
+     * Whether the editor can redo.
      *
      * @public
      */
+    canRedo(): boolean;
     getCanRedo(): boolean;
+    clearHistory(): this;
     /**
      * Create a new "mark", or stopping point, in the undo redo history. Creating a mark will clear
      * any redos. You typically want to do this just before a user interaction begins or is handled.
@@ -1593,7 +1614,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      */
     selectNone(): this;
     /**
-     * The id of the app's only selected shape.
+     * The id of the editor's only selected shape.
      *
      * @returns Null if there is no shape or more than one selected shape, otherwise the selected shape's id.
      *
@@ -1602,7 +1623,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      */
     getOnlySelectedShapeId(): null | TLShapeId;
     /**
-     * The app's only selected shape.
+     * The editor's only selected shape.
      *
      * @returns Null if there is no shape or more than one selected shape, otherwise the selected shape.
      *
@@ -1694,6 +1715,16 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * @public
      */
     getEditingShape(): TLShape | undefined;
+    /**
+     * Whether the shape can be edited.
+     *
+     * @param shape - The shape (or shape id) to check if it can be edited.
+     * @param info - The info about the edit start.
+     *
+     * @public
+     * @returns true if the shape can be edited, false otherwise.
+     */
+    canEditShape<T extends TLShape | TLShapeId>(shape: null | T, info?: TLEditStartInfo): shape is T;
     /**
      * Set the current editing shape.
      *
@@ -1813,6 +1844,15 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * @public
      */
     getCroppingShapeId(): null | TLShapeId;
+    /**
+     * Whether the shape can be cropped.
+     *
+     * @param shape - The shape (or shape id) to check if it can be cropped.
+     *
+     * @public
+     * @returns true if the shape can be cropped, false otherwise.
+     */
+    canCropShape<T extends TLShape | TLShapeId>(shape: null | T): shape is T;
     /**
      * Set the current cropping shape.
      *
@@ -1855,6 +1895,32 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * @public
      */
     getZoomLevel(): number;
+    private _debouncedZoomLevel;
+    /**
+     * Get the debounced zoom level. When the camera is moving, this returns the zoom level
+     * from when the camera started moving rather than the current zoom level. This can be
+     * used to avoid expensive re-renders during camera movements.
+     *
+     * This behavior is controlled by the `useDebouncedZoom` option. When `useDebouncedZoom`
+     * is `false`, this method always returns the current zoom level.
+     *
+     * @public
+     */
+    getDebouncedZoomLevel(): number;
+    private _getAboveDebouncedZoomThreshold;
+    /**
+     * Get the efficient zoom level. This returns the current zoom level if there are less than 300 shapes on the page,
+     * otherwise it returns the debounced zoom level. This can be used to avoid expensive re-renders during camera movements.
+     *
+     * @public
+     * @example
+     * ```ts
+     * editor.getEfficientZoomLevel()
+     * ```
+     *
+     * @public
+     */
+    getEfficientZoomLevel(): number;
     /**
      * Get the camera's initial or reset zoom level.
      *
@@ -1969,7 +2035,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * ```ts
      * editor.zoomIn()
      * editor.zoomIn(editor.getViewportScreenCenter(), { animation: { duration: 200 } })
-     * editor.zoomIn(editor.inputs.currentScreenPoint, { animation: { duration: 200 } })
+     * editor.zoomIn(editor.inputs.getCurrentScreenPoint(), { animation: { duration: 200 } })
      * ```
      *
      * @param point - The screen point to zoom in on. Defaults to the screen center
@@ -1985,7 +2051,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * ```ts
      * editor.zoomOut()
      * editor.zoomOut(editor.getViewportScreenCenter(), { animation: { duration: 120 } })
-     * editor.zoomOut(editor.inputs.currentScreenPoint, { animation: { duration: 120 } })
+     * editor.zoomOut(editor.inputs.getCurrentScreenPoint(), { animation: { duration: 120 } })
      * ```
      *
      * @param point - The point to zoom out on. Defaults to the viewport screen center.
@@ -2198,8 +2264,8 @@ export declare class Editor extends EventEmitter<TLEventMap> {
     /* Excluded from this release type: getUnorderedRenderingShapes */
     private _cameraState;
     private _cameraStateTimeoutRemaining;
-    _decayCameraStateTimeout(elapsed: number): void;
-    _tickCameraState(): void;
+    private _decayCameraStateTimeout;
+    private _tickCameraState;
     /**
      * Whether the camera is moving or idle.
      *
@@ -2648,6 +2714,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      */
     getNotVisibleShapes(): Set<TLShapeId>;
     private _notVisibleShapes;
+    private _culledShapesCache;
     /**
      * Get culled shapes (those that should not render), taking into account which shapes are selected or editing.
      *
@@ -2697,6 +2764,22 @@ export declare class Editor extends EventEmitter<TLEventMap> {
         hitInside?: boolean;
         margin?: number;
     }): TLShape[];
+    /**
+     * Get shape IDs within the given bounds.
+     *
+     * Note: Results are unordered. If you need z-order, combine with sorted shapes:
+     * ```ts
+     * const candidates = editor.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 given bounds.
+     *
+     * @public
+     */
+    getShapeIdsInsideBounds(bounds: Box): Set<TLShapeId>;
     /**
      * Test whether a point (in the current page space) will will a shape. This method takes into account masks,
      * such as when a shape is the child of a frame and is partially clipped by the frame.
@@ -3720,59 +3803,6 @@ export declare class Editor extends EventEmitter<TLEventMap> {
         url: string;
         width: number;
     }>;
-    /**
-     * The app's current input state.
-     *
-     * @public
-     */
-    inputs: {
-        /** A set containing the currently pressed buttons. */
-        buttons: Set<number>;
-        /** A set containing the currently pressed keys. */
-        keys: Set<string>;
-        /** The most recent pointer down's position in screen space. */
-        originScreenPoint: Vec;
-        /** The most recent pointer down's position in the current page space. */
-        originPagePoint: Vec;
-        /** The most recent pointer position in screen space. */
-        currentScreenPoint: Vec;
-        /** The most recent pointer position in the current page space. */
-        currentPagePoint: Vec;
-        /** The previous pointer position in screen space. */
-        previousScreenPoint: Vec;
-        /** The previous pointer position in the current page space. */
-        previousPagePoint: Vec;
-        /** Velocity of mouse pointer, in pixels per millisecond */
-        pointerVelocity: Vec;
-        /** Whether the alt or option key is currently pressed. */
-        altKey: boolean;
-        /** Whether the control or command key is currently pressed. */
-        ctrlKey: boolean;
-        /** Whether the input is from a pe. */
-        isPen: boolean;
-        /** Whether the meta key is currently pressed. */
-        metaKey: boolean;
-        /** Whether the shift key is currently pressed. */
-        shiftKey: boolean;
-        /** Whether the user is dragging. */
-        isDragging: boolean;
-        /** Whether the user is editing. */
-        isEditing: boolean;
-        /** Whether the user is panning. */
-        isPanning: boolean;
-        /** Whether the user is pinching. */
-        isPinching: boolean;
-        /** Whether the user is pointing. */
-        isPointing: boolean;
-        /** Whether the user is spacebar panning. */
-        isSpacebarPanning: boolean;
-    };
-    /**
-     * Update the input points from a pointer, pinch, or wheel event.
-     *
-     * @param info - The event info.
-     */
-    private _updateInputsFromEvent;
     /**
      * Dispatch a cancel event.
      *
@@ -4018,7 +4048,6 @@ export declare class Editor extends EventEmitter<TLEventMap> {
     /* Excluded from this release type: _metaKeyTimeout */
     /* Excluded from this release type: _setMetaKeyTimeout */
     /* Excluded from this release type: _restoreToolId */
-    /* Excluded from this release type: _pinchStart */
     /* Excluded from this release type: _didPinch */
     /* Excluded from this release type: _selectedShapeIdsAtPointerDown */
     /* Excluded from this release type: _longPressTimeout */
@@ -4093,7 +4122,7 @@ export declare class EditorAtom<T> {
 export declare const EditorContext: React_3.Context<Editor | null>;
 
 /** @public @react */
-export declare function EditorProvider({ editor, children }: EditorProviderProps): JSX_2.Element;
+export declare function EditorProvider({ editor, children }: EditorProviderProps): JSX.Element;
 
 /** @public */
 export declare interface EditorProviderProps {
@@ -4124,7 +4153,7 @@ export declare class Ellipse2d extends Geometry2d {
 }
 
 /** @public */
-export declare class ErrorBoundary extends React_2.Component<React_2.PropsWithRef<React_2.PropsWithChildren<TLErrorBoundaryProps>>, {
+export declare class ErrorBoundary extends React_2.Component<React_2.PropsWithChildren<TLErrorBoundaryProps>, {
     error: Error | null;
 }> {
     static getDerivedStateFromError(error: Error): {
@@ -4134,11 +4163,11 @@ export declare class ErrorBoundary extends React_2.Component<React_2.PropsWithRe
         error: null;
     };
     componentDidCatch(error: unknown): void;
-    render(): boolean | JSX_2.Element | Iterable<React_2.ReactNode> | null | number | string | undefined;
+    render(): bigint | boolean | JSX.Element | Iterable<React_2.ReactNode> | null | number | Promise<bigint | boolean | Iterable<React_2.ReactNode> | null | number | React_2.ReactElement<unknown, React_2.JSXElementConstructor<any> | string> | React_2.ReactPortal | string | undefined> | string | undefined;
 }
 
 /** @public @react */
-export declare function ErrorScreen({ children }: LoadingScreenProps): JSX_2.Element;
+export declare function ErrorScreen({ children }: LoadingScreenProps): JSX.Element;
 
 /** @public */
 export declare const EVENT_NAME_MAP: Record<Exclude<TLEventName, TLPinchEventName>, keyof TLEventHandlers>;
@@ -4438,8 +4467,8 @@ export declare class GroupShapeUtil extends ShapeUtil<TLGroupShape> {
     canResizeChildren(): boolean;
     getDefaultProps(): TLGroupShape['props'];
     getGeometry(shape: TLGroupShape): Geometry2d;
-    component(shape: TLGroupShape): JSX_2.Element | null;
-    indicator(shape: TLGroupShape): JSX_2.Element;
+    component(shape: TLGroupShape): JSX.Element | null;
+    indicator(shape: TLGroupShape): JSX.Element;
     onChildrenChange(group: TLGroupShape): void;
 }
 
@@ -4543,7 +4572,7 @@ export declare class HistoryManager<R extends UnknownRecord> {
 }
 
 /** @public @react */
-export declare function HTMLContainer({ children, className, ...rest }: HTMLContainerProps): JSX_2.Element;
+export declare function HTMLContainer({ children, className, ...rest }: HTMLContainerProps): JSX.Element;
 
 /** @public */
 export declare type HTMLContainerProps = React_2.HTMLAttributes<HTMLDivElement>;
@@ -4551,6 +4580,248 @@ export declare type HTMLContainerProps = React_2.HTMLAttributes<HTMLDivElement>;
 /** @public */
 export declare const inlineBase64AssetStore: TLAssetStore;
 
+/** @public */
+export declare class InputsManager {
+    private readonly editor;
+    constructor(editor: Editor);
+    private _originPagePoint;
+    /**
+     * The most recent pointer down's position in the current page space.
+     */
+    getOriginPagePoint(): Vec;
+    /**
+     * @deprecated Use `getOriginPagePoint()` instead.
+     */
+    get originPagePoint(): Vec;
+    private _originScreenPoint;
+    /**
+     * The most recent pointer down's position in screen space.
+     */
+    getOriginScreenPoint(): Vec;
+    /**
+     * @deprecated Use `getOriginScreenPoint()` instead.
+     */
+    get originScreenPoint(): Vec;
+    private _previousPagePoint;
+    /**
+     * The previous pointer position in the current page space.
+     */
+    getPreviousPagePoint(): Vec;
+    /**
+     * @deprecated Use `getPreviousPagePoint()` instead.
+     */
+    get previousPagePoint(): Vec;
+    private _previousScreenPoint;
+    /**
+     * The previous pointer position in screen space.
+     */
+    getPreviousScreenPoint(): Vec;
+    /**
+     * @deprecated Use `getPreviousScreenPoint()` instead.
+     */
+    get previousScreenPoint(): Vec;
+    private _currentPagePoint;
+    /**
+     * The most recent pointer position in the current page space.
+     */
+    getCurrentPagePoint(): Vec;
+    /**
+     * @deprecated Use `getCurrentPagePoint()` instead.
+     */
+    get currentPagePoint(): Vec;
+    private _currentScreenPoint;
+    /**
+     * The most recent pointer position in screen space.
+     */
+    getCurrentScreenPoint(): Vec;
+    /**
+     * @deprecated Use `getCurrentScreenPoint()` instead.
+     */
+    get currentScreenPoint(): Vec;
+    private _pointerVelocity;
+    /**
+     * Velocity of mouse pointer, in pixels per millisecond.
+     */
+    getPointerVelocity(): Vec;
+    /**
+     * @deprecated Use `getPointerVelocity()` instead.
+     */
+    get pointerVelocity(): Vec;
+    /* Excluded from this release type: setPointerVelocity */
+    /**
+     * A set containing the currently pressed keys.
+     */
+    readonly keys: AtomSet<string>;
+    /**
+     * A set containing the currently pressed buttons.
+     */
+    readonly buttons: AtomSet<number>;
+    private _isPen;
+    /**
+     * Whether the input is from a pen.
+     */
+    getIsPen(): boolean;
+    /**
+     * @deprecated Use `getIsPen()` instead.
+     */
+    get isPen(): boolean;
+    set isPen(isPen: boolean);
+    /**
+     * @param isPen - Whether the input is from a pen.
+     */
+    setIsPen(isPen: boolean): void;
+    private _shiftKey;
+    /**
+     * Whether the shift key is currently pressed.
+     */
+    getShiftKey(): boolean;
+    /**
+     * @deprecated Use `getShiftKey()` instead.
+     */
+    get shiftKey(): boolean;
+    set shiftKey(shiftKey: boolean);
+    /* Excluded from this release type: setShiftKey */
+    private _metaKey;
+    /**
+     * Whether the meta key is currently pressed.
+     */
+    getMetaKey(): boolean;
+    /**
+     * @deprecated Use `getMetaKey()` instead.
+     */
+    get metaKey(): boolean;
+    set metaKey(metaKey: boolean);
+    /* Excluded from this release type: setMetaKey */
+    private _ctrlKey;
+    /**
+     * Whether the ctrl or command key is currently pressed.
+     */
+    getCtrlKey(): boolean;
+    /**
+     * @deprecated Use `getCtrlKey()` instead.
+     */
+    get ctrlKey(): boolean;
+    set ctrlKey(ctrlKey: boolean);
+    /* Excluded from this release type: setCtrlKey */
+    private _altKey;
+    /**
+     * Whether the alt or option key is currently pressed.
+     */
+    getAltKey(): boolean;
+    /**
+     * @deprecated Use `getAltKey()` instead.
+     */
+    get altKey(): boolean;
+    set altKey(altKey: boolean);
+    /* Excluded from this release type: setAltKey */
+    /**
+     * Is the accelerator key (cmd on mac, ctrl elsewhere) currently pressed.
+     */
+    getAccelKey(): boolean;
+    /**
+     * @deprecated Use `getAccelKey()` instead.
+     */
+    get accelKey(): boolean;
+    private _isDragging;
+    /**
+     * Whether the user is dragging.
+     */
+    getIsDragging(): boolean;
+    /**
+     * Soon to be deprecated, use `getIsDragging()` instead.
+     */
+    get isDragging(): boolean;
+    set isDragging(isDragging: boolean);
+    /**
+     * @param isDragging - Whether the user is dragging.
+     */
+    setIsDragging(isDragging: boolean): void;
+    private _isPointing;
+    /**
+     * Whether the user is pointing.
+     */
+    getIsPointing(): boolean;
+    /**
+     * @deprecated Use `getIsPointing()` instead.
+     */
+    get isPointing(): boolean;
+    set isPointing(isPointing: boolean);
+    /* Excluded from this release type: setIsPointing */
+    private _isPinching;
+    /**
+     * Whether the user is pinching.
+     */
+    getIsPinching(): boolean;
+    /**
+     * @deprecated Use `getIsPinching()` instead.
+     */
+    get isPinching(): boolean;
+    set isPinching(isPinching: boolean);
+    /* Excluded from this release type: setIsPinching */
+    private _isEditing;
+    /**
+     * Whether the user is editing.
+     */
+    getIsEditing(): boolean;
+    /**
+     * @deprecated Use `getIsEditing()` instead.
+     */
+    get isEditing(): boolean;
+    set isEditing(isEditing: boolean);
+    /**
+     * @param isEditing - Whether the user is editing.
+     */
+    setIsEditing(isEditing: boolean): void;
+    private _isPanning;
+    /**
+     * Whether the user is panning.
+     */
+    getIsPanning(): boolean;
+    /**
+     * @deprecated Use `getIsPanning()` instead.
+     */
+    get isPanning(): boolean;
+    set isPanning(isPanning: boolean);
+    /* Excluded from this release type: setIsPanning */
+    private _isSpacebarPanning;
+    /**
+     * Whether the user is spacebar panning.
+     */
+    getIsSpacebarPanning(): boolean;
+    /**
+     * @deprecated Use `getIsSpacebarPanning()` instead.
+     */
+    get isSpacebarPanning(): boolean;
+    set isSpacebarPanning(isSpacebarPanning: boolean);
+    /* Excluded from this release type: setIsSpacebarPanning */
+    private _getHasCollaborators;
+    /* Excluded from this release type: _velocityPrevPoint */
+    /* Excluded from this release type: updatePointerVelocity */
+    /* Excluded from this release type: updateFromEvent */
+    toJson(): {
+        altKey: boolean;
+        buttons: number[];
+        ctrlKey: boolean;
+        currentPagePoint: VecModel;
+        currentScreenPoint: VecModel;
+        isDragging: boolean;
+        isEditing: boolean;
+        isPanning: boolean;
+        isPen: boolean;
+        isPinching: boolean;
+        isPointing: boolean;
+        isSpacebarPanning: boolean;
+        keys: string[];
+        metaKey: boolean;
+        originPagePoint: VecModel;
+        originScreenPoint: VecModel;
+        pointerVelocity: VecModel;
+        previousPagePoint: VecModel;
+        previousScreenPoint: VecModel;
+        shiftKey: boolean;
+    };
+}
+
 /**
  * Find the intersections between a circle and a circle.
  *
@@ -4680,7 +4951,7 @@ export declare function kickoutOccludedShapes(editor: Editor, shapeIds: TLShapeI
 export declare function linesIntersect(A: VecLike, B: VecLike, C: VecLike, D: VecLike): boolean;
 
 /** @public @react */
-export declare function LoadingScreen({ children }: LoadingScreenProps): JSX_2.Element;
+export declare function LoadingScreen({ children }: LoadingScreenProps): JSX.Element;
 
 /** @public */
 export declare interface LoadingScreenProps {
@@ -4798,7 +5069,7 @@ export declare function maybeSnapToGrid(point: Vec, editor: Editor): Vec;
  *
  * @public @react
  */
-export declare function MenuClickCapture(): false | JSX_2.Element;
+export declare function MenuClickCapture(): false | JSX.Element;
 
 /* Excluded from this release type: normalizeWheel */
 
@@ -5231,20 +5502,20 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
      * @param shape - The shape.
      * @public
      */
-    canSnap(_shape: Shape): boolean;
+    canSnap(shape: Shape): boolean;
     /**
      * Whether the shape can be tabbed to.
      *
      * @param shape - The shape.
      * @public
      */
-    canTabTo(_shape: Shape): boolean;
+    canTabTo(shape: Shape): boolean;
     /**
      * Whether the shape can be scrolled while editing.
      *
      * @public
      */
-    canScroll(_shape: Shape): boolean;
+    canScroll(shape: Shape): boolean;
     /**
      * Whether the shape can be bound to. See {@link TLShapeUtilCanBindOpts} for details.
      *
@@ -5256,31 +5527,37 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
      *
      * @public
      */
-    canEdit(_shape: Shape): boolean;
+    canEdit(shape: Shape, info: TLEditStartInfo): boolean;
     /**
      * Whether the shape can be resized.
      *
      * @public
      */
-    canResize(_shape: Shape): boolean;
+    canResize(shape: Shape): boolean;
     /**
      * When the shape is resized, whether the shape's children should also be resized.
      *
      * @public
      */
-    canResizeChildren(_shape: Shape): boolean;
+    canResizeChildren(shape: Shape): boolean;
     /**
      * Whether the shape can be edited in read-only mode.
      *
      * @public
      */
-    canEditInReadonly(_shape: Shape): boolean;
+    canEditInReadonly(shape: Shape): boolean;
+    /**
+     * Whether the shape can be edited while locked or while an ancestor is locked.
+     *
+     * @public
+     */
+    canEditWhileLocked(shape: Shape): boolean;
     /**
      * Whether the shape can be cropped.
      *
      * @public
      */
-    canCrop(_shape: Shape): boolean;
+    canCrop(shape: Shape): boolean;
     /**
      * Whether the shape can participate in layout functions such as alignment or distribution.
      *
@@ -5290,7 +5567,7 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
      *
      * @public
      */
-    canBeLaidOut(_shape: Shape, _info: TLShapeUtilCanBeLaidOutOpts): boolean;
+    canBeLaidOut(shape: Shape, info: TLShapeUtilCanBeLaidOutOpts): boolean;
     /**
      * 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
@@ -5298,11 +5575,31 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
      *
      * @param shape - The shape.
      */
-    canCull(_shape: Shape): boolean;
+    canCull(shape: Shape): boolean;
     /* Excluded from this release type: providesBackgroundForChildren */
     /**
      * Get the clip path to apply to this shape's children.
      *
+     * The returned points should define the **inner** clip boundary - the area where
+     * children will be visible. If your shape has a stroke, you should inset the clip
+     * path by half the stroke width so children are clipped to the inner edge of the
+     * stroke rather than its center line.
+     *
+     * @example
+     * ```ts
+     * override getClipPath(shape: MyShape): Vec[] | undefined {
+     *   const strokeWidth = 2
+     *   const inset = strokeWidth / 2
+     *   // Return points inset by half the stroke width
+     *   return [
+     *     new Vec(inset, inset),
+     *     new Vec(shape.props.w - inset, inset),
+     *     new Vec(shape.props.w - inset, shape.props.h - inset),
+     *     new Vec(inset, shape.props.h - inset),
+     *   ]
+     * }
+     * ```
+     *
      * @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
@@ -5327,37 +5624,37 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
      * @returns boolean indicating if this shape should hide in the minimap
      * @public
      */
-    hideInMinimap?(_shape: Shape): boolean;
+    hideInMinimap?(shape: Shape): boolean;
     /**
      * Whether the shape should hide its resize handles when selected.
      *
      * @public
      */
-    hideResizeHandles(_shape: Shape): boolean;
+    hideResizeHandles(shape: Shape): boolean;
     /**
      * Whether the shape should hide its rotation handles when selected.
      *
      * @public
      */
-    hideRotateHandle(_shape: Shape): boolean;
+    hideRotateHandle(shape: Shape): boolean;
     /**
      * Whether the shape should hide its selection bounds background when selected.
      *
      * @public
      */
-    hideSelectionBoundsBg(_shape: Shape): boolean;
+    hideSelectionBoundsBg(shape: Shape): boolean;
     /**
      * Whether the shape should hide its selection bounds foreground when selected.
      *
      * @public
      */
-    hideSelectionBoundsFg(_shape: Shape): boolean;
+    hideSelectionBoundsFg(shape: Shape): boolean;
     /**
      * Whether the shape's aspect ratio is locked.
      *
      * @public
      */
-    isAspectRatioLocked(_shape: Shape): boolean;
+    isAspectRatioLocked(shape: Shape): boolean;
     /**
      * 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
@@ -5365,10 +5662,10 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
      * 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
+     * @param shape - The shape to check
      * @returns True if this shape should be treated as an export bounds container
      */
-    isExportBoundsContainer(_shape: Shape): boolean;
+    isExportBoundsContainer(shape: Shape): boolean;
     /* Excluded from this release type: backgroundComponent */
     /**
      * Get the interpolated props for an animating shape. This is an optional method.
@@ -5405,7 +5702,7 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
      * @param type - The shape type.
      * @public
      */
-    canReceiveNewChildrenOfType(_shape: Shape, _type: TLShape['type']): boolean;
+    canReceiveNewChildrenOfType(shape: Shape, _type: TLShape['type']): boolean;
     /**
      * Get the shape as an SVG object.
      *
@@ -5438,14 +5735,14 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
      * Get the geometry to use when snapping to this this shape in translate/resize operations. See
      * {@link BoundsSnapGeometry} for details.
      */
-    getBoundsSnapGeometry(_shape: Shape): BoundsSnapGeometry;
+    getBoundsSnapGeometry(shape: Shape): BoundsSnapGeometry;
     /**
      * Get the geometry to use when snapping handles to this shape. See {@link HandleSnapGeometry}
      * for details.
      */
-    getHandleSnapGeometry(_shape: Shape): HandleSnapGeometry;
-    getText(_shape: Shape): string | undefined;
-    getAriaDescriptor(_shape: Shape): string | undefined;
+    getHandleSnapGeometry(shape: Shape): HandleSnapGeometry;
+    getText(shape: Shape): string | undefined;
+    getAriaDescriptor(shape: Shape): string | undefined;
     /**
      * A callback called just before a shape is created. This method provides a last chance to modify
      * the created shape.
@@ -5803,6 +6100,77 @@ export declare class SnapManager {
     getCurrentCommonAncestor(): TLShapeId | undefined;
 }
 
+/**
+ * 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
+ *
+ * @public
+ */
+export declare class SpatialIndexManager {
+    readonly editor: Editor;
+    private rbush;
+    private spatialIndexComputed;
+    private lastPageId;
+    constructor(editor: Editor);
+    private createSpatialIndexComputed;
+    private buildFromScratch;
+    private processIncrementalUpdate;
+    private areBoundsEqual;
+    /**
+     * 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>;
+    /**
+     * 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?: number): Set<TLShapeId>;
+    /**
+     * Dispose of the spatial index manager.
+     * Clears the R-tree to prevent memory leaks.
+     *
+     * @public
+     */
+    dispose(): void;
+}
+
 /** @public */
 export declare class Stadium2d extends Geometry2d {
     config: Omit<Geometry2dOptions, 'isClosed'> & {
@@ -5940,7 +6308,7 @@ export declare const stopEventPropagation: (e: any) => any;
 export declare function suffixSafeId(id: SafeId, suffix: string): SafeId;
 
 /** @public @react */
-export declare function SVGContainer({ children, className, ...rest }: SVGContainerProps): JSX_2.Element;
+export declare function SVGContainer({ children, className, ...rest }: SVGContainerProps): JSX.Element;
 
 /** @public */
 export declare type SVGContainerProps = React_2.ComponentProps<'svg'>;
@@ -6038,6 +6406,8 @@ export declare class TextManager {
     }[];
 }
 
+/* Excluded from this release type: TickManager */
+
 /**
  * This is the TipTap editor! Docs are {@link https://tiptap.dev/docs}.
  *
@@ -6589,6 +6959,33 @@ export declare interface TldrawOptions {
      * Branding name of the app, currently only used for adding aria-label for the application.
      */
     readonly branding?: string;
+    /**
+     * Whether to use debounced zoom level for certain rendering optimizations. When true,
+     * `editor.getDebouncedZoomLevel()` returns a cached zoom value while the camera is moving,
+     * reducing re-renders. When false, it always returns the current zoom level.
+     */
+    readonly debouncedZoom: boolean;
+    /**
+     * The number of shapes that must be on the page for the debounced zoom level to be used.
+     * Defaults to 300 shapes.
+     */
+    readonly debouncedZoomThreshold: number;
+    /**
+     * Whether to allow spacebar panning. When true, the spacebar will pan the camera when held down.
+     * When false, the spacebar will not pan the camera.
+     */
+    readonly spacebarPanning: boolean;
+    /**
+     * The default padding (in pixels) used when zooming to fit content in the viewport.
+     * This affects methods like `zoomToFit()`, `zoomToSelection()`, and `zoomToBounds()`.
+     * The actual padding used is the minimum of this value and 28% of the viewport width.
+     * Defaults to 128 pixels.
+     */
+    readonly zoomToFitPadding: number;
+    /**
+     * The distance (in screen pixels) at which shapes snap to guides and other shapes.
+     */
+    readonly snapThreshold: number;
 }
 
 /** @public */
@@ -6634,7 +7031,7 @@ export declare interface TLEditorComponents {
 /** @public */
 export declare interface TLEditorOptions {
     /**
-     * The Store instance to use for keeping the app's data. This may be prepopulated, e.g. by loading
+     * The Store instance to use for keeping the editor's data. This may be prepopulated, e.g. by loading
      * from a server or database.
      */
     store: TLStore;
@@ -6713,6 +7110,11 @@ export declare interface TLEditorSnapshot {
     session: TLSessionStateSnapshot;
 }
 
+/** @public */
+export declare interface TLEditStartInfo {
+    type: 'click-header' | 'click' | 'double-click-corner' | 'double-click-edge' | 'double-click' | 'press_enter' | 'unknown';
+}
+
 /** @public */
 export declare interface TLEmbedExternalContent<EmbedDefinition> extends TLBaseExternalContent {
     type: 'embed';
@@ -6725,6 +7127,8 @@ export declare type TLEnterEventHandler = (info: any, from: string) => void;
 
 /**
  * An object that contains information about the current device and environment.
+ * This object is not reactive and will not update automatically when the environment changes,
+ * so only include values that are fixed, such as the user's browser and operating system.
  *
  * @public
  */
@@ -6739,6 +7143,17 @@ export declare const tlenv: {
     isWebview: boolean;
 };
 
+/**
+ * An atom that contains information about the current device and environment.
+ * This object is reactive and will update automatically when the environment changes.
+ * Use it for values that may change over time, such as the pointer type.
+ *
+ * @public
+ */
+export declare const tlenvReactive: Atom<    {
+isCoarsePointer: boolean;
+}, unknown>;
+
 /** @public */
 export declare interface TLErrorBoundaryProps {
     children: React_2.ReactNode;
@@ -6802,6 +7217,7 @@ export declare interface TLEventMap {
     event: [TLEventInfo];
     tick: [number];
     frame: [number];
+    resize: [BoxModel];
     'select-all-text': [{
         shapeId: TLShapeId;
     }];
@@ -6816,6 +7232,7 @@ export declare interface TLEventMap {
     'edited-shapes': [TLRecord[]];
     'deleted-shapes': [TLShapeId[]];
     edit: [];
+    dispose: [];
 }
 
 /** @public */
@@ -7913,10 +8330,10 @@ export declare function useMaybeEditor(): Editor | null;
 /* Excluded from this release type: useOnMount */
 
 /** @public */
-export declare function usePassThroughMouseOverEvents(ref: RefObject<HTMLElement>): void;
+export declare function usePassThroughMouseOverEvents(ref: RefObject<HTMLElement | null>): void;
 
 /** @public */
-export declare function usePassThroughWheelEvents(ref: RefObject<HTMLElement>): void;
+export declare function usePassThroughWheelEvents(ref: RefObject<HTMLElement | null>): void;
 
 /**
  * @returns The list of peer UserIDs
@@ -8024,7 +8441,7 @@ export declare function useTLSchemaFromUtils(opts: TLStoreSchemaOptions): StoreS
 export declare function useTLStore(opts: TLStoreOptions): TLStore;
 
 /** @public */
-export declare function useTransform(ref: React.RefObject<HTMLElement | SVGElement>, x?: number, y?: number, scale?: number, rotate?: number, additionalOffset?: VecLike): void;
+export declare function useTransform(ref: React.RefObject<HTMLElement | null | SVGElement>, x?: number, y?: number, scale?: number, rotate?: number, additionalOffset?: VecLike): void;
 
 /**
  * React's useId hook returns a unique id for the component. However, it uses a colon in the id,