@tldraw/editor 4.6.0-next.793daa9fe264 → 4.6.0-next.93a969f315b6
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist-cjs/index.d.ts +675 -96
- package/dist-cjs/index.js +16 -3
- package/dist-cjs/index.js.map +3 -3
- package/dist-cjs/lib/TldrawEditor.js +55 -12
- package/dist-cjs/lib/TldrawEditor.js.map +3 -3
- package/dist-cjs/lib/components/LiveCollaborators.js +1 -0
- package/dist-cjs/lib/components/LiveCollaborators.js.map +2 -2
- package/dist-cjs/lib/components/MenuClickCapture.js +16 -1
- package/dist-cjs/lib/components/MenuClickCapture.js.map +2 -2
- package/dist-cjs/lib/components/default-components/CanvasShapeIndicators.js +10 -3
- package/dist-cjs/lib/components/default-components/CanvasShapeIndicators.js.map +3 -3
- package/dist-cjs/lib/components/default-components/DefaultCanvas.js +3 -1
- package/dist-cjs/lib/components/default-components/DefaultCanvas.js.map +2 -2
- package/dist-cjs/lib/components/default-components/DefaultShapeIndicator.js +1 -1
- package/dist-cjs/lib/components/default-components/DefaultShapeIndicator.js.map +2 -2
- package/dist-cjs/lib/components/default-components/DefaultShapeIndicators.js +1 -0
- package/dist-cjs/lib/components/default-components/DefaultShapeIndicators.js.map +2 -2
- package/dist-cjs/lib/config/createTLStore.js +7 -0
- package/dist-cjs/lib/config/createTLStore.js.map +2 -2
- package/dist-cjs/lib/config/defaultAssets.js +36 -0
- package/dist-cjs/lib/config/defaultAssets.js.map +7 -0
- package/dist-cjs/lib/editor/Editor.js +215 -5
- package/dist-cjs/lib/editor/Editor.js.map +2 -2
- package/dist-cjs/lib/editor/assets/AssetUtil.js +66 -0
- package/dist-cjs/lib/editor/assets/AssetUtil.js.map +7 -0
- package/dist-cjs/lib/editor/managers/FontManager/FontManager.js.map +2 -2
- package/dist-cjs/lib/editor/managers/PerformanceManager/PerformanceApiAdapter.js +80 -0
- package/dist-cjs/lib/editor/managers/PerformanceManager/PerformanceApiAdapter.js.map +7 -0
- package/dist-cjs/lib/editor/managers/PerformanceManager/PerformanceManager.js +466 -0
- package/dist-cjs/lib/editor/managers/PerformanceManager/PerformanceManager.js.map +7 -0
- package/dist-cjs/lib/editor/managers/PerformanceManager/perf-types.js +17 -0
- package/dist-cjs/lib/editor/managers/PerformanceManager/perf-types.js.map +7 -0
- package/dist-cjs/lib/editor/managers/ThemeManager/ThemeManager.js +106 -0
- package/dist-cjs/lib/editor/managers/ThemeManager/ThemeManager.js.map +7 -0
- package/dist-cjs/lib/editor/managers/ThemeManager/defaultThemes.js +586 -0
- package/dist-cjs/lib/editor/managers/ThemeManager/defaultThemes.js.map +7 -0
- package/dist-cjs/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.js +6 -4
- package/dist-cjs/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.js.map +2 -2
- package/dist-cjs/lib/editor/shapes/ShapeUtil.js +11 -2
- package/dist-cjs/lib/editor/shapes/ShapeUtil.js.map +2 -2
- package/dist-cjs/lib/editor/shapes/group/GroupShapeUtil.js +1 -1
- package/dist-cjs/lib/editor/shapes/group/GroupShapeUtil.js.map +2 -2
- package/dist-cjs/lib/editor/shapes/shared/getPerfectDashProps.js +6 -0
- package/dist-cjs/lib/editor/shapes/shared/getPerfectDashProps.js.map +2 -2
- package/dist-cjs/lib/editor/tools/StateNode.js +14 -17
- package/dist-cjs/lib/editor/tools/StateNode.js.map +2 -2
- package/dist-cjs/lib/editor/types/SvgExportContext.js.map +2 -2
- package/dist-cjs/lib/editor/types/external-content.js.map +1 -1
- package/dist-cjs/lib/exports/getSvgJsx.js +12 -7
- package/dist-cjs/lib/exports/getSvgJsx.js.map +2 -2
- package/dist-cjs/lib/globals/environment.js +18 -1
- package/dist-cjs/lib/globals/environment.js.map +2 -2
- package/dist-cjs/lib/hooks/{useIsDarkMode.js → useColorMode.js} +14 -10
- package/dist-cjs/lib/hooks/useColorMode.js.map +7 -0
- package/dist-cjs/lib/hooks/useCursor.js +3 -7
- package/dist-cjs/lib/hooks/useCursor.js.map +2 -2
- package/dist-cjs/lib/hooks/useDarkMode.js +4 -4
- package/dist-cjs/lib/hooks/useDarkMode.js.map +2 -2
- package/dist-cjs/lib/options.js +1 -0
- package/dist-cjs/lib/options.js.map +2 -2
- package/dist-cjs/lib/utils/reparenting.js +2 -1
- package/dist-cjs/lib/utils/reparenting.js.map +2 -2
- package/dist-cjs/lib/utils/richText.js.map +2 -2
- package/dist-cjs/lib/utils/runtime.js +2 -1
- package/dist-cjs/lib/utils/runtime.js.map +2 -2
- package/dist-cjs/lib/utils/sync/hardReset.js +0 -8
- package/dist-cjs/lib/utils/sync/hardReset.js.map +2 -2
- package/dist-cjs/version.js +3 -3
- package/dist-cjs/version.js.map +1 -1
- package/dist-esm/index.d.mts +675 -96
- package/dist-esm/index.mjs +17 -6
- package/dist-esm/index.mjs.map +2 -2
- package/dist-esm/lib/TldrawEditor.mjs +58 -12
- package/dist-esm/lib/TldrawEditor.mjs.map +3 -3
- package/dist-esm/lib/components/LiveCollaborators.mjs +1 -0
- package/dist-esm/lib/components/LiveCollaborators.mjs.map +2 -2
- package/dist-esm/lib/components/MenuClickCapture.mjs +16 -1
- package/dist-esm/lib/components/MenuClickCapture.mjs.map +2 -2
- package/dist-esm/lib/components/default-components/CanvasShapeIndicators.mjs +10 -3
- package/dist-esm/lib/components/default-components/CanvasShapeIndicators.mjs.map +3 -3
- package/dist-esm/lib/components/default-components/DefaultCanvas.mjs +3 -1
- package/dist-esm/lib/components/default-components/DefaultCanvas.mjs.map +2 -2
- package/dist-esm/lib/components/default-components/DefaultShapeIndicator.mjs +1 -1
- package/dist-esm/lib/components/default-components/DefaultShapeIndicator.mjs.map +2 -2
- package/dist-esm/lib/components/default-components/DefaultShapeIndicators.mjs +1 -0
- package/dist-esm/lib/components/default-components/DefaultShapeIndicators.mjs.map +2 -2
- package/dist-esm/lib/config/createTLStore.mjs +10 -1
- package/dist-esm/lib/config/createTLStore.mjs.map +2 -2
- package/dist-esm/lib/config/defaultAssets.mjs +16 -0
- package/dist-esm/lib/config/defaultAssets.mjs.map +7 -0
- package/dist-esm/lib/editor/Editor.mjs +215 -5
- package/dist-esm/lib/editor/Editor.mjs.map +2 -2
- package/dist-esm/lib/editor/assets/AssetUtil.mjs +46 -0
- package/dist-esm/lib/editor/assets/AssetUtil.mjs.map +7 -0
- package/dist-esm/lib/editor/managers/FontManager/FontManager.mjs.map +2 -2
- package/dist-esm/lib/editor/managers/PerformanceManager/PerformanceApiAdapter.mjs +60 -0
- package/dist-esm/lib/editor/managers/PerformanceManager/PerformanceApiAdapter.mjs.map +7 -0
- package/dist-esm/lib/editor/managers/PerformanceManager/PerformanceManager.mjs +438 -0
- package/dist-esm/lib/editor/managers/PerformanceManager/PerformanceManager.mjs.map +7 -0
- package/dist-esm/lib/editor/managers/PerformanceManager/perf-types.mjs +1 -0
- package/dist-esm/lib/editor/managers/PerformanceManager/perf-types.mjs.map +7 -0
- package/dist-esm/lib/editor/managers/ThemeManager/ThemeManager.mjs +88 -0
- package/dist-esm/lib/editor/managers/ThemeManager/ThemeManager.mjs.map +7 -0
- package/dist-esm/lib/editor/managers/ThemeManager/defaultThemes.mjs +568 -0
- package/dist-esm/lib/editor/managers/ThemeManager/defaultThemes.mjs.map +7 -0
- package/dist-esm/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.mjs +6 -4
- package/dist-esm/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.mjs.map +2 -2
- package/dist-esm/lib/editor/shapes/ShapeUtil.mjs +11 -2
- package/dist-esm/lib/editor/shapes/ShapeUtil.mjs.map +2 -2
- package/dist-esm/lib/editor/shapes/group/GroupShapeUtil.mjs +1 -1
- package/dist-esm/lib/editor/shapes/group/GroupShapeUtil.mjs.map +2 -2
- package/dist-esm/lib/editor/shapes/shared/getPerfectDashProps.mjs +6 -0
- package/dist-esm/lib/editor/shapes/shared/getPerfectDashProps.mjs.map +2 -2
- package/dist-esm/lib/editor/tools/StateNode.mjs +14 -17
- package/dist-esm/lib/editor/tools/StateNode.mjs.map +2 -2
- package/dist-esm/lib/editor/types/SvgExportContext.mjs.map +2 -2
- package/dist-esm/lib/exports/getSvgJsx.mjs +12 -10
- package/dist-esm/lib/exports/getSvgJsx.mjs.map +2 -2
- package/dist-esm/lib/globals/environment.mjs +18 -1
- package/dist-esm/lib/globals/environment.mjs.map +2 -2
- package/dist-esm/lib/hooks/useColorMode.mjs +19 -0
- package/dist-esm/lib/hooks/useColorMode.mjs.map +7 -0
- package/dist-esm/lib/hooks/useCursor.mjs +3 -7
- package/dist-esm/lib/hooks/useCursor.mjs.map +2 -2
- package/dist-esm/lib/hooks/useDarkMode.mjs +4 -4
- package/dist-esm/lib/hooks/useDarkMode.mjs.map +2 -2
- package/dist-esm/lib/options.mjs +1 -0
- package/dist-esm/lib/options.mjs.map +2 -2
- package/dist-esm/lib/utils/reparenting.mjs +2 -1
- package/dist-esm/lib/utils/reparenting.mjs.map +2 -2
- package/dist-esm/lib/utils/richText.mjs.map +2 -2
- package/dist-esm/lib/utils/runtime.mjs +2 -1
- package/dist-esm/lib/utils/runtime.mjs.map +2 -2
- package/dist-esm/lib/utils/sync/hardReset.mjs +0 -8
- package/dist-esm/lib/utils/sync/hardReset.mjs.map +2 -2
- package/dist-esm/version.mjs +3 -3
- package/dist-esm/version.mjs.map +1 -1
- package/editor.css +0 -33
- package/package.json +7 -7
- package/src/index.ts +23 -6
- package/src/lib/TldrawEditor.tsx +90 -13
- package/src/lib/components/LiveCollaborators.tsx +8 -2
- package/src/lib/components/MenuClickCapture.tsx +20 -0
- package/src/lib/components/default-components/CanvasShapeIndicators.tsx +14 -3
- package/src/lib/components/default-components/DefaultCanvas.tsx +4 -1
- package/src/lib/components/default-components/DefaultShapeIndicator.tsx +2 -2
- package/src/lib/components/default-components/DefaultShapeIndicators.tsx +2 -0
- package/src/lib/config/createTLStore.ts +22 -1
- package/src/lib/config/defaultAssets.ts +19 -0
- package/src/lib/editor/Editor.ts +301 -27
- package/src/lib/editor/assets/AssetUtil.ts +85 -0
- package/src/lib/editor/managers/FontManager/FontManager.test.ts +9 -2
- package/src/lib/editor/managers/FontManager/FontManager.ts +1 -67
- package/src/lib/editor/managers/PerformanceManager/PerformanceApiAdapter.ts +82 -0
- package/src/lib/editor/managers/PerformanceManager/PerformanceManager.test.ts +522 -0
- package/src/lib/editor/managers/PerformanceManager/PerformanceManager.ts +583 -0
- package/src/lib/editor/managers/PerformanceManager/perf-types.ts +196 -0
- package/src/lib/editor/managers/ThemeManager/ThemeManager.ts +116 -0
- package/src/lib/editor/managers/ThemeManager/defaultThemes.ts +605 -0
- package/src/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.test.ts +23 -29
- package/src/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.ts +5 -3
- package/src/lib/editor/shapes/ShapeUtil.ts +28 -3
- package/src/lib/editor/shapes/group/GroupShapeUtil.tsx +1 -1
- package/src/lib/editor/shapes/shared/getPerfectDashProps.ts +7 -0
- package/src/lib/editor/tools/StateNode.ts +16 -18
- package/src/lib/editor/types/SvgExportContext.tsx +5 -0
- package/src/lib/editor/types/external-content.ts +1 -0
- package/src/lib/exports/getSvgJsx.tsx +21 -15
- package/src/lib/globals/environment.ts +18 -0
- package/src/lib/hooks/{useIsDarkMode.ts → useColorMode.ts} +9 -5
- package/src/lib/hooks/useCursor.ts +3 -7
- package/src/lib/hooks/useDarkMode.ts +4 -4
- package/src/lib/options.ts +7 -0
- package/src/lib/utils/reparenting.ts +6 -2
- package/src/lib/utils/richText.ts +1 -1
- package/src/lib/utils/runtime.ts +3 -1
- package/src/lib/utils/sync/hardReset.ts +0 -8
- package/src/version.ts +3 -3
- package/dist-cjs/lib/hooks/useIsDarkMode.js.map +0 -7
- package/dist-esm/lib/hooks/useIsDarkMode.mjs +0 -15
- package/dist-esm/lib/hooks/useIsDarkMode.mjs.map +0 -7
package/dist-cjs/index.d.ts
CHANGED
|
@@ -57,9 +57,12 @@ import { TLCamera } from '@tldraw/tlschema';
|
|
|
57
57
|
import { TLCreateShapePartial } from '@tldraw/tlschema';
|
|
58
58
|
import { TLCursor } from '@tldraw/tlschema';
|
|
59
59
|
import { TLCursorType } from '@tldraw/tlschema';
|
|
60
|
+
import { TLDefaultColor } from '@tldraw/tlschema';
|
|
61
|
+
import { TLDefaultColorStyle } from '@tldraw/tlschema';
|
|
60
62
|
import { TLDefaultDashStyle } from '@tldraw/tlschema';
|
|
61
63
|
import { TLDefaultHorizontalAlignStyle } from '@tldraw/tlschema';
|
|
62
64
|
import { TLDocument } from '@tldraw/tlschema';
|
|
65
|
+
import { TLFontFace } from '@tldraw/tlschema';
|
|
63
66
|
import { TLGroupShape } from '@tldraw/tlschema';
|
|
64
67
|
import { TLHandle } from '@tldraw/tlschema';
|
|
65
68
|
import { TLImageAsset } from '@tldraw/tlschema';
|
|
@@ -81,6 +84,11 @@ import { TLStore } from '@tldraw/tlschema';
|
|
|
81
84
|
import { TLStoreProps } from '@tldraw/tlschema';
|
|
82
85
|
import { TLStoreSchema } from '@tldraw/tlschema';
|
|
83
86
|
import { TLStoreSnapshot } from '@tldraw/tlschema';
|
|
87
|
+
import { TLTheme } from '@tldraw/tlschema';
|
|
88
|
+
import { TLThemeColors } from '@tldraw/tlschema';
|
|
89
|
+
import { TLThemeId } from '@tldraw/tlschema';
|
|
90
|
+
import { TLThemes } from '@tldraw/tlschema';
|
|
91
|
+
import { TLUnknownAsset } from '@tldraw/tlschema';
|
|
84
92
|
import { TLUnknownBinding } from '@tldraw/tlschema';
|
|
85
93
|
import { TLUnknownShape } from '@tldraw/tlschema';
|
|
86
94
|
import { TLUser } from '@tldraw/tlschema';
|
|
@@ -147,6 +155,51 @@ export declare class Arc2d extends Geometry2d {
|
|
|
147
155
|
*/
|
|
148
156
|
export declare function areAnglesCompatible(a: number, b: number): boolean;
|
|
149
157
|
|
|
158
|
+
/**
|
|
159
|
+
* Abstract base class for defining asset-type-specific behavior.
|
|
160
|
+
*
|
|
161
|
+
* Each asset type (image, video, bookmark, etc.) has a corresponding AssetUtil that handles
|
|
162
|
+
* type-specific operations like determining supported MIME types and creating assets from files.
|
|
163
|
+
*
|
|
164
|
+
* @public
|
|
165
|
+
*/
|
|
166
|
+
export declare abstract class AssetUtil<Asset extends TLAsset = TLAsset> {
|
|
167
|
+
editor: Editor;
|
|
168
|
+
/** Configure this asset util's {@link AssetUtil.options | `options`}. */
|
|
169
|
+
static configure<T extends TLAssetUtilConstructor<any, any>>(this: T, options: T extends new (...args: any[]) => {
|
|
170
|
+
options: infer Options;
|
|
171
|
+
} ? Partial<Options> : never): T;
|
|
172
|
+
constructor(editor: Editor);
|
|
173
|
+
/**
|
|
174
|
+
* Options for this asset util. Override this to provide customization options for your asset.
|
|
175
|
+
* Use {@link AssetUtil.configure} to customize existing asset utils.
|
|
176
|
+
*/
|
|
177
|
+
options: {};
|
|
178
|
+
static props?: RecordProps<TLUnknownAsset>;
|
|
179
|
+
static migrations?: LegacyMigrations | MigrationSequence | TLPropsMigrations;
|
|
180
|
+
/**
|
|
181
|
+
* The type of the asset util, which should match the asset's type.
|
|
182
|
+
*/
|
|
183
|
+
static type: string;
|
|
184
|
+
/**
|
|
185
|
+
* Get the default props for an asset of this type.
|
|
186
|
+
*/
|
|
187
|
+
abstract getDefaultProps(): Asset['props'];
|
|
188
|
+
/**
|
|
189
|
+
* Get the MIME types that this asset type supports.
|
|
190
|
+
* Return an empty array if this asset type doesn't support files (e.g. bookmarks).
|
|
191
|
+
*/
|
|
192
|
+
getSupportedMimeTypes(): readonly string[];
|
|
193
|
+
/**
|
|
194
|
+
* Check whether this asset type accepts a given MIME type.
|
|
195
|
+
*/
|
|
196
|
+
acceptsMimeType(mimeType: string): boolean;
|
|
197
|
+
/**
|
|
198
|
+
* Create an asset from a file. Return null if this asset type can't handle the file.
|
|
199
|
+
*/
|
|
200
|
+
getAssetFromFile(_file: File, _assetId: TLAssetId): Promise<Asset | null>;
|
|
201
|
+
}
|
|
202
|
+
|
|
150
203
|
/** @public */
|
|
151
204
|
export declare function average(A: VecLike, B: VecLike): string;
|
|
152
205
|
|
|
@@ -743,7 +796,7 @@ export declare function createTLSchemaFromUtils(opts: TLStoreSchemaOptions): Sto
|
|
|
743
796
|
*
|
|
744
797
|
* @public
|
|
745
798
|
*/
|
|
746
|
-
export declare function createTLStore({ initialData, defaultName, id, assets, users, onMount, collaboration, ...rest }?: TLStoreOptions): TLStore;
|
|
799
|
+
export declare function createTLStore({ initialData, defaultName, id, assets, users, onMount, collaboration, themes, ...rest }?: TLStoreOptions): TLStore;
|
|
747
800
|
|
|
748
801
|
/** @public */
|
|
749
802
|
export declare class CubicBezier2d extends Polyline2d {
|
|
@@ -818,6 +871,13 @@ export declare interface DebugFlagDefaults<T> {
|
|
|
818
871
|
|
|
819
872
|
/* Excluded from this release type: DEFAULT_CAMERA_OPTIONS */
|
|
820
873
|
|
|
874
|
+
/**
|
|
875
|
+
* The default theme definition containing color palettes for both light and dark modes.
|
|
876
|
+
*
|
|
877
|
+
* @public
|
|
878
|
+
*/
|
|
879
|
+
export declare const DEFAULT_THEME: TLTheme;
|
|
880
|
+
|
|
821
881
|
/** @public @react */
|
|
822
882
|
export declare function DefaultBackground(): JSX.Element;
|
|
823
883
|
|
|
@@ -944,6 +1004,7 @@ export declare const defaultTldrawOptions: {
|
|
|
944
1004
|
readonly tooltipDelayMs: 700;
|
|
945
1005
|
readonly uiCoarseDragDistanceSquared: 625;
|
|
946
1006
|
readonly uiDragDistanceSquared: 16;
|
|
1007
|
+
readonly useCanvasIndicators: true;
|
|
947
1008
|
readonly zoomToFitPadding: 128;
|
|
948
1009
|
};
|
|
949
1010
|
|
|
@@ -1043,7 +1104,7 @@ export declare class EdgeScrollManager {
|
|
|
1043
1104
|
/** @public */
|
|
1044
1105
|
export declare class Editor extends EventEmitter<TLEventMap> {
|
|
1045
1106
|
readonly id: string;
|
|
1046
|
-
constructor({ store, user, shapeUtils, bindingUtils, tools, getContainer, cameraOptions, initialState, autoFocus,
|
|
1107
|
+
constructor({ store, user, shapeUtils, bindingUtils, assetUtils: assetUtilConstructors, tools, getContainer, cameraOptions, initialState, autoFocus, options: _options, textOptions: _textOptions, getShapeVisibility, colorScheme, fontAssetUrls, themes, initialTheme }: TLEditorOptions);
|
|
1047
1108
|
private readonly _getShapeVisibility?;
|
|
1048
1109
|
private getIsShapeHiddenCache;
|
|
1049
1110
|
isShapeHidden(shapeOrId: TLShape | TLShapeId): boolean;
|
|
@@ -1106,7 +1167,13 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1106
1167
|
* @public
|
|
1107
1168
|
*/
|
|
1108
1169
|
readonly snaps: SnapManager;
|
|
1109
|
-
|
|
1170
|
+
/**
|
|
1171
|
+
* A manager for performance measurement hooks.
|
|
1172
|
+
*
|
|
1173
|
+
* @public
|
|
1174
|
+
*/
|
|
1175
|
+
readonly performance: PerformanceManager;
|
|
1176
|
+
/* Excluded from this release type: _spatialIndex */
|
|
1110
1177
|
/**
|
|
1111
1178
|
* A manager for the any asynchronous events and making sure they're
|
|
1112
1179
|
* cleaned up upon disposal.
|
|
@@ -1125,6 +1192,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1125
1192
|
* @public
|
|
1126
1193
|
*/
|
|
1127
1194
|
readonly user: UserPreferencesManager;
|
|
1195
|
+
/* Excluded from this release type: _themeManager */
|
|
1128
1196
|
/**
|
|
1129
1197
|
* A helper for measuring text.
|
|
1130
1198
|
*
|
|
@@ -1175,6 +1243,83 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1175
1243
|
* @public
|
|
1176
1244
|
*/
|
|
1177
1245
|
dispose(): void;
|
|
1246
|
+
/**
|
|
1247
|
+
* Get the current color mode (`'light'` or `'dark'`), based on the user's dark mode preference.
|
|
1248
|
+
*
|
|
1249
|
+
* @public
|
|
1250
|
+
*/
|
|
1251
|
+
getColorMode(): 'dark' | 'light';
|
|
1252
|
+
/**
|
|
1253
|
+
* Set the color mode. Note that this is a convenience method that passes the mode to
|
|
1254
|
+
* `user.updateUserPreferences`, which is the source of truth for the user's color mode preference.
|
|
1255
|
+
*
|
|
1256
|
+
* @public
|
|
1257
|
+
*/
|
|
1258
|
+
setColorMode(mode: 'dark' | 'light'): this;
|
|
1259
|
+
/**
|
|
1260
|
+
* Get the id of the current theme.
|
|
1261
|
+
*
|
|
1262
|
+
* @public
|
|
1263
|
+
*/
|
|
1264
|
+
getCurrentThemeId(): TLThemeId;
|
|
1265
|
+
/**
|
|
1266
|
+
* Get the current theme definition.
|
|
1267
|
+
*
|
|
1268
|
+
* @public
|
|
1269
|
+
*/
|
|
1270
|
+
getCurrentTheme(): TLTheme;
|
|
1271
|
+
/**
|
|
1272
|
+
* Set the current theme by id.
|
|
1273
|
+
*
|
|
1274
|
+
* @public
|
|
1275
|
+
*/
|
|
1276
|
+
setCurrentTheme(id: TLThemeId): this;
|
|
1277
|
+
/**
|
|
1278
|
+
* Get all registered theme definitions.
|
|
1279
|
+
*
|
|
1280
|
+
* @public
|
|
1281
|
+
*/
|
|
1282
|
+
getThemes(): TLThemes;
|
|
1283
|
+
/**
|
|
1284
|
+
* Get a single theme definition by id.
|
|
1285
|
+
*
|
|
1286
|
+
* @public
|
|
1287
|
+
*/
|
|
1288
|
+
getTheme(id: TLThemeId): TLTheme | undefined;
|
|
1289
|
+
/**
|
|
1290
|
+
* Replace all theme definitions, or update them via a callback that receives a deep copy.
|
|
1291
|
+
* The `'default'` theme must always be present in the result.
|
|
1292
|
+
*
|
|
1293
|
+
* @example
|
|
1294
|
+
* ```ts
|
|
1295
|
+
* // Replace all themes
|
|
1296
|
+
* editor.updateThemes({ default: myDefaultTheme, ocean: myOceanTheme })
|
|
1297
|
+
*
|
|
1298
|
+
* // Update via callback
|
|
1299
|
+
* editor.updateThemes((themes) => {
|
|
1300
|
+
* delete themes.ocean
|
|
1301
|
+
* return themes
|
|
1302
|
+
* })
|
|
1303
|
+
* ```
|
|
1304
|
+
*
|
|
1305
|
+
* @public
|
|
1306
|
+
*/
|
|
1307
|
+
updateThemes(themes: ((themes: TLThemes) => TLThemes) | TLThemes): this;
|
|
1308
|
+
/**
|
|
1309
|
+
* Register or update a single theme definition. The theme is keyed by its `id` property.
|
|
1310
|
+
*
|
|
1311
|
+
* @example
|
|
1312
|
+
* ```ts
|
|
1313
|
+
* // Override a property on the default theme
|
|
1314
|
+
* editor.updateTheme({ ...editor.getTheme('default')!, fontSize: 24 })
|
|
1315
|
+
*
|
|
1316
|
+
* // Register a new theme
|
|
1317
|
+
* editor.updateTheme({ id: 'ocean', ...myOceanTheme })
|
|
1318
|
+
* ```
|
|
1319
|
+
*
|
|
1320
|
+
* @public
|
|
1321
|
+
*/
|
|
1322
|
+
updateTheme(theme: TLTheme): this;
|
|
1178
1323
|
/**
|
|
1179
1324
|
* A map of shape utility classes (TLShapeUtils) by shape type.
|
|
1180
1325
|
*
|
|
@@ -1183,6 +1328,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1183
1328
|
shapeUtils: {
|
|
1184
1329
|
readonly [K in string]?: ShapeUtil<TLShape>;
|
|
1185
1330
|
};
|
|
1331
|
+
/* Excluded from this release type: _shapeUtilsByAssetType */
|
|
1186
1332
|
styleProps: {
|
|
1187
1333
|
[key: string]: Map<StyleProp<any>, string>;
|
|
1188
1334
|
};
|
|
@@ -1214,6 +1360,15 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1214
1360
|
hasShapeUtil(shape: TLShape | TLShapePartial<TLShape>): boolean;
|
|
1215
1361
|
hasShapeUtil(type: TLShape['type']): boolean;
|
|
1216
1362
|
hasShapeUtil<T extends ShapeUtil>(type: T extends ShapeUtil<infer R> ? R['type'] : string): boolean;
|
|
1363
|
+
/**
|
|
1364
|
+
* Get the shape util that handles the given asset type.
|
|
1365
|
+
* Returns the shape util whose {@link ShapeUtil.handledAssetTypes} includes
|
|
1366
|
+
* the given asset type, or undefined if none matches.
|
|
1367
|
+
*
|
|
1368
|
+
* @param assetType - The asset type string.
|
|
1369
|
+
* @public
|
|
1370
|
+
*/
|
|
1371
|
+
getShapeUtilForAssetType(assetType: string): ShapeUtil | undefined;
|
|
1217
1372
|
/**
|
|
1218
1373
|
* A map of shape utility classes (TLShapeUtils) by shape type.
|
|
1219
1374
|
*
|
|
@@ -1244,6 +1399,40 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1244
1399
|
type: S['type'];
|
|
1245
1400
|
} | S): BindingUtil<S>;
|
|
1246
1401
|
getBindingUtil<T extends BindingUtil>(type: T extends BindingUtil<infer R> ? R['type'] : string): T;
|
|
1402
|
+
/**
|
|
1403
|
+
* A map of asset utility classes by asset type.
|
|
1404
|
+
*
|
|
1405
|
+
* @public
|
|
1406
|
+
*/
|
|
1407
|
+
assetUtils: {
|
|
1408
|
+
readonly [K in string]?: AssetUtil<TLAsset>;
|
|
1409
|
+
};
|
|
1410
|
+
/**
|
|
1411
|
+
* Get an asset util from an asset or asset type.
|
|
1412
|
+
*
|
|
1413
|
+
* @param arg - An asset, asset type string, or object with type.
|
|
1414
|
+
*
|
|
1415
|
+
* @public
|
|
1416
|
+
*/
|
|
1417
|
+
getAssetUtil<S extends TLAsset>(asset: {
|
|
1418
|
+
type: S['type'];
|
|
1419
|
+
} | S): AssetUtil<S>;
|
|
1420
|
+
getAssetUtil(type: string): AssetUtil;
|
|
1421
|
+
/**
|
|
1422
|
+
* Returns true if the editor has an asset util for the given asset type.
|
|
1423
|
+
*
|
|
1424
|
+
* @public
|
|
1425
|
+
*/
|
|
1426
|
+
hasAssetUtil(arg: {
|
|
1427
|
+
type: string;
|
|
1428
|
+
} | string): boolean;
|
|
1429
|
+
/**
|
|
1430
|
+
* Get the asset util that accepts the given MIME type.
|
|
1431
|
+
* Returns null if no registered asset util accepts the MIME type.
|
|
1432
|
+
*
|
|
1433
|
+
* @public
|
|
1434
|
+
*/
|
|
1435
|
+
getAssetUtilForMimeType(mimeType: string): AssetUtil | null;
|
|
1247
1436
|
/**
|
|
1248
1437
|
* A manager for the editor's history.
|
|
1249
1438
|
*
|
|
@@ -4394,6 +4583,35 @@ export declare interface Geometry2dOptions extends TransformedGeometry2dOptions
|
|
|
4394
4583
|
*/
|
|
4395
4584
|
export declare function getArcMeasure(A: number, B: number, sweepFlag: number, largeArcFlag: number): number;
|
|
4396
4585
|
|
|
4586
|
+
/**
|
|
4587
|
+
* Resolves a color style value to its actual CSS color string for a given theme and variant.
|
|
4588
|
+
* If the color is not a default theme color, returns the color value as-is.
|
|
4589
|
+
*
|
|
4590
|
+
* @param colors - The color palette for the current color mode (e.g. `theme.colors[colorMode]`)
|
|
4591
|
+
* @param color - The color style value to resolve
|
|
4592
|
+
* @param variant - Which variant of the color to return (solid, fill, pattern, etc.)
|
|
4593
|
+
* @returns The CSS color string for the specified color and variant
|
|
4594
|
+
*
|
|
4595
|
+
* @example
|
|
4596
|
+
* ```ts
|
|
4597
|
+
* import { getColorValue } from 'tldraw'
|
|
4598
|
+
*
|
|
4599
|
+
* const colors = editor.getCurrentTheme().colors[editor.getColorMode()]
|
|
4600
|
+
*
|
|
4601
|
+
* // Get the solid variant of red
|
|
4602
|
+
* const redSolid = getColorValue(colors, 'red', 'solid') // '#e03131'
|
|
4603
|
+
*
|
|
4604
|
+
* // Get the fill variant of blue
|
|
4605
|
+
* const blueFill = getColorValue(colors, 'blue', 'fill') // '#4465e9'
|
|
4606
|
+
*
|
|
4607
|
+
* // Custom color passes through unchanged
|
|
4608
|
+
* const customColor = getColorValue(colors, '#ff0000', 'solid') // '#ff0000'
|
|
4609
|
+
* ```
|
|
4610
|
+
*
|
|
4611
|
+
* @public
|
|
4612
|
+
*/
|
|
4613
|
+
export declare function getColorValue(colors: TLThemeColors, color: string | TLDefaultColorStyle, variant: keyof TLDefaultColor): string;
|
|
4614
|
+
|
|
4397
4615
|
/** @public */
|
|
4398
4616
|
export declare function getCursor(cursor: TLCursorType, rotation?: number, color?: string): string;
|
|
4399
4617
|
|
|
@@ -4564,7 +4782,7 @@ export declare class GroupShapeUtil extends ShapeUtil<TLGroupShape> {
|
|
|
4564
4782
|
static type: "group";
|
|
4565
4783
|
static props: RecordProps<TLGroupShape>;
|
|
4566
4784
|
static migrations: TLPropsMigrations;
|
|
4567
|
-
hideSelectionBoundsFg(): boolean;
|
|
4785
|
+
hideSelectionBoundsFg(shape: TLGroupShape): boolean;
|
|
4568
4786
|
canBind(): boolean;
|
|
4569
4787
|
canResize(): boolean;
|
|
4570
4788
|
canResizeChildren(): boolean;
|
|
@@ -5206,6 +5424,94 @@ export declare function parseDeepLinkString(deepLinkString: string): TLDeepLink;
|
|
|
5206
5424
|
/** @public */
|
|
5207
5425
|
export declare type PerfectDashTerminal = 'none' | 'outset' | 'skip';
|
|
5208
5426
|
|
|
5427
|
+
/**
|
|
5428
|
+
* Optional adapter that pipes PerformanceManager events into browser
|
|
5429
|
+
* `performance.mark()` / `performance.measure()` for DevTools integration.
|
|
5430
|
+
*
|
|
5431
|
+
* Tree-shakeable — only included if imported.
|
|
5432
|
+
*
|
|
5433
|
+
* @example
|
|
5434
|
+
* ```ts
|
|
5435
|
+
* const adapter = new PerformanceApiAdapter(editor.performance)
|
|
5436
|
+
* // ... later
|
|
5437
|
+
* adapter.dispose()
|
|
5438
|
+
* ```
|
|
5439
|
+
*
|
|
5440
|
+
* @public
|
|
5441
|
+
*/
|
|
5442
|
+
export declare class PerformanceApiAdapter {
|
|
5443
|
+
private cleanups;
|
|
5444
|
+
constructor(perfManager: PerformanceManager);
|
|
5445
|
+
/** Remove all listeners and stop piping events. @public */
|
|
5446
|
+
dispose(): void;
|
|
5447
|
+
}
|
|
5448
|
+
|
|
5449
|
+
/**
|
|
5450
|
+
* Manages performance event subscriptions for the editor. Available as `editor.performance`.
|
|
5451
|
+
*
|
|
5452
|
+
* Listeners are lazy — internal editor hooks (frame, shape events) are only attached while
|
|
5453
|
+
* at least one subscriber exists, so there is zero overhead when unused.
|
|
5454
|
+
*
|
|
5455
|
+
* @example
|
|
5456
|
+
* ```ts
|
|
5457
|
+
* const unsub = editor.performance.on('interaction-end', (event) => {
|
|
5458
|
+
* console.log(`${event.name}: ${event.fps.toFixed(1)} fps, p95=${event.p95FrameTime.toFixed(1)}ms`)
|
|
5459
|
+
* })
|
|
5460
|
+
* ```
|
|
5461
|
+
*
|
|
5462
|
+
* @public
|
|
5463
|
+
*/
|
|
5464
|
+
export declare class PerformanceManager {
|
|
5465
|
+
/* Excluded from this release type: emitter */
|
|
5466
|
+
private editor;
|
|
5467
|
+
private activeInteraction;
|
|
5468
|
+
private activeCamera;
|
|
5469
|
+
private frameCleanup;
|
|
5470
|
+
private shapeCreatedCleanup;
|
|
5471
|
+
private shapeEditedCleanup;
|
|
5472
|
+
private shapeDeletedCleanup;
|
|
5473
|
+
private loafObserver;
|
|
5474
|
+
constructor(editor: Editor);
|
|
5475
|
+
/**
|
|
5476
|
+
* Subscribe to a performance event. Returns an unsubscribe function.
|
|
5477
|
+
*
|
|
5478
|
+
* @example
|
|
5479
|
+
* ```ts
|
|
5480
|
+
* const unsub = editor.performance.on('interaction-end', (event) => {
|
|
5481
|
+
* sendToAnalytics({ name: event.name, fps: event.fps, p95: event.p95FrameTime })
|
|
5482
|
+
* })
|
|
5483
|
+
* // later: unsub()
|
|
5484
|
+
* ```
|
|
5485
|
+
*
|
|
5486
|
+
* @public
|
|
5487
|
+
*/
|
|
5488
|
+
on<K extends keyof TLPerfEventMap>(event: K, fn: (...args: TLPerfEventMap[K]) => void): () => void;
|
|
5489
|
+
/**
|
|
5490
|
+
* Subscribe to a performance event once. The listener is removed after the first invocation.
|
|
5491
|
+
* Returns an unsubscribe function for early removal.
|
|
5492
|
+
*
|
|
5493
|
+
* @public
|
|
5494
|
+
*/
|
|
5495
|
+
once<K extends keyof TLPerfEventMap>(event: K, fn: (...args: TLPerfEventMap[K]) => void): () => void;
|
|
5496
|
+
/* Excluded from this release type: dispose */
|
|
5497
|
+
/* Excluded from this release type: _notifyInteractionStart */
|
|
5498
|
+
/* Excluded from this release type: _notifyInteractionEnd */
|
|
5499
|
+
/* Excluded from this release type: _notifyCameraOperation */
|
|
5500
|
+
/* Excluded from this release type: _notifyUndoRedo */
|
|
5501
|
+
private _startCameraSession;
|
|
5502
|
+
private _endCameraSession;
|
|
5503
|
+
private _onFrame;
|
|
5504
|
+
private _onShapesCreated;
|
|
5505
|
+
private _onShapesEdited;
|
|
5506
|
+
private _onShapesDeleted;
|
|
5507
|
+
private _startLoafObserver;
|
|
5508
|
+
private _stopLoafObserver;
|
|
5509
|
+
private _needsFrameListener;
|
|
5510
|
+
private _needsLoafObserver;
|
|
5511
|
+
private _maybeAttachLazyListeners;
|
|
5512
|
+
private _maybeDetachLazyListeners;
|
|
5513
|
+
}
|
|
5514
|
+
|
|
5209
5515
|
/**
|
|
5210
5516
|
* Find the approximate perimeter of an ellipse.
|
|
5211
5517
|
*
|
|
@@ -5400,6 +5706,16 @@ export declare function resizeScaled(shape: TLBaseShape<any, {
|
|
|
5400
5706
|
y: number;
|
|
5401
5707
|
};
|
|
5402
5708
|
|
|
5709
|
+
/**
|
|
5710
|
+
* Resolve a partial set of user-provided themes into a complete `TLThemes`
|
|
5711
|
+
* record by merging with `DEFAULT_THEME`. The result is suitable for passing to
|
|
5712
|
+
* `registerColorsFromThemes`, `registerFontsFromThemes`, and the
|
|
5713
|
+
* `ThemeManager` constructor.
|
|
5714
|
+
*
|
|
5715
|
+
* @public
|
|
5716
|
+
*/
|
|
5717
|
+
export declare function resolveThemes(themes?: Partial<TLThemes>): TLThemes;
|
|
5718
|
+
|
|
5403
5719
|
/** @public */
|
|
5404
5720
|
export declare type RichTextFontVisitor = (node: TiptapNode, state: RichTextFontVisitorState, addFont: (font: TLFontFace) => void) => RichTextFontVisitorState;
|
|
5405
5721
|
|
|
@@ -5681,12 +5997,32 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5681
5997
|
* @public
|
|
5682
5998
|
*/
|
|
5683
5999
|
static type: string;
|
|
6000
|
+
/**
|
|
6001
|
+
* The asset types that this shape can be created from.
|
|
6002
|
+
* When a file is dropped on the canvas, the editor finds the shape util
|
|
6003
|
+
* whose `handledAssetTypes` includes the asset's type and calls
|
|
6004
|
+
* {@link ShapeUtil.createShapeForAsset} to produce the shape.
|
|
6005
|
+
*
|
|
6006
|
+
* @public
|
|
6007
|
+
*/
|
|
6008
|
+
static handledAssetTypes?: readonly string[];
|
|
5684
6009
|
/**
|
|
5685
6010
|
* Get the default props for a shape.
|
|
5686
6011
|
*
|
|
5687
6012
|
* @public
|
|
5688
6013
|
*/
|
|
5689
6014
|
abstract getDefaultProps(): Shape['props'];
|
|
6015
|
+
/**
|
|
6016
|
+
* Create a shape partial for placing an asset on the canvas.
|
|
6017
|
+
* Only called for shapes whose constructor declares matching
|
|
6018
|
+
* {@link ShapeUtil.handledAssetTypes | `handledAssetTypes`}.
|
|
6019
|
+
*
|
|
6020
|
+
* @param asset - The asset to create a shape for.
|
|
6021
|
+
* @param position - Where to place the shape.
|
|
6022
|
+
* @returns A shape partial, or null if this shape can't be created for the asset.
|
|
6023
|
+
* @public
|
|
6024
|
+
*/
|
|
6025
|
+
createShapeForAsset?(asset: TLAsset, position: VecModel): null | TLShapePartial;
|
|
5690
6026
|
/**
|
|
5691
6027
|
* Get the shape's geometry.
|
|
5692
6028
|
*
|
|
@@ -5767,7 +6103,7 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5767
6103
|
*
|
|
5768
6104
|
* @public
|
|
5769
6105
|
*/
|
|
5770
|
-
canBind(
|
|
6106
|
+
canBind(opts: TLShapeUtilCanBindOpts): boolean;
|
|
5771
6107
|
/**
|
|
5772
6108
|
* Whether the shape can be double clicked to edit.
|
|
5773
6109
|
*
|
|
@@ -5948,7 +6284,7 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5948
6284
|
* @param type - The shape type.
|
|
5949
6285
|
* @public
|
|
5950
6286
|
*/
|
|
5951
|
-
canReceiveNewChildrenOfType(shape: Shape,
|
|
6287
|
+
canReceiveNewChildrenOfType(shape: Shape, type: TLShape['type']): boolean;
|
|
5952
6288
|
/**
|
|
5953
6289
|
* Get the shape as an SVG object.
|
|
5954
6290
|
*
|
|
@@ -6391,6 +6727,8 @@ export declare abstract class StateNode implements Partial<TLEventHandlers> {
|
|
|
6391
6727
|
static children?: () => TLStateNodeConstructor[];
|
|
6392
6728
|
static isLockable: boolean;
|
|
6393
6729
|
static useCoalescedEvents: boolean;
|
|
6730
|
+
/** Set to `true` in subclasses to emit interaction-start/end performance events when this state is entered/exited. */
|
|
6731
|
+
static trackPerformance: boolean;
|
|
6394
6732
|
id: string;
|
|
6395
6733
|
type: 'branch' | 'leaf' | 'root';
|
|
6396
6734
|
shapeType?: string;
|
|
@@ -6525,6 +6863,10 @@ export declare interface SvgExportContext {
|
|
|
6525
6863
|
* Whether the export should be in dark mode.
|
|
6526
6864
|
*/
|
|
6527
6865
|
readonly isDarkMode: boolean;
|
|
6866
|
+
/**
|
|
6867
|
+
* The color mode to use for this export.
|
|
6868
|
+
*/
|
|
6869
|
+
readonly colorMode: 'dark' | 'light';
|
|
6528
6870
|
/**
|
|
6529
6871
|
* The scale of the export - how much CSS pixels will be scaled up/down by.
|
|
6530
6872
|
*/
|
|
@@ -6595,6 +6937,47 @@ export declare class TextManager {
|
|
|
6595
6937
|
}[];
|
|
6596
6938
|
}
|
|
6597
6939
|
|
|
6940
|
+
/**
|
|
6941
|
+
* Manages the editor's color themes.
|
|
6942
|
+
*
|
|
6943
|
+
* Stores named theme definitions (each containing light and dark color palettes
|
|
6944
|
+
* alongside shared properties like font size). The current theme is resolved by
|
|
6945
|
+
* combining the current theme name with the user's color mode preference.
|
|
6946
|
+
*
|
|
6947
|
+
* **Terminology:**
|
|
6948
|
+
* - **Theme** (`TLTheme`): A named set of colors and typographic values for both light and dark modes.
|
|
6949
|
+
* - **Color mode** (`'light' | 'dark'`): The resolved appearance mode, derived from the user's
|
|
6950
|
+
* `colorScheme` preference (`'light' | 'dark' | 'system'`). Access via `getColorMode()`.
|
|
6951
|
+
*
|
|
6952
|
+
* @public
|
|
6953
|
+
*/
|
|
6954
|
+
export declare class ThemeManager {
|
|
6955
|
+
private readonly editor;
|
|
6956
|
+
private readonly _themes;
|
|
6957
|
+
private readonly _currentThemeId;
|
|
6958
|
+
constructor(editor: Editor, options: {
|
|
6959
|
+
initial: TLThemeId;
|
|
6960
|
+
themes: TLThemes;
|
|
6961
|
+
});
|
|
6962
|
+
/** Get the current color mode based on the user's dark mode preference. */
|
|
6963
|
+
getColorMode(): 'dark' | 'light';
|
|
6964
|
+
/** Get all registered theme definitions. */
|
|
6965
|
+
getThemes(): TLThemes;
|
|
6966
|
+
/** Get a single theme definition by id. */
|
|
6967
|
+
getTheme(id: TLThemeId): TLTheme | undefined;
|
|
6968
|
+
/** Get the id of the current theme. */
|
|
6969
|
+
getCurrentThemeId(): TLThemeId;
|
|
6970
|
+
getCurrentTheme(): TLTheme;
|
|
6971
|
+
/** Set the current theme by id. The theme must have been previously registered. */
|
|
6972
|
+
setCurrentTheme(id: TLThemeId): void;
|
|
6973
|
+
/** Replace all theme definitions, or update them via a callback that receives a deep copy. */
|
|
6974
|
+
updateThemes(themes: ((themes: TLThemes) => TLThemes) | TLThemes): void;
|
|
6975
|
+
/** Register or update a named theme definition. */
|
|
6976
|
+
updateTheme(theme: TLTheme): void;
|
|
6977
|
+
/** Clean up any resources held by the manager. */
|
|
6978
|
+
dispose(): void;
|
|
6979
|
+
}
|
|
6980
|
+
|
|
6598
6981
|
/* Excluded from this release type: TickManager */
|
|
6599
6982
|
|
|
6600
6983
|
/**
|
|
@@ -6613,12 +6996,23 @@ export declare type TiptapNode = Node_2;
|
|
|
6613
6996
|
/** @public */
|
|
6614
6997
|
export declare type TLAdjacentDirection = 'down' | 'left' | 'next' | 'prev' | 'right' | 'up';
|
|
6615
6998
|
|
|
6999
|
+
/** @public */
|
|
7000
|
+
export declare type TLAnyAssetUtilConstructor = TLAssetUtilConstructor<any>;
|
|
7001
|
+
|
|
6616
7002
|
/** @public */
|
|
6617
7003
|
export declare type TLAnyBindingUtilConstructor = TLBindingUtilConstructor<any>;
|
|
6618
7004
|
|
|
6619
7005
|
/** @public */
|
|
6620
7006
|
export declare type TLAnyShapeUtilConstructor = TLShapeUtilConstructor<any>;
|
|
6621
7007
|
|
|
7008
|
+
/** @public */
|
|
7009
|
+
export declare interface TLAssetUtilConstructor<T extends TLAsset = TLAsset, U extends AssetUtil<T> = AssetUtil<T>> {
|
|
7010
|
+
new (editor: Editor): U;
|
|
7011
|
+
type: T['type'];
|
|
7012
|
+
props?: RecordProps<T>;
|
|
7013
|
+
migrations?: LegacyMigrations | MigrationSequence | TLPropsMigrations;
|
|
7014
|
+
}
|
|
7015
|
+
|
|
6622
7016
|
/** @public */
|
|
6623
7017
|
export declare type TLBaseBoxShape = ExtractShapeByProps<{
|
|
6624
7018
|
h: number;
|
|
@@ -6708,6 +7102,29 @@ export declare interface TLCameraConstraints {
|
|
|
6708
7102
|
};
|
|
6709
7103
|
}
|
|
6710
7104
|
|
|
7105
|
+
/**
|
|
7106
|
+
* Emitted when a camera operation ends (after a 50ms debounce), with aggregated frame time stats.
|
|
7107
|
+
* @public
|
|
7108
|
+
*/
|
|
7109
|
+
export declare interface TLCameraEndPerfEvent extends TLPerfFrameTimeStats {
|
|
7110
|
+
/** Whether this was a pan or zoom operation. */
|
|
7111
|
+
type: 'panning' | 'zooming';
|
|
7112
|
+
/** Total shapes on the current page. */
|
|
7113
|
+
shapeCount: number;
|
|
7114
|
+
/** Number of shapes visible (not culled) in the viewport. */
|
|
7115
|
+
visibleShapeCount: number;
|
|
7116
|
+
/** Number of shapes culled (off-screen) from rendering. */
|
|
7117
|
+
culledShapeCount: number;
|
|
7118
|
+
/** Viewport width in screen pixels. */
|
|
7119
|
+
viewportWidth: number;
|
|
7120
|
+
/** Viewport height in screen pixels. */
|
|
7121
|
+
viewportHeight: number;
|
|
7122
|
+
/** Camera zoom level (`camera.z`) at session end. */
|
|
7123
|
+
zoomLevel: number;
|
|
7124
|
+
/** `performance.now()` when the camera session ended. */
|
|
7125
|
+
timestamp: number;
|
|
7126
|
+
}
|
|
7127
|
+
|
|
6711
7128
|
/** @public */
|
|
6712
7129
|
export declare interface TLCameraMoveOptions {
|
|
6713
7130
|
/** Whether to move the camera immediately, rather than on the next tick. */
|
|
@@ -6746,6 +7163,17 @@ export declare interface TLCameraOptions {
|
|
|
6746
7163
|
constraints?: TLCameraConstraints;
|
|
6747
7164
|
}
|
|
6748
7165
|
|
|
7166
|
+
/**
|
|
7167
|
+
* Emitted when a camera operation (pan or zoom) begins.
|
|
7168
|
+
* @public
|
|
7169
|
+
*/
|
|
7170
|
+
export declare interface TLCameraStartPerfEvent {
|
|
7171
|
+
/** Whether this is a pan or zoom operation. */
|
|
7172
|
+
type: 'panning' | 'zooming';
|
|
7173
|
+
/** `performance.now()` when the camera session started. */
|
|
7174
|
+
timestamp: number;
|
|
7175
|
+
}
|
|
7176
|
+
|
|
6749
7177
|
/** @public */
|
|
6750
7178
|
export declare type TLCancelEvent = (info: TLCancelEventInfo) => void;
|
|
6751
7179
|
|
|
@@ -6968,6 +7396,10 @@ export declare interface TldrawEditorBaseProps {
|
|
|
6968
7396
|
* An array of binding utils to use in the editor.
|
|
6969
7397
|
*/
|
|
6970
7398
|
bindingUtils?: readonly TLAnyBindingUtilConstructor[];
|
|
7399
|
+
/**
|
|
7400
|
+
* An array of asset utils to use in the editor.
|
|
7401
|
+
*/
|
|
7402
|
+
assetUtils?: readonly TLAnyAssetUtilConstructor[];
|
|
6971
7403
|
/**
|
|
6972
7404
|
* An array of tools to add to the editor's state chart.
|
|
6973
7405
|
*/
|
|
@@ -6997,9 +7429,21 @@ export declare interface TldrawEditorBaseProps {
|
|
|
6997
7429
|
*/
|
|
6998
7430
|
user?: TLCurrentUser;
|
|
6999
7431
|
/**
|
|
7000
|
-
*
|
|
7432
|
+
* The editor's color scheme. Defaults to `'light'`.
|
|
7433
|
+
*
|
|
7434
|
+
* - `'light'` - Always use light mode.
|
|
7435
|
+
* - `'dark'` - Always use dark mode.
|
|
7436
|
+
* - `'system'` - Follow the OS color scheme preference.
|
|
7437
|
+
*/
|
|
7438
|
+
colorScheme?: 'dark' | 'light' | 'system';
|
|
7439
|
+
/**
|
|
7440
|
+
* Named themes for the editor.
|
|
7001
7441
|
*/
|
|
7002
|
-
|
|
7442
|
+
themes?: Partial<TLThemes>;
|
|
7443
|
+
/**
|
|
7444
|
+
* The id of the initially active theme. Defaults to `'default'`.
|
|
7445
|
+
*/
|
|
7446
|
+
initialTheme?: TLThemeId;
|
|
7003
7447
|
/**
|
|
7004
7448
|
* Camera options for the editor.
|
|
7005
7449
|
*
|
|
@@ -7259,6 +7703,12 @@ export declare interface TldrawOptions {
|
|
|
7259
7703
|
* viewport's page dimensions regardless of overview zoom changes.
|
|
7260
7704
|
*/
|
|
7261
7705
|
readonly quickZoomPreservesScreenBounds: boolean;
|
|
7706
|
+
/**
|
|
7707
|
+
* Whether to use 2D canvas rendering for shape indicators. When true (default),
|
|
7708
|
+
* shapes that support it will render indicators on a 2D canvas for better
|
|
7709
|
+
* performance. When false, all indicators use legacy SVG rendering.
|
|
7710
|
+
*/
|
|
7711
|
+
readonly useCanvasIndicators: boolean;
|
|
7262
7712
|
/**
|
|
7263
7713
|
* Called before content is written to the clipboard during a copy or cut operation.
|
|
7264
7714
|
* Receives the serialized content (shapes, bindings, assets) and can filter or transform
|
|
@@ -7392,14 +7842,13 @@ export declare interface TLEditorOptions {
|
|
|
7392
7842
|
*/
|
|
7393
7843
|
bindingUtils: readonly TLAnyBindingUtilConstructor[];
|
|
7394
7844
|
/**
|
|
7395
|
-
* An array of
|
|
7845
|
+
* An array of asset utils to use in the editor. These will be used to handle asset-type-specific behavior.
|
|
7396
7846
|
*/
|
|
7397
|
-
|
|
7847
|
+
assetUtils?: readonly TLAnyAssetUtilConstructor[];
|
|
7398
7848
|
/**
|
|
7399
|
-
*
|
|
7400
|
-
* given, the body element will be used.
|
|
7849
|
+
* An array of tools to use in the editor. These will be used to handle events and manage user interactions in the editor.
|
|
7401
7850
|
*/
|
|
7402
|
-
|
|
7851
|
+
tools: readonly TLStateNodeConstructor[];
|
|
7403
7852
|
/**
|
|
7404
7853
|
* A user defined externally to replace the default user.
|
|
7405
7854
|
*/
|
|
@@ -7412,27 +7861,15 @@ export declare interface TLEditorOptions {
|
|
|
7412
7861
|
* Whether to automatically focus the editor when it mounts.
|
|
7413
7862
|
*/
|
|
7414
7863
|
autoFocus?: boolean;
|
|
7415
|
-
/**
|
|
7416
|
-
* Whether to infer dark mode from the user's system preferences. Defaults to false.
|
|
7417
|
-
*/
|
|
7418
|
-
inferDarkMode?: boolean;
|
|
7419
|
-
/**
|
|
7420
|
-
* Options for the editor's camera.
|
|
7421
|
-
*
|
|
7422
|
-
* @deprecated Use `options.cameraOptions` instead. This will be removed in a future release.
|
|
7423
|
-
*/
|
|
7424
|
-
cameraOptions?: Partial<TLCameraOptions>;
|
|
7425
|
-
options?: Partial<TldrawOptions>;
|
|
7426
|
-
/**
|
|
7427
|
-
* Text options for the editor.
|
|
7428
|
-
*
|
|
7429
|
-
* @deprecated Use `options.text` instead. This prop will be removed in a future release.
|
|
7430
|
-
*/
|
|
7431
|
-
textOptions?: TLTextOptions;
|
|
7432
7864
|
licenseKey?: string;
|
|
7433
7865
|
fontAssetUrls?: {
|
|
7434
7866
|
[key: string]: string | undefined;
|
|
7435
7867
|
};
|
|
7868
|
+
/**
|
|
7869
|
+
* Should return a containing html element which has all the styles applied to the editor. If not
|
|
7870
|
+
* given, the body element will be used.
|
|
7871
|
+
*/
|
|
7872
|
+
getContainer(): HTMLElement;
|
|
7436
7873
|
/**
|
|
7437
7874
|
* Provides a way to hide shapes.
|
|
7438
7875
|
*
|
|
@@ -7449,6 +7886,40 @@ export declare interface TLEditorOptions {
|
|
|
7449
7886
|
* @param editor - The editor instance.
|
|
7450
7887
|
*/
|
|
7451
7888
|
getShapeVisibility?(shape: TLShape, editor: Editor): 'hidden' | 'inherit' | 'visible' | null | undefined;
|
|
7889
|
+
/**
|
|
7890
|
+
* Named theme definitions for the editor. Each theme contains shared
|
|
7891
|
+
* properties (font size, line height, stroke width) and color palettes
|
|
7892
|
+
* for both light and dark modes.
|
|
7893
|
+
*/
|
|
7894
|
+
themes?: Partial<TLThemes>;
|
|
7895
|
+
/**
|
|
7896
|
+
* The id of the initially active theme. Defaults to `'default'`.
|
|
7897
|
+
*/
|
|
7898
|
+
initialTheme?: TLThemeId;
|
|
7899
|
+
/**
|
|
7900
|
+
* The editor's color scheme preference, controls the default color mode. Defaults to `'light'`.
|
|
7901
|
+
*
|
|
7902
|
+
* - `'light'` - Always use light mode.
|
|
7903
|
+
* - `'dark'` - Always use dark mode.
|
|
7904
|
+
* - `'system'` - Follow the OS color scheme preference.
|
|
7905
|
+
*/
|
|
7906
|
+
colorScheme?: 'dark' | 'light' | 'system';
|
|
7907
|
+
/**
|
|
7908
|
+
* Additional configuration options for the tldraw editor.
|
|
7909
|
+
*/
|
|
7910
|
+
options?: Partial<TldrawOptions>;
|
|
7911
|
+
/**
|
|
7912
|
+
* Options for the editor's camera.
|
|
7913
|
+
*
|
|
7914
|
+
* @deprecated Use `options.cameraOptions` instead. This will be removed in a future release.
|
|
7915
|
+
*/
|
|
7916
|
+
cameraOptions?: Partial<TLCameraOptions>;
|
|
7917
|
+
/**
|
|
7918
|
+
* Text options for the editor.
|
|
7919
|
+
*
|
|
7920
|
+
* @deprecated Use `options.text` instead. This prop will be removed in a future release.
|
|
7921
|
+
*/
|
|
7922
|
+
textOptions?: TLTextOptions;
|
|
7452
7923
|
}
|
|
7453
7924
|
|
|
7454
7925
|
/**
|
|
@@ -7507,6 +7978,7 @@ export declare const tlenv: {
|
|
|
7507
7978
|
*/
|
|
7508
7979
|
export declare const tlenvReactive: Atom< {
|
|
7509
7980
|
isCoarsePointer: boolean;
|
|
7981
|
+
supportsP3ColorSpace: boolean;
|
|
7510
7982
|
}, unknown>;
|
|
7511
7983
|
|
|
7512
7984
|
/** @public */
|
|
@@ -7635,6 +8107,7 @@ export declare interface TLFileReplaceExternalContent extends TLBaseExternalCont
|
|
|
7635
8107
|
type: 'file-replace';
|
|
7636
8108
|
file: File;
|
|
7637
8109
|
shapeId: TLShapeId;
|
|
8110
|
+
/** @deprecated This field is no longer used by the default handler. It may be removed in a future version. */
|
|
7638
8111
|
isImage: boolean;
|
|
7639
8112
|
}
|
|
7640
8113
|
|
|
@@ -7646,69 +8119,18 @@ export declare interface TLFilesExternalContent extends TLBaseExternalContent {
|
|
|
7646
8119
|
}
|
|
7647
8120
|
|
|
7648
8121
|
/**
|
|
7649
|
-
*
|
|
7650
|
-
* ones in the
|
|
7651
|
-
* {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face | css `@font-face` rule}.
|
|
7652
|
-
* @public
|
|
7653
|
-
*/
|
|
7654
|
-
export declare interface TLFontFace {
|
|
7655
|
-
/**
|
|
7656
|
-
* How this font can be referred to in CSS.
|
|
7657
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-family | `font-family`}.
|
|
7658
|
-
*/
|
|
7659
|
-
readonly family: string;
|
|
7660
|
-
/**
|
|
7661
|
-
* The source of the font. This
|
|
7662
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src | `src`}.
|
|
7663
|
-
*/
|
|
7664
|
-
readonly src: TLFontFaceSource;
|
|
7665
|
-
/**
|
|
7666
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/ascent-override | `ascent-override`}.
|
|
7667
|
-
*/
|
|
7668
|
-
readonly ascentOverride?: string;
|
|
7669
|
-
/**
|
|
7670
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/descent-override | `descent-override`}.
|
|
7671
|
-
*/
|
|
7672
|
-
readonly descentOverride?: string;
|
|
7673
|
-
/**
|
|
7674
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-stretch | `font-stretch`}.
|
|
7675
|
-
*/
|
|
7676
|
-
readonly stretch?: string;
|
|
7677
|
-
/**
|
|
7678
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-style | `font-style`}.
|
|
7679
|
-
*/
|
|
7680
|
-
readonly style?: string;
|
|
7681
|
-
/**
|
|
7682
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-weight | `font-weight`}.
|
|
7683
|
-
*/
|
|
7684
|
-
readonly weight?: string;
|
|
7685
|
-
/**
|
|
7686
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-feature-settings | `font-feature-settings`}.
|
|
7687
|
-
*/
|
|
7688
|
-
readonly featureSettings?: string;
|
|
7689
|
-
/**
|
|
7690
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/line-gap-override | `line-gap-override`}.
|
|
7691
|
-
*/
|
|
7692
|
-
readonly lineGapOverride?: string;
|
|
7693
|
-
/**
|
|
7694
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/unicode-range | `unicode-range`}.
|
|
7695
|
-
*/
|
|
7696
|
-
readonly unicodeRange?: string;
|
|
7697
|
-
}
|
|
7698
|
-
|
|
7699
|
-
/**
|
|
7700
|
-
* Represents the `src` property of a {@link TLFontFace}.
|
|
7701
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src | `src`} for details of the properties here.
|
|
8122
|
+
* Emitted every animation frame when at least one `'frame'` listener is registered.
|
|
7702
8123
|
* @public
|
|
7703
8124
|
*/
|
|
7704
|
-
export declare interface
|
|
7705
|
-
/**
|
|
7706
|
-
|
|
7707
|
-
|
|
7708
|
-
|
|
7709
|
-
|
|
7710
|
-
|
|
7711
|
-
|
|
8125
|
+
export declare interface TLFramePerfEvent {
|
|
8126
|
+
/** Time since the last frame in ms. */
|
|
8127
|
+
elapsed: number;
|
|
8128
|
+
/** Total shapes on the current page. */
|
|
8129
|
+
shapeCount: number;
|
|
8130
|
+
/** Number of shapes culled (off-screen) from rendering. */
|
|
8131
|
+
culledShapeCount: number;
|
|
8132
|
+
/** Number of shapes visible (not culled) in the viewport. */
|
|
8133
|
+
visibleShapeCount: number;
|
|
7712
8134
|
}
|
|
7713
8135
|
|
|
7714
8136
|
/** Additional options for the {@link ShapeUtil.getGeometry} method.
|
|
@@ -7853,6 +8275,38 @@ export declare type TLIndicatorPath = {
|
|
|
7853
8275
|
path: Path2D;
|
|
7854
8276
|
} | Path2D;
|
|
7855
8277
|
|
|
8278
|
+
/**
|
|
8279
|
+
* Emitted when an interaction state is exited, with aggregated frame time stats.
|
|
8280
|
+
* @public
|
|
8281
|
+
*/
|
|
8282
|
+
export declare interface TLInteractionEndPerfEvent extends TLPerfFrameTimeStats {
|
|
8283
|
+
/** The state node id (e.g. `'translating'`). */
|
|
8284
|
+
name: string;
|
|
8285
|
+
/** Full tool path (e.g. `'select.translating'`). */
|
|
8286
|
+
path: string;
|
|
8287
|
+
/** Total shapes on the current page. */
|
|
8288
|
+
shapeCount: number;
|
|
8289
|
+
/** Breakdown of selected shape types at interaction start (e.g. `{ geo: 2, draw: 1 }`). */
|
|
8290
|
+
selectedShapeTypes: Record<string, number>;
|
|
8291
|
+
/** Camera zoom level (`camera.z`) at interaction end. */
|
|
8292
|
+
zoomLevel: number;
|
|
8293
|
+
/** `performance.now()` when the interaction ended. */
|
|
8294
|
+
timestamp: number;
|
|
8295
|
+
}
|
|
8296
|
+
|
|
8297
|
+
/**
|
|
8298
|
+
* Emitted when an interaction state (e.g. translating, resizing) is entered.
|
|
8299
|
+
* @public
|
|
8300
|
+
*/
|
|
8301
|
+
export declare interface TLInteractionStartPerfEvent {
|
|
8302
|
+
/** The state node id (e.g. `'translating'`). */
|
|
8303
|
+
name: string;
|
|
8304
|
+
/** Full tool path (e.g. `'select.translating'`). */
|
|
8305
|
+
path: string;
|
|
8306
|
+
/** `performance.now()` when the interaction started. */
|
|
8307
|
+
timestamp: number;
|
|
8308
|
+
}
|
|
8309
|
+
|
|
7856
8310
|
/** @public */
|
|
7857
8311
|
export declare type TLInterruptEvent = (info: TLInterruptEventInfo) => void;
|
|
7858
8312
|
|
|
@@ -8100,6 +8554,94 @@ export declare const tlmenus: {
|
|
|
8100
8554
|
*/
|
|
8101
8555
|
export declare type TLOnMountHandler = (editor: Editor) => (() => undefined | void) | undefined | void;
|
|
8102
8556
|
|
|
8557
|
+
/**
|
|
8558
|
+
* Map of all performance event names to their payload types.
|
|
8559
|
+
* Used with {@link PerformanceManager.on} and {@link PerformanceManager.once}.
|
|
8560
|
+
* @public
|
|
8561
|
+
*/
|
|
8562
|
+
export declare interface TLPerfEventMap {
|
|
8563
|
+
/** An interaction state was entered. */
|
|
8564
|
+
'interaction-start': [TLInteractionStartPerfEvent];
|
|
8565
|
+
/** An interaction state was exited, with aggregated frame time stats. */
|
|
8566
|
+
'interaction-end': [TLInteractionEndPerfEvent];
|
|
8567
|
+
/** A camera operation (pan/zoom) began. */
|
|
8568
|
+
'camera-start': [TLCameraStartPerfEvent];
|
|
8569
|
+
/** A camera operation ended (after debounce), with aggregated frame time stats. */
|
|
8570
|
+
'camera-end': [TLCameraEndPerfEvent];
|
|
8571
|
+
/** Shapes were created. */
|
|
8572
|
+
'shapes-created': [TLShapeOperationPerfEvent];
|
|
8573
|
+
/** Shapes were updated. */
|
|
8574
|
+
'shapes-updated': [TLShapeOperationPerfEvent];
|
|
8575
|
+
/** Shapes were deleted. */
|
|
8576
|
+
'shapes-deleted': [TLShapeOperationPerfEvent];
|
|
8577
|
+
/** An animation frame was rendered. Only fires when listeners are registered. */
|
|
8578
|
+
frame: [TLFramePerfEvent];
|
|
8579
|
+
/** An undo operation was performed. */
|
|
8580
|
+
undo: [TLUndoRedoPerfEvent];
|
|
8581
|
+
/** A redo operation was performed. */
|
|
8582
|
+
redo: [TLUndoRedoPerfEvent];
|
|
8583
|
+
}
|
|
8584
|
+
|
|
8585
|
+
/**
|
|
8586
|
+
* Common frame time statistics shared by interaction and camera end events.
|
|
8587
|
+
* @public
|
|
8588
|
+
*/
|
|
8589
|
+
export declare interface TLPerfFrameTimeStats {
|
|
8590
|
+
/** Total duration of the session in ms. */
|
|
8591
|
+
duration: number;
|
|
8592
|
+
/** Average frames per second during the session. */
|
|
8593
|
+
fps: number;
|
|
8594
|
+
/** Total number of frames recorded. */
|
|
8595
|
+
frameCount: number;
|
|
8596
|
+
/** Mean frame duration in ms. */
|
|
8597
|
+
avgFrameTime: number;
|
|
8598
|
+
/** Median (p50) frame duration in ms. */
|
|
8599
|
+
medianFrameTime: number;
|
|
8600
|
+
/** 95th percentile frame duration in ms. */
|
|
8601
|
+
p95FrameTime: number;
|
|
8602
|
+
/** 99th percentile frame duration in ms. */
|
|
8603
|
+
p99FrameTime: number;
|
|
8604
|
+
/** Shortest frame duration in ms. */
|
|
8605
|
+
minFrameTime: number;
|
|
8606
|
+
/** Longest frame duration in ms. */
|
|
8607
|
+
maxFrameTime: number;
|
|
8608
|
+
/** Raw frame durations for local analysis. Exclude when sending to analytics. */
|
|
8609
|
+
frameTimes: number[];
|
|
8610
|
+
/**
|
|
8611
|
+
* Long animation frames observed during this period (Chromium 123+).
|
|
8612
|
+
* Only present when the browser supports the Long Animation Frames API and
|
|
8613
|
+
* at least one long frame was observed.
|
|
8614
|
+
* Exclude when sending to analytics — entries are large and contain script URLs.
|
|
8615
|
+
*/
|
|
8616
|
+
longAnimationFrames?: TLPerfLongAnimationFrame[];
|
|
8617
|
+
}
|
|
8618
|
+
|
|
8619
|
+
/**
|
|
8620
|
+
* A long animation frame observed by the browser during an interaction.
|
|
8621
|
+
* Available only in browsers that support the Long Animation Frames API (Chromium 123+).
|
|
8622
|
+
* @public
|
|
8623
|
+
*/
|
|
8624
|
+
export declare interface TLPerfLongAnimationFrame {
|
|
8625
|
+
/** Frame start time (relative to timeOrigin). */
|
|
8626
|
+
startTime: number;
|
|
8627
|
+
/** Total frame duration in ms. */
|
|
8628
|
+
duration: number;
|
|
8629
|
+
/** Time the main thread was blocked in ms. */
|
|
8630
|
+
blockingDuration: number;
|
|
8631
|
+
/** Scripts that contributed to the long frame. */
|
|
8632
|
+
scripts: TLPerfLongAnimationFrameScript[];
|
|
8633
|
+
}
|
|
8634
|
+
|
|
8635
|
+
/** A script attribution entry from a long animation frame. @public */
|
|
8636
|
+
export declare interface TLPerfLongAnimationFrameScript {
|
|
8637
|
+
/** The script source URL (may be empty for inline scripts). */
|
|
8638
|
+
sourceURL: string;
|
|
8639
|
+
/** The function name or invoker description. */
|
|
8640
|
+
invoker: string;
|
|
8641
|
+
/** Time spent in this script in ms. */
|
|
8642
|
+
duration: number;
|
|
8643
|
+
}
|
|
8644
|
+
|
|
8103
8645
|
/** @public */
|
|
8104
8646
|
export declare type TLPinchEvent = (info: TLPinchEventInfo) => void;
|
|
8105
8647
|
|
|
@@ -8287,6 +8829,21 @@ export declare interface TLShapeIndicatorsProps {
|
|
|
8287
8829
|
showAll?: boolean;
|
|
8288
8830
|
}
|
|
8289
8831
|
|
|
8832
|
+
/**
|
|
8833
|
+
* Emitted when shapes are created, updated, or deleted.
|
|
8834
|
+
* @public
|
|
8835
|
+
*/
|
|
8836
|
+
export declare interface TLShapeOperationPerfEvent {
|
|
8837
|
+
/** The operation type. */
|
|
8838
|
+
operation: 'create' | 'delete' | 'update';
|
|
8839
|
+
/** Number of shapes affected. */
|
|
8840
|
+
count: number;
|
|
8841
|
+
/** Breakdown by shape type (e.g. `{ geo: 2, draw: 1 }`). */
|
|
8842
|
+
shapeTypes: Record<string, number>;
|
|
8843
|
+
/** `performance.now()` when the operation occurred. */
|
|
8844
|
+
timestamp: number;
|
|
8845
|
+
}
|
|
8846
|
+
|
|
8290
8847
|
/**
|
|
8291
8848
|
* Options passed to {@link ShapeUtil.canBeLaidOut}.
|
|
8292
8849
|
*
|
|
@@ -8344,6 +8901,7 @@ export declare interface TLShapeUtilConstructor<T extends TLShape, U extends Sha
|
|
|
8344
8901
|
type: T['type'];
|
|
8345
8902
|
props?: RecordProps<T>;
|
|
8346
8903
|
migrations?: LegacyMigrations | MigrationSequence | TLPropsMigrations;
|
|
8904
|
+
handledAssetTypes?: readonly string[];
|
|
8347
8905
|
}
|
|
8348
8906
|
|
|
8349
8907
|
/** @public */
|
|
@@ -8371,6 +8929,7 @@ export declare interface TLStateNodeConstructor {
|
|
|
8371
8929
|
children?(): TLStateNodeConstructor[];
|
|
8372
8930
|
isLockable: boolean;
|
|
8373
8931
|
useCoalescedEvents: boolean;
|
|
8932
|
+
trackPerformance: boolean;
|
|
8374
8933
|
}
|
|
8375
8934
|
|
|
8376
8935
|
/** @public */
|
|
@@ -8383,6 +8942,12 @@ export declare interface TLStoreBaseOptions {
|
|
|
8383
8942
|
defaultName?: string;
|
|
8384
8943
|
/** How should this store upload & resolve assets? */
|
|
8385
8944
|
assets?: TLAssetStore;
|
|
8945
|
+
/**
|
|
8946
|
+
* Named theme definitions. When provided, custom color names are automatically
|
|
8947
|
+
* registered before the store is constructed so persisted data with those
|
|
8948
|
+
* colors passes validation on load.
|
|
8949
|
+
*/
|
|
8950
|
+
themes?: Partial<TLThemes>;
|
|
8386
8951
|
/** How should this store resolve users for attribution? */
|
|
8387
8952
|
users?: TLUserStore;
|
|
8388
8953
|
/** Called when the store is connected to an {@link @tldraw/editor#Editor}. */
|
|
@@ -8404,6 +8969,7 @@ export declare type TLStoreOptions = TLStoreBaseOptions & {
|
|
|
8404
8969
|
|
|
8405
8970
|
/** @public */
|
|
8406
8971
|
export declare type TLStoreSchemaOptions = {
|
|
8972
|
+
assetUtils?: readonly TLAnyAssetUtilConstructor[];
|
|
8407
8973
|
bindingUtils?: readonly TLAnyBindingUtilConstructor[];
|
|
8408
8974
|
migrations?: readonly MigrationSequence[];
|
|
8409
8975
|
records?: Record<string, CustomRecordInfo>;
|
|
@@ -8541,6 +9107,19 @@ export declare interface TLTldrawExternalContentSource {
|
|
|
8541
9107
|
data: TLContent;
|
|
8542
9108
|
}
|
|
8543
9109
|
|
|
9110
|
+
/**
|
|
9111
|
+
* Emitted after an undo or redo operation.
|
|
9112
|
+
* @public
|
|
9113
|
+
*/
|
|
9114
|
+
export declare interface TLUndoRedoPerfEvent {
|
|
9115
|
+
/** Whether this was an undo or redo. */
|
|
9116
|
+
type: 'redo' | 'undo';
|
|
9117
|
+
/** Number of undo steps remaining. */
|
|
9118
|
+
undoDepth: number;
|
|
9119
|
+
/** Number of redo steps remaining. */
|
|
9120
|
+
redoDepth: number;
|
|
9121
|
+
}
|
|
9122
|
+
|
|
8544
9123
|
/** @public */
|
|
8545
9124
|
export declare interface TLUpdatePointerOptions {
|
|
8546
9125
|
/** Whether to update the pointer immediately, rather than on the next tick. */
|
|
@@ -8672,6 +9251,9 @@ export declare function uniq<T>(array: {
|
|
|
8672
9251
|
readonly length: number;
|
|
8673
9252
|
} | null | undefined): T[];
|
|
8674
9253
|
|
|
9254
|
+
/** @public */
|
|
9255
|
+
export declare function useColorMode(): 'dark' | 'light';
|
|
9256
|
+
|
|
8675
9257
|
/** @public */
|
|
8676
9258
|
export declare function useContainer(): HTMLElement;
|
|
8677
9259
|
|
|
@@ -8710,9 +9292,6 @@ export declare function useGlobalMenuIsOpen(id: string, onChange?: (isOpen: bool
|
|
|
8710
9292
|
/** @public */
|
|
8711
9293
|
export declare function useIsCropping(shapeId: TLShapeId): boolean;
|
|
8712
9294
|
|
|
8713
|
-
/** @public */
|
|
8714
|
-
export declare function useIsDarkMode(): boolean;
|
|
8715
|
-
|
|
8716
9295
|
/** @public */
|
|
8717
9296
|
export declare function useIsEditing(shapeId: TLShapeId): boolean;
|
|
8718
9297
|
|
|
@@ -8750,11 +9329,11 @@ export declare function usePresence(userId: string): null | TLInstancePresence;
|
|
|
8750
9329
|
/** @public */
|
|
8751
9330
|
export declare class UserPreferencesManager {
|
|
8752
9331
|
private readonly user;
|
|
8753
|
-
private readonly
|
|
9332
|
+
private readonly colorScheme;
|
|
8754
9333
|
systemColorScheme: Atom<"dark" | "light", unknown>;
|
|
8755
9334
|
disposables: Set<() => void>;
|
|
8756
9335
|
dispose(): void;
|
|
8757
|
-
constructor(user: TLCurrentUser,
|
|
9336
|
+
constructor(user: TLCurrentUser, colorScheme: 'dark' | 'light' | 'system');
|
|
8758
9337
|
updateUserPreferences(userPreferences: Partial<TLUserPreferences>): void;
|
|
8759
9338
|
getUserPreferences(): {
|
|
8760
9339
|
animationSpeed: number;
|