@tldraw/editor 3.16.0-internal.a478398270c6 → 3.16.0-internal.f8b97f0c414f

package/dist-cjs/index.d.ts

@@ -4,9 +4,10 @@ import { ComponentType } from 'react';
 import { Computed } from '@tldraw/state';
 import { Dispatch } from 'react';
 import { Editor as Editor_2 } from '@tiptap/core';
-import { EditorProviderProps } from '@tiptap/react';
+import { EditorProviderProps as EditorProviderProps_2 } from '@tiptap/react';
 import EventEmitter from 'eventemitter3';
 import { ExoticComponent } from 'react';
+import { ForwardRefExoticComponent } from 'react';
 import { HistoryEntry } from '@tldraw/store';
 import { IndexKey } from '@tldraw/utils';
 import { JsonObject } from '@tldraw/utils';
@@ -23,6 +24,7 @@ import { ReactElement } from 'react';
 import { ReactNode } from 'react';
 import { RecordProps } from '@tldraw/tlschema';
 import { RecordsDiff } from '@tldraw/store';
+import { RefAttributes } from 'react';
 import { RefObject } from 'react';
 import { SerializedSchema } from '@tldraw/store';
 import { SerializedStore } from '@tldraw/store';
@@ -145,7 +147,7 @@ export declare abstract class BaseBoxShapeTool extends StateNode {
     static id: string;
     static initial: string;
     static children(): TLStateNodeConstructor[];
-    abstract shapeType: string;
+    abstract shapeType: TLBaseBoxShape['type'];
     onCreate?(_shape: null | TLShape): null | void;
 }
 
@@ -508,6 +510,7 @@ export declare class Box {
     static ExpandBy(A: Box, n: number): Box;
     static Collides(A: Box, B: Box): boolean;
     static Contains(A: Box, B: Box): boolean;
+    static ContainsApproximately(A: Box, B: Box, precision?: number): boolean;
     static Includes(A: Box, B: Box): boolean;
     static ContainsPoint(A: Box, B: VecLike, margin?: number): boolean;
     static Common(boxes: Box[]): Box;
@@ -725,10 +728,12 @@ export declare class CubicBezier2d extends Polyline2d {
     private _b;
     private _c;
     private _d;
+    private _resolution;
     constructor(config: Omit<Geometry2dOptions, 'isClosed' | 'isFilled'> & {
         cp1: Vec;
         cp2: Vec;
         end: Vec;
+        resolution?: number;
         start: Vec;
     });
     getVertices(): Vec[];
@@ -756,11 +761,6 @@ export declare class CubicSpline2d extends Geometry2d {
 /** @public */
 export declare function dataUrlToFile(url: string, filename: string, mimeType: string): Promise<File>;
 
-/**
- * @deprecated Licensing is now enabled in the tldraw SDK.
- * @public */
-export declare function debugEnableLicensing(): void;
-
 /* Excluded from this release type: DebugFlag */
 
 /* Excluded from this release type: DebugFlagDef */
@@ -815,11 +815,14 @@ export declare const DefaultShapeIndicator: NamedExoticComponent<TLShapeIndicato
 /** @public @react */
 export declare const DefaultShapeIndicators: NamedExoticComponent<TLShapeIndicatorsProps>;
 
+/** @public @react */
+export declare const DefaultShapeWrapper: ForwardRefExoticComponent<TLShapeWrapperProps & RefAttributes<HTMLDivElement>>;
+
 /** @public @react */
 export declare function DefaultSnapIndicator({ className, line, zoom }: TLSnapIndicatorProps): JSX_2.Element;
 
 /** @public @react */
-export declare function DefaultSpinner(): JSX_2.Element;
+export declare function DefaultSpinner(props: React.SVGProps<SVGSVGElement>): JSX_2.Element;
 
 /** @public @react */
 export declare const DefaultSvgDefs: () => null;
@@ -882,11 +885,15 @@ export declare const defaultTldrawOptions: {
     readonly nonce: undefined;
     readonly temporaryAssetPreviewLifetimeMs: 180000;
     readonly textShadowLod: 0.35;
+    readonly tooltipDelayMs: 700;
+    readonly uiCoarseDragDistanceSquared: 625;
+    readonly uiDragDistanceSquared: 16;
 };
 
 /** @public */
 export declare const defaultUserPreferences: Readonly<{
     animationSpeed: 0 | 1;
+    areKeyboardShortcutsEnabled: true;
     color: "#02B1CC" | "#11B3A3" | "#39B178" | "#55B467" | "#7B66DC" | "#9D5BD2" | "#BD54C6" | "#E34BA9" | "#EC5E41" | "#F04F88" | "#F2555A" | "#FF802B";
     colorScheme: "light";
     edgeScrollSpeed: 1;
@@ -896,6 +903,7 @@ export declare const defaultUserPreferences: Readonly<{
     isWrapMode: false;
     locale: "ar" | "bn" | "ca" | "cs" | "da" | "de" | "el" | "en" | "es" | "fa" | "fi" | "fr" | "gl" | "gu-in" | "he" | "hi-in" | "hr" | "hu" | "id" | "it" | "ja" | "km-kh" | "kn" | "ko-kr" | "ml" | "mr" | "ms" | "ne" | "nl" | "no" | "pa" | "pl" | "pt-br" | "pt-pt" | "ro" | "ru" | "sl" | "so" | "sv" | "ta" | "te" | "th" | "tl" | "tr" | "uk" | "ur" | "vi" | "zh-cn" | "zh-tw";
     name: "";
+    showUiLabels: false;
 }>;
 
 /**
@@ -971,7 +979,7 @@ export declare class EdgeScrollManager {
 /** @public */
 export declare class Editor extends EventEmitter<TLEventMap> {
     readonly id: string;
-    constructor({ store, user, shapeUtils, bindingUtils, tools, getContainer, cameraOptions, textOptions, initialState, autoFocus, inferDarkMode, options, isShapeHidden, getShapeVisibility, fontAssetUrls, }: TLEditorOptions);
+    constructor({ store, user, shapeUtils, bindingUtils, tools, getContainer, cameraOptions, textOptions, initialState, autoFocus, inferDarkMode, options, getShapeVisibility, fontAssetUrls, }: TLEditorOptions);
     private readonly _getShapeVisibility?;
     private getIsShapeHiddenCache;
     isShapeHidden(shapeOrId: TLShape | TLShapeId): boolean;
@@ -1038,22 +1046,6 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * @public
      */
     readonly fonts: FontManager;
-    /**
-     * A manager for the editor's environment.
-     *
-     * @deprecated This is deprecated and will be removed in a future version. Use the `tlenv` global export instead.
-     * @public
-     */
-    readonly environment: {
-        hasCanvasSupport: boolean;
-        isAndroid: boolean;
-        isChromeForIos: boolean;
-        isDarwin: boolean;
-        isFirefox: boolean;
-        isIos: boolean;
-        isSafari: boolean;
-        isWebview: boolean;
-    };
     /**
      * A manager for the editor's scribbles.
      *
@@ -1096,7 +1088,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * @public
      */
     shapeUtils: {
-        readonly [K in string]?: ShapeUtil<TLUnknownShape>;
+        readonly [K in string]?: ShapeUtil<TLShape>;
     };
     styleProps: {
         [key: string]: Map<StyleProp<any>, string>;
@@ -1116,16 +1108,16 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    getShapeUtil<S extends TLUnknownShape>(shape: S | TLShapePartial<S>): ShapeUtil<S>;
-    getShapeUtil<S extends TLUnknownShape>(type: S['type']): ShapeUtil<S>;
+    getShapeUtil<S extends TLShape>(shape: S | TLShapePartial<S>): ShapeUtil<S>;
+    getShapeUtil<S extends TLShape>(type: S['type']): ShapeUtil<S>;
     getShapeUtil<T extends ShapeUtil>(type: T extends ShapeUtil<infer R> ? R['type'] : string): T;
     /**
      * Returns true if the editor has a shape util for the given shape / shape type.
      *
      * @param shape - A shape, shape partial, or shape type.
      */
-    hasShapeUtil<S extends TLUnknownShape>(shape: S | TLShapePartial<S>): boolean;
-    hasShapeUtil<S extends TLUnknownShape>(type: S['type']): boolean;
+    hasShapeUtil(shape: TLShape | TLShapePartial<TLShape>): boolean;
+    hasShapeUtil(type: TLShape['type']): boolean;
     hasShapeUtil<T extends ShapeUtil>(type: T extends ShapeUtil<infer R> ? R['type'] : string): boolean;
     /**
      * A map of shape utility classes (TLShapeUtils) by shape type.
@@ -1196,22 +1188,6 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * @public
      */
     getCanRedo(): boolean;
-    /**
-     * Create a new "mark", or stopping point, in the undo redo history. Creating a mark will clear
-     * any redos.
-     *
-     * @example
-     * ```ts
-     * editor.mark()
-     * editor.mark('flip shapes')
-     * ```
-     *
-     * @param markId - The mark's id, usually the reason for adding the mark.
-     *
-     * @public
-     * @deprecated use {@link Editor.markHistoryStoppingPoint} instead
-     */
-    mark(markId?: string): 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.
@@ -1301,10 +1277,6 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * @public
      */
     run(fn: () => void, opts?: TLEditorRunOptions): this;
-    /**
-     * @deprecated Use `Editor.run` instead.
-     */
-    batch(fn: () => void, opts?: TLEditorRunOptions): this;
     /* Excluded from this release type: annotateError */
     /* Excluded from this release type: createErrorAnnotations */
     /* Excluded from this release type: _crashingError */
@@ -1426,36 +1398,6 @@ export declare class Editor extends EventEmitter<TLEventMap> {
         hasOpenMenus: () => boolean;
         isMenuOpen: (id: string) => boolean;
     };
-    /**
-     * @deprecated Use `editor.menus.getOpenMenus` instead.
-     *
-     * @public
-     */
-    getOpenMenus(): string[];
-    /**
-     * @deprecated Use `editor.menus.addOpenMenu` instead.
-     *
-     * @public
-     */
-    addOpenMenu(id: string): this;
-    /**
-     * @deprecated Use `editor.menus.deleteOpenMenu` instead.
-     *
-     * @public
-     */
-    deleteOpenMenu(id: string): this;
-    /**
-     * @deprecated Use `editor.menus.clearOpenMenus` instead.
-     *
-     * @public
-     */
-    clearOpenMenus(): this;
-    /**
-     * @deprecated Use `editor.menus.hasAnyOpenMenus` instead.
-     *
-     * @public
-     */
-    getIsMenuOpen(): boolean;
     /**
      * Set the cursor.
      *
@@ -1552,7 +1494,9 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      */
     deselect(...shapes: TLShape[] | TLShapeId[]): this;
     /**
-     * Select all direct children of the current page.
+     * Select all shapes. If the user has selected shapes that share a parent,
+     * select all shapes within that parent. If the user has not selected any shapes,
+     * or if the shapes shapes are only on select all shapes on the current page.
      *
      * @example
      * ```ts
@@ -1586,7 +1530,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    getNearestAdjacentShape(currentShapeId: TLShapeId, direction: 'down' | 'left' | 'right' | 'up'): TLShapeId;
+    getNearestAdjacentShape(shapes: TLShape[], currentShapeId: TLShapeId, direction: 'down' | 'left' | 'right' | 'up'): TLShapeId;
     selectParentShape(): void;
     selectFirstChildShape(): void;
     private _selectShapesAndZoom;
@@ -2680,15 +2624,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @returns The shape at the given point, or undefined if there is no shape at the point.
      */
-    getShapeAtPoint(point: VecLike, opts?: {
-        filter?(shape: TLShape): boolean;
-        hitFrameInside?: boolean;
-        hitInside?: boolean;
-        hitLabels?: boolean;
-        hitLocked?: boolean;
-        margin?: number;
-        renderingOnly?: boolean;
-    }): TLShape | undefined;
+    getShapeAtPoint(point: VecLike, opts?: TLGetShapeAtPointOptions): TLShape | undefined;
     /**
      * Get the shapes, if any, at a given page point.
      *
@@ -2791,8 +2727,8 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    isShapeOfType<T extends TLUnknownShape>(shape: TLUnknownShape, type: T['type']): shape is T;
-    isShapeOfType<T extends TLUnknownShape>(shapeId: TLUnknownShape['id'], type: T['type']): shapeId is T['id'];
+    isShapeOfType<T extends TLShape>(shape: TLShape, type: T['type']): shape is T;
+    isShapeOfType<T extends TLShape = TLShape>(shapeId: TLShapeId, type: T['type']): boolean;
     /**
      * Get a shape by its id.
      *
@@ -2910,8 +2846,6 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * @public
      */
     getShapeAndDescendantIds(ids: TLShapeId[]): Set<TLShapeId>;
-    /** @deprecated Use {@link Editor.getDraggingOverShape} instead */
-    getDroppingOverShape(point: Vec, droppingShapes: TLShape[]): TLShape | undefined;
     /**
      * Get the shape that some shapes should be dropped on at a given point.
      *
@@ -3270,7 +3204,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    canCreateShape<T extends TLUnknownShape>(shape: OptionalKeys<TLShapePartial<T>, 'id'> | T['id']): boolean;
+    canCreateShape(shape: OptionalKeys<TLShapePartial<TLShape>, 'id'> | TLShape['id']): boolean;
     /**
      * Get whether the provided shapes can be created.
      *
@@ -3278,7 +3212,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    canCreateShapes<T extends TLUnknownShape>(shapes: (OptionalKeys<TLShapePartial<T>, 'id'> | T['id'])[]): boolean;
+    canCreateShapes(shapes: (OptionalKeys<TLShapePartial<TLShape>, 'id'> | TLShape['id'])[]): boolean;
     /**
      * Create a single shape.
      *
@@ -3292,7 +3226,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    createShape<T extends TLUnknownShape>(shape: OptionalKeys<TLShapePartial<T>, 'id'>): this;
+    createShape<TShape extends TLShape>(shape: OptionalKeys<TLShapePartial<TShape>, 'id'>): this;
     /**
      * Create shapes.
      *
@@ -3306,7 +3240,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    createShapes<T extends TLUnknownShape>(shapes: OptionalKeys<TLShapePartial<T>, 'id'>[]): this;
+    createShapes<TShape extends TLShape = TLShape>(shapes: OptionalKeys<TLShapePartial<TShape>, 'id'>[]): this;
     private animatingShapes;
     /**
      * Animate a shape.
@@ -3392,7 +3326,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    updateShape<T extends TLUnknownShape>(partial: null | TLShapePartial<T> | undefined): this;
+    updateShape<T extends TLShape = TLShape>(partial: null | TLShapePartial<T> | undefined): this;
     /**
      * Update shapes using partials of each shape.
      *
@@ -3405,7 +3339,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      *
      * @public
      */
-    updateShapes<T extends TLUnknownShape>(partials: (null | TLShapePartial<T> | undefined)[]): this;
+    updateShapes<T extends TLShape>(partials: (null | TLShapePartial<T> | undefined)[]): this;
     /* Excluded from this release type: _updateShapes */
     /* Excluded from this release type: _getUnlockedShapeIds */
     /**
@@ -3623,14 +3557,20 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * Handle external content, such as files, urls, embeds, or plain text which has been put into the app, for example by pasting external text or dropping external images onto canvas.
      *
      * @param info - Info about the external content.
+     * @param opts - Options for handling external content, including force flag to bypass readonly checks.
      */
-    putExternalContent<E>(info: TLExternalContent<E>): Promise<void>;
+    putExternalContent<E>(info: TLExternalContent<E>, opts?: {
+        force?: boolean;
+    }): Promise<void>;
     /**
      * Handle replacing external content.
      *
      * @param info - Info about the external content.
+     * @param opts - Options for handling external content, including force flag to bypass readonly checks.
      */
-    replaceExternalContent<E>(info: TLExternalContent<E>): Promise<void>;
+    replaceExternalContent<E>(info: TLExternalContent<E>, opts?: {
+        force?: boolean;
+    }): Promise<void>;
     /**
      * Get content that can be exported for the given shape ids.
      *
@@ -3686,8 +3626,6 @@ export declare class Editor extends EventEmitter<TLEventMap> {
         svg: string;
         width: number;
     } | undefined>;
-    /** @deprecated Use {@link Editor.getSvgString} or {@link Editor.getSvgElement} instead. */
-    getSvg(shapes: TLShape[] | TLShapeId[], opts?: TLSvgExportOptions): Promise<SVGSVGElement | undefined>;
     /**
      * Get an exported image of the given shapes.
      *
@@ -3702,6 +3640,20 @@ export declare class Editor extends EventEmitter<TLEventMap> {
         height: number;
         width: number;
     }>;
+    /**
+     * Get an exported image of the given shapes as a data URL.
+     *
+     * @param shapes - The shapes (or shape ids) to export.
+     * @param opts - Options for the export.
+     *
+     * @returns A data URL of the image.
+     * @public
+     */
+    toImageDataUrl(shapes: TLShape[] | TLShapeId[], opts?: TLImageExportOptions): Promise<{
+        height: number;
+        url: string;
+        width: number;
+    }>;
     /**
      * The app's current input state.
      *
@@ -3788,6 +3740,21 @@ export declare class Editor extends EventEmitter<TLEventMap> {
      * @public
      */
     complete(): this;
+    /**
+     * Dispatch a pointer move event in the current position of the pointer. This is useful when
+     * external circumstances have changed (e.g. the camera moved or a shape was moved) and you want
+     * the current interaction to respond to that change.
+     *
+     * @example
+     * ```ts
+     * editor.updatePointer()
+     * ```
+     *
+     * @param options - The options for updating the pointer.
+     * @returns The editor instance.
+     * @public
+     */
+    updatePointer(options?: TLUpdatePointerOptions): this;
     /**
      * Puts the editor into focused mode.
      *
@@ -4011,9 +3978,38 @@ export declare class Editor extends EventEmitter<TLEventMap> {
     /* Excluded from this release type: maybeTrackPerformance */
 }
 
+/**
+ * An Atom that is scoped to the lifetime of an Editor.
+ *
+ * This is useful for storing UI state for tldraw applications. Keeping state scoped to an editor
+ * instead of stored in a global atom can prevent issues with state being shared between editors
+ * when navigating between pages, or when multiple editor instances are used on the same page.
+ *
+ * @public
+ */
+export declare class EditorAtom<T> {
+    private name;
+    private getInitialState;
+    private states;
+    constructor(name: string, getInitialState: (editor: Editor) => T);
+    getAtom(editor: Editor): Atom<T>;
+    get(editor: Editor): T;
+    update(editor: Editor, update: (state: T) => T): T;
+    set(editor: Editor, state: T): T;
+}
+
 /** @public */
 export declare const EditorContext: React_3.Context<Editor | null>;
 
+/** @public @react */
+export declare function EditorProvider({ editor, children }: EditorProviderProps): JSX_2.Element;
+
+/** @public */
+export declare interface EditorProviderProps {
+    editor: Editor;
+    children: React_3.ReactNode;
+}
+
 /** @public */
 export declare class Ellipse2d extends Geometry2d {
     config: Omit<Geometry2dOptions, 'isClosed'> & {
@@ -4099,6 +4095,7 @@ export declare abstract class Geometry2d {
     isLabel: boolean;
     isEmptyLabel: boolean;
     isInternal: boolean;
+    excludeFromShapeBounds: boolean;
     debugColor?: string;
     ignore?: boolean;
     constructor(opts: Geometry2dOptions);
@@ -4122,12 +4119,14 @@ export declare abstract class Geometry2d {
      * along the edge it is as a fraction of the total length.
      */
     uninterpolateAlongEdge(point: VecLike, _filters?: Geometry2dFilters): number;
-    /** @deprecated Iterate the vertices instead. */
-    nearestPointOnLineSegment(A: VecLike, B: VecLike): Vec;
     isPointInBounds(point: VecLike, margin?: number): boolean;
+    overlapsPolygon(_polygon: VecLike[]): boolean;
     transform(transform: MatModel, opts?: TransformedGeometry2dOptions): Geometry2d;
     private _vertices;
     get vertices(): Vec[];
+    getBoundsVertices(): Vec[];
+    private _boundsVertices;
+    get boundsVertices(): Vec[];
     getBounds(): Box;
     private _bounds;
     get bounds(): Box;
@@ -4308,6 +4307,8 @@ export declare function getSvgPathFromPoints(points: VecLike[], closed?: boolean
 /** @public */
 export declare function getUserPreferences(): TLUserPreferences;
 
+/* Excluded from this release type: getVerticesCountForArcLength */
+
 /** @public */
 export declare class Group2d extends Geometry2d {
     children: Geometry2d[];
@@ -4322,6 +4323,7 @@ export declare class Group2d extends Geometry2d {
     hitTestLineSegment(A: VecLike, B: VecLike, zoom: number, filters?: Geometry2dFilters): boolean;
     intersectLineSegment(A: VecLike, B: VecLike, filters?: Geometry2dFilters): VecLike[];
     intersectCircle(center: VecLike, radius: number, filters?: Geometry2dFilters): VecLike[];
+    getBoundsVertices(): Vec[];
     intersectPolygon(polygon: VecLike[], filters?: Geometry2dFilters): VecLike[];
     intersectPolyline(polyline: VecLike[], filters?: Geometry2dFilters): VecLike[];
     interpolateAlongEdge(t: number, filters?: Geometry2dFilters): Vec;
@@ -4331,6 +4333,7 @@ export declare class Group2d extends Geometry2d {
     toSimpleSvgPath(): string;
     getLength(filters?: Geometry2dFilters): number;
     getSvgPathData(): string;
+    overlapsPolygon(polygon: VecLike[]): boolean;
 }
 
 /** @public */
@@ -4507,7 +4510,7 @@ export declare function intersectLineSegmentCircle(a1: VecLike, a2: VecLike, c:
  * @param b2 - The second segment's second point.
  * @public
  */
-export declare function intersectLineSegmentLineSegment(a1: VecLike, a2: VecLike, b1: VecLike, b2: VecLike): null | Vec;
+export declare function intersectLineSegmentLineSegment(a1: VecLike, a2: VecLike, b1: VecLike, b2: VecLike, precision?: number): null | Vec;
 
 /**
  * Find the intersections between a line segment and a closed polygon.
@@ -4571,12 +4574,16 @@ export declare function kickoutOccludedShapes(editor: Editor, shapeIds: TLShapeI
     filter?(parent: TLShape): boolean;
 }): void;
 
+/* Excluded from this release type: LICENSE_TIMEOUT */
+
 /* Excluded from this release type: LicenseFromKeyResult */
 
 /* Excluded from this release type: LicenseInfo */
 
 /* Excluded from this release type: LicenseManager */
 
+/* Excluded from this release type: LicenseState */
+
 /** @public */
 export declare function linesIntersect(A: VecLike, B: VecLike, C: VecLike, D: VecLike): boolean;
 
@@ -4609,6 +4616,23 @@ export declare function loadSnapshot(store: TLStore, _snapshot: Partial<TLEditor
 /** @public */
 export declare function loopToHtmlElement(elm: Element): HTMLElement;
 
+/**
+ * In tldraw, events are sometimes handled by multiple components. For example, the shapes might
+ * have events, but the canvas handles events too. The way that the canvas handles events can
+ * interfere with the with the shapes event handlers - for example, it calls `.preventDefault()` on
+ * `pointerDown`, which also prevents `click` events from firing on the shapes.
+ *
+ * You can use `.stopPropagation()` to prevent the event from propagating to the rest of the DOM,
+ * but that can impact non-tldraw event handlers set up elsewhere. By using `markEventAsHandled`,
+ * you'll stop other parts of tldraw from handling the event without impacting other, non-tldraw
+ * event handlers. See also {@link wasEventAlreadyHandled}.
+ *
+ * @public
+ */
+export declare function markEventAsHandled(e: {
+    nativeEvent: Event;
+} | Event): void;
+
 /** @public */
 export declare class Mat {
     constructor(a: number, b: number, c: number, d: number, e: number, f: number);
@@ -5027,7 +5051,7 @@ export declare function setRuntimeOverrides(input: Partial<typeof runtime>): voi
 export declare function setUserPreferences(user: TLUserPreferences): void;
 
 /** @public */
-export declare abstract class ShapeUtil<Shape extends TLUnknownShape = TLUnknownShape> {
+export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
     editor: Editor;
     /** Configure this shape utils {@link ShapeUtil.options | `options`}. */
     static configure<T extends TLShapeUtilConstructor<any, any>>(this: T, options: T extends new (...args: any[]) => {
@@ -5182,7 +5206,34 @@ export declare abstract class ShapeUtil<Shape extends TLUnknownShape = TLUnknown
      * @public
      */
     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
+     * to the DOM, but have their `display` property set to `none`.
+     *
+     * @param shape - The shape.
+     */
+    canCull(_shape: Shape): boolean;
     /* Excluded from this release type: providesBackgroundForChildren */
+    /**
+     * 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): undefined | Vec[];
+    /**
+     * 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.
      *
@@ -5213,6 +5264,17 @@ export declare abstract class ShapeUtil<Shape extends TLUnknownShape = TLUnknown
      * @public
      */
     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
+     * 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;
     /* Excluded from this release type: backgroundComponent */
     /**
      * Get the interpolated props for an animating shape. This is an optional method.
@@ -5402,6 +5464,14 @@ export declare abstract class ShapeUtil<Shape extends TLUnknownShape = TLUnknown
      * @public
      */
     onResizeEnd?(initial: Shape, current: Shape): TLShapePartial<Shape> | void;
+    /**
+     * A callback called when a shape resize is cancelled.
+     *
+     * @param initial - The shape at the start of the resize.
+     * @param current - The current shape.
+     * @public
+     */
+    onResizeCancel?(initial: Shape, current: Shape): void;
     /**
      * A callback called when a shape starts being translated.
      *
@@ -5428,6 +5498,23 @@ export declare abstract class ShapeUtil<Shape extends TLUnknownShape = TLUnknown
      * @public
      */
     onTranslateEnd?(initial: Shape, current: Shape): TLShapePartial<Shape> | void;
+    /**
+     * A callback called when a shape translation is cancelled.
+     *
+     * @param initial - The shape at the start of the translation.
+     * @param current - The current shape.
+     * @public
+     */
+    onTranslateCancel?(initial: Shape, current: Shape): void;
+    /**
+     * A callback called when a shape's handle starts being dragged.
+     *
+     * @param shape - The shape.
+     * @param info - An object containing the handle and whether the handle is 'precise' or not.
+     * @returns A change to apply to the shape, or void.
+     * @public
+     */
+    onHandleDragStart?(shape: Shape, info: TLHandleDragInfo<Shape>): TLShapePartial<Shape> | void;
     /**
      * A callback called when a shape's handle changes.
      *
@@ -5437,6 +5524,23 @@ export declare abstract class ShapeUtil<Shape extends TLUnknownShape = TLUnknown
      * @public
      */
     onHandleDrag?(shape: Shape, info: TLHandleDragInfo<Shape>): TLShapePartial<Shape> | void;
+    /**
+     * A callback called when a shape's handle finishes being dragged.
+     *
+     * @param current - The current shape.
+     * @param info - An object containing the handle and whether the handle is 'precise' or not.
+     * @returns A change to apply to the shape, or void.
+     * @public
+     */
+    onHandleDragEnd?(current: Shape, info: TLHandleDragInfo<Shape>): TLShapePartial<Shape> | void;
+    /**
+     * A callback called when a shape's handle drag is cancelled.
+     *
+     * @param current - The current shape.
+     * @param info - An object containing the handle and whether the handle is 'precise' or not.
+     * @public
+     */
+    onHandleDragCancel?(current: Shape, info: TLHandleDragInfo<Shape>): void;
     /**
      * A callback called when a shape starts being rotated.
      *
@@ -5463,6 +5567,14 @@ export declare abstract class ShapeUtil<Shape extends TLUnknownShape = TLUnknown
      * @public
      */
     onRotateEnd?(initial: Shape, current: Shape): TLShapePartial<Shape> | void;
+    /**
+     * A callback called when a shape rotation is cancelled.
+     *
+     * @param initial - The shape at the start of the rotation.
+     * @param current - The current shape.
+     * @public
+     */
+    onRotateCancel?(initial: Shape, current: Shape): void;
     /* Excluded from this release type: onBindingChange */
     /**
      * A callback called when a shape's children change.
@@ -5691,6 +5803,12 @@ export declare abstract class StateNode implements Partial<TLEventHandlers> {
     _currentToolIdMask: Atom<string | undefined, unknown>;
     getCurrentToolIdMask(): string | undefined;
     setCurrentToolIdMask(id: string | undefined): void;
+    /**
+     * Add a child node to this state node.
+     *
+     * @public
+     */
+    addChild(childConstructor: TLStateNodeConstructor): this;
     onWheel?(info: TLWheelEventInfo): void;
     onPointerDown?(info: TLPointerEventInfo): void;
     onPointerMove?(info: TLPointerEventInfo): void;
@@ -5712,7 +5830,14 @@ export declare abstract class StateNode implements Partial<TLEventHandlers> {
     onExit?(info: any, to: string): void;
 }
 
-/** @public */
+/**
+ * Calls `event.stopPropagation()`.
+ *
+ * @deprecated Use {@link markEventAsHandled} instead, or manually call `event.stopPropagation()` if
+ * that's what you really want.
+ *
+ * @public
+ */
 export declare const stopEventPropagation: (e: any) => any;
 
 /* Excluded from this release type: StoreName */
@@ -5844,9 +5969,11 @@ export declare type TLAnyBindingUtilConstructor = TLBindingUtilConstructor<any>;
 export declare type TLAnyShapeUtilConstructor = TLShapeUtilConstructor<any>;
 
 /** @public */
-export declare type TLBaseBoxShape = TLBaseShape<string, {
-    h: number;
-    w: number;
+export declare type TLBaseBoxShape = Extract<TLShape, {
+    props: {
+        h: number;
+        w: number;
+    };
 }>;
 
 /** @public */
@@ -6203,12 +6330,6 @@ export declare interface TldrawEditorBaseProps {
      * Options for syncing the editor's camera state with the URL.
      */
     deepLinks?: TLDeepLinkOptions | true;
-    /**
-     * Predicate for whether or not a shape should be hidden.
-     *
-     * @deprecated Use {@link TldrawEditorBaseProps#getShapeVisibility} instead.
-     */
-    isShapeHidden?(shape: TLShape, editor: Editor): boolean;
     /**
      * Provides a way to hide shapes.
      *
@@ -6316,6 +6437,8 @@ export declare interface TldrawOptions {
     readonly multiClickDurationMs: number;
     readonly coarseDragDistanceSquared: number;
     readonly dragDistanceSquared: number;
+    readonly uiDragDistanceSquared: number;
+    readonly uiCoarseDragDistanceSquared: number;
     readonly defaultSvgPadding: number;
     readonly cameraSlideFriction: number;
     readonly gridSteps: readonly {
@@ -6342,6 +6465,7 @@ export declare interface TldrawOptions {
     readonly flattenImageBoundsPadding: number;
     readonly laserDelayMs: number;
     readonly maxExportDelayMs: number;
+    readonly tooltipDelayMs: number;
     /**
      * How long should previews created by {@link Editor.createTemporaryAssetPreview} last before
      * they expire? Defaults to 3 minutes.
@@ -6407,8 +6531,9 @@ export declare interface TLEditorComponents {
     SelectionForeground?: ComponentType<TLSelectionForegroundProps> | null;
     ShapeIndicator?: ComponentType<TLShapeIndicatorProps> | null;
     ShapeIndicators?: ComponentType | null;
+    ShapeWrapper?: ComponentType<TLShapeWrapperProps & RefAttributes<HTMLDivElement>> | null;
     SnapIndicator?: ComponentType<TLSnapIndicatorProps> | null;
-    Spinner?: ComponentType | null;
+    Spinner?: ComponentType<React.SVGProps<SVGSVGElement>> | null;
     SvgDefs?: ComponentType | null;
     ZoomBrush?: ComponentType<TLBrushProps> | null;
     ErrorFallback?: TLErrorFallbackComponent;
@@ -6466,15 +6591,6 @@ export declare interface TLEditorOptions {
     fontAssetUrls?: {
         [key: string]: string | undefined;
     };
-    /**
-     * A predicate that should return true if the given shape should be hidden.
-     *
-     * @deprecated Use {@link Editor#getShapeVisibility} instead.
-     *
-     * @param shape - The shape to check.
-     * @param editor - The editor instance.
-     */
-    isShapeHidden?(shape: TLShape, editor: Editor): boolean;
     /**
      * Provides a way to hide shapes.
      *
@@ -6742,6 +6858,59 @@ export declare interface TLGeometryOpts {
     context?: string;
 }
 
+/**
+ * Options to {@link Editor.getShapeAtPoint}.
+ *
+ * @public
+ */
+export declare 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;
+}
+
 /** @public */
 export declare interface TLGridProps {
     x: number;
@@ -6754,6 +6923,7 @@ export declare interface TLGridProps {
 export declare interface TLHandleDragInfo<T extends TLShape> {
     handle: TLHandle;
     isPrecise: boolean;
+    isCreatingShape: boolean;
     initial?: T | undefined;
 }
 
@@ -7257,11 +7427,11 @@ export declare interface TLShapeUtilCanBeLaidOutOpts {
  *
  * @public
  */
-export declare interface TLShapeUtilCanBindOpts<Shape extends TLUnknownShape = TLUnknownShape> {
+export declare interface TLShapeUtilCanBindOpts<Shape extends TLShape = TLShape> {
     /** The type of shape referenced by the `fromId` of the binding. */
-    fromShapeType: string;
+    fromShapeType: TLShape['type'];
     /** The type of shape referenced by the `toId` of the binding. */
-    toShapeType: string;
+    toShapeType: TLShape['type'];
     /** The type of binding. */
     bindingType: string;
 }
@@ -7273,13 +7443,23 @@ export declare interface TLShapeUtilCanvasSvgDef {
 }
 
 /** @public */
-export declare interface TLShapeUtilConstructor<T extends TLUnknownShape, U extends ShapeUtil<T> = ShapeUtil<T>> {
+export declare interface TLShapeUtilConstructor<T extends TLShape, U extends ShapeUtil<T> = ShapeUtil<T>> {
     new (editor: Editor): U;
     type: T['type'];
     props?: RecordProps<T>;
     migrations?: LegacyMigrations | MigrationSequence | TLPropsMigrations;
 }
 
+/** @public */
+export declare interface TLShapeWrapperProps extends React.HTMLAttributes<HTMLDivElement> {
+    /** The shape being rendered. */
+    shape: TLShape;
+    /** Whether this is the shapes regular, or background component. */
+    isBackground: boolean;
+    /** The shape's rendered component. */
+    children: ReactNode;
+}
+
 /** @public */
 export declare interface TLSnapIndicatorProps {
     className?: string;
@@ -7401,12 +7581,6 @@ export declare interface TLSvgExportOptions {
     preserveAspectRatio?: React.SVGAttributes<SVGSVGElement>['preserveAspectRatio'];
 }
 
-/**
- * @public
- * @deprecated use {@link TLImageExportOptions} instead
- */
-export declare type TLSvgOptions = TLImageExportOptions;
-
 /** @public */
 export declare interface TLSvgTextExternalContent extends TLBaseExternalContent {
     type: 'svg-text';
@@ -7429,7 +7603,7 @@ export declare interface TLTextExternalContentSource {
 
 /** @public */
 export declare interface TLTextOptions {
-    tipTapConfig?: EditorProviderProps;
+    tipTapConfig?: EditorProviderProps_2;
     addFontsFromNode?: RichTextFontVisitor;
 }
 
@@ -7462,6 +7636,25 @@ export declare interface TLTldrawExternalContentSource {
     data: TLContent;
 }
 
+/** @public */
+export declare interface TLUpdatePointerOptions {
+    /** Whether to update the pointer immediately, rather than on the next tick. */
+    immediate?: boolean;
+    /**
+     * The point, in screen-space, to update the pointer to. Defaults to the position of the last
+     * pointer event.
+     */
+    point?: VecLike;
+    pointerId?: number;
+    ctrlKey?: boolean;
+    altKey?: boolean;
+    shiftKey?: boolean;
+    metaKey?: boolean;
+    accelKey?: boolean;
+    isPen?: boolean;
+    button?: number;
+}
+
 /** @public */
 export declare interface TLUrlExternalAsset {
     type: 'url';
@@ -7491,12 +7684,14 @@ export declare interface TLUserPreferences {
     color?: null | string;
     locale?: null | string;
     animationSpeed?: null | number;
+    areKeyboardShortcutsEnabled?: boolean | null;
     edgeScrollSpeed?: null | number;
     colorScheme?: 'dark' | 'light' | 'system';
     isSnapMode?: boolean | null;
     isWrapMode?: boolean | null;
     isDynamicSizeMode?: boolean | null;
     isPasteAtCursorMode?: boolean | null;
+    showUiLabels?: boolean | null;
 }
 
 /** @public */
@@ -7539,6 +7734,7 @@ export declare class TransformedGeometry2d extends Geometry2d {
     private readonly decomposed;
     constructor(geometry: Geometry2d, matrix: MatModel, opts?: TransformedGeometry2dOptions);
     getVertices(filters: Geometry2dFilters): Vec[];
+    getBoundsVertices(): Vec[];
     nearestPoint(point: VecLike, filters?: Geometry2dFilters): Vec;
     hitTestPoint(point: VecLike, margin?: number, hitInside?: boolean, filters?: Geometry2dFilters): boolean;
     distanceToPoint(point: VecLike, hitInside?: boolean, filters?: Geometry2dFilters): number;
@@ -7559,6 +7755,7 @@ export declare interface TransformedGeometry2dOptions {
     isInternal?: boolean;
     debugColor?: string;
     ignore?: boolean;
+    excludeFromShapeBounds?: boolean;
 }
 
 /** @public */
@@ -7659,6 +7856,7 @@ export declare class UserPreferencesManager {
     updateUserPreferences(userPreferences: Partial<TLUserPreferences>): void;
     getUserPreferences(): {
         animationSpeed: number;
+        areKeyboardShortcutsEnabled: boolean;
         color: string;
         colorScheme: "dark" | "light" | "system" | undefined;
         id: string;
@@ -7668,6 +7866,7 @@ export declare class UserPreferencesManager {
         isWrapMode: boolean;
         locale: string;
         name: string;
+        showUiLabels: boolean;
     };
     getIsDarkMode(): boolean;
     /**
@@ -7675,6 +7874,7 @@ export declare class UserPreferencesManager {
      */
     getEdgeScrollSpeed(): number;
     getAnimationSpeed(): number;
+    getAreKeyboardShortcutsEnabled(): boolean;
     getId(): string;
     getName(): string;
     getLocale(): string;
@@ -7683,6 +7883,7 @@ export declare class UserPreferencesManager {
     getIsWrapMode(): boolean;
     getIsDynamicResizeMode(): boolean;
     getIsPasteAtCursorMode(): boolean;
+    getShowUiLabels(): boolean;
 }
 
 /** @public */
@@ -7789,8 +7990,6 @@ export declare class Vec {
     lrp(B: VecLike, t: number): Vec;
     equals(B: VecLike): boolean;
     equalsXY(x: number, y: number): boolean;
-    /** @deprecated use `uni` instead */
-    norm(): this;
     toFixed(): this;
     toString(): string;
     toJson(): VecModel;
@@ -7912,6 +8111,15 @@ export declare class Vec {
 /** @public */
 export declare type VecLike = Vec | VecModel;
 
+/**
+ * Checks if an event has already been handled. See {@link markEventAsHandled}.
+ *
+ * @public
+ */
+export declare function wasEventAlreadyHandled(e: {
+    nativeEvent: Event;
+} | Event): boolean;
+
 
 export * from "@tldraw/state";
 export * from "@tldraw/state-react";