@tldraw/editor 4.6.0-next.d8328a2dcc3d → 4.6.0-next.df418e51012c
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 +668 -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/MenuClickCapture.js +16 -1
- package/dist-cjs/lib/components/MenuClickCapture.js.map +2 -2
- package/dist-cjs/lib/components/default-components/CanvasShapeIndicators.js +3 -3
- package/dist-cjs/lib/components/default-components/CanvasShapeIndicators.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/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 +668 -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/MenuClickCapture.mjs +16 -1
- package/dist-esm/lib/components/MenuClickCapture.mjs.map +2 -2
- package/dist-esm/lib/components/default-components/CanvasShapeIndicators.mjs +3 -3
- package/dist-esm/lib/components/default-components/CanvasShapeIndicators.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/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/MenuClickCapture.tsx +20 -0
- package/src/lib/components/default-components/CanvasShapeIndicators.tsx +3 -3
- 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/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
|
|
|
@@ -1043,7 +1103,7 @@ export declare class EdgeScrollManager {
|
|
|
1043
1103
|
/** @public */
|
|
1044
1104
|
export declare class Editor extends EventEmitter<TLEventMap> {
|
|
1045
1105
|
readonly id: string;
|
|
1046
|
-
constructor({ store, user, shapeUtils, bindingUtils, tools, getContainer, cameraOptions, initialState, autoFocus,
|
|
1106
|
+
constructor({ store, user, shapeUtils, bindingUtils, assetUtils: assetUtilConstructors, tools, getContainer, cameraOptions, initialState, autoFocus, options: _options, textOptions: _textOptions, getShapeVisibility, colorScheme, fontAssetUrls, themes, initialTheme }: TLEditorOptions);
|
|
1047
1107
|
private readonly _getShapeVisibility?;
|
|
1048
1108
|
private getIsShapeHiddenCache;
|
|
1049
1109
|
isShapeHidden(shapeOrId: TLShape | TLShapeId): boolean;
|
|
@@ -1106,7 +1166,13 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1106
1166
|
* @public
|
|
1107
1167
|
*/
|
|
1108
1168
|
readonly snaps: SnapManager;
|
|
1109
|
-
|
|
1169
|
+
/**
|
|
1170
|
+
* A manager for performance measurement hooks.
|
|
1171
|
+
*
|
|
1172
|
+
* @public
|
|
1173
|
+
*/
|
|
1174
|
+
readonly performance: PerformanceManager;
|
|
1175
|
+
/* Excluded from this release type: _spatialIndex */
|
|
1110
1176
|
/**
|
|
1111
1177
|
* A manager for the any asynchronous events and making sure they're
|
|
1112
1178
|
* cleaned up upon disposal.
|
|
@@ -1125,6 +1191,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1125
1191
|
* @public
|
|
1126
1192
|
*/
|
|
1127
1193
|
readonly user: UserPreferencesManager;
|
|
1194
|
+
/* Excluded from this release type: _themeManager */
|
|
1128
1195
|
/**
|
|
1129
1196
|
* A helper for measuring text.
|
|
1130
1197
|
*
|
|
@@ -1175,6 +1242,83 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1175
1242
|
* @public
|
|
1176
1243
|
*/
|
|
1177
1244
|
dispose(): void;
|
|
1245
|
+
/**
|
|
1246
|
+
* Get the current color mode (`'light'` or `'dark'`), based on the user's dark mode preference.
|
|
1247
|
+
*
|
|
1248
|
+
* @public
|
|
1249
|
+
*/
|
|
1250
|
+
getColorMode(): 'dark' | 'light';
|
|
1251
|
+
/**
|
|
1252
|
+
* Set the color mode. Note that this is a convenience method that passes the mode to
|
|
1253
|
+
* `user.updateUserPreferences`, which is the source of truth for the user's color mode preference.
|
|
1254
|
+
*
|
|
1255
|
+
* @public
|
|
1256
|
+
*/
|
|
1257
|
+
setColorMode(mode: 'dark' | 'light'): this;
|
|
1258
|
+
/**
|
|
1259
|
+
* Get the id of the current theme.
|
|
1260
|
+
*
|
|
1261
|
+
* @public
|
|
1262
|
+
*/
|
|
1263
|
+
getCurrentThemeId(): TLThemeId;
|
|
1264
|
+
/**
|
|
1265
|
+
* Get the current theme definition.
|
|
1266
|
+
*
|
|
1267
|
+
* @public
|
|
1268
|
+
*/
|
|
1269
|
+
getCurrentTheme(): TLTheme;
|
|
1270
|
+
/**
|
|
1271
|
+
* Set the current theme by id.
|
|
1272
|
+
*
|
|
1273
|
+
* @public
|
|
1274
|
+
*/
|
|
1275
|
+
setCurrentTheme(id: TLThemeId): this;
|
|
1276
|
+
/**
|
|
1277
|
+
* Get all registered theme definitions.
|
|
1278
|
+
*
|
|
1279
|
+
* @public
|
|
1280
|
+
*/
|
|
1281
|
+
getThemes(): TLThemes;
|
|
1282
|
+
/**
|
|
1283
|
+
* Get a single theme definition by id.
|
|
1284
|
+
*
|
|
1285
|
+
* @public
|
|
1286
|
+
*/
|
|
1287
|
+
getTheme(id: TLThemeId): TLTheme | undefined;
|
|
1288
|
+
/**
|
|
1289
|
+
* Replace all theme definitions, or update them via a callback that receives a deep copy.
|
|
1290
|
+
* The `'default'` theme must always be present in the result.
|
|
1291
|
+
*
|
|
1292
|
+
* @example
|
|
1293
|
+
* ```ts
|
|
1294
|
+
* // Replace all themes
|
|
1295
|
+
* editor.updateThemes({ default: myDefaultTheme, ocean: myOceanTheme })
|
|
1296
|
+
*
|
|
1297
|
+
* // Update via callback
|
|
1298
|
+
* editor.updateThemes((themes) => {
|
|
1299
|
+
* delete themes.ocean
|
|
1300
|
+
* return themes
|
|
1301
|
+
* })
|
|
1302
|
+
* ```
|
|
1303
|
+
*
|
|
1304
|
+
* @public
|
|
1305
|
+
*/
|
|
1306
|
+
updateThemes(themes: ((themes: TLThemes) => TLThemes) | TLThemes): this;
|
|
1307
|
+
/**
|
|
1308
|
+
* Register or update a single theme definition. The theme is keyed by its `id` property.
|
|
1309
|
+
*
|
|
1310
|
+
* @example
|
|
1311
|
+
* ```ts
|
|
1312
|
+
* // Override a property on the default theme
|
|
1313
|
+
* editor.updateTheme({ ...editor.getTheme('default')!, fontSize: 24 })
|
|
1314
|
+
*
|
|
1315
|
+
* // Register a new theme
|
|
1316
|
+
* editor.updateTheme({ id: 'ocean', ...myOceanTheme })
|
|
1317
|
+
* ```
|
|
1318
|
+
*
|
|
1319
|
+
* @public
|
|
1320
|
+
*/
|
|
1321
|
+
updateTheme(theme: TLTheme): this;
|
|
1178
1322
|
/**
|
|
1179
1323
|
* A map of shape utility classes (TLShapeUtils) by shape type.
|
|
1180
1324
|
*
|
|
@@ -1183,6 +1327,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1183
1327
|
shapeUtils: {
|
|
1184
1328
|
readonly [K in string]?: ShapeUtil<TLShape>;
|
|
1185
1329
|
};
|
|
1330
|
+
/* Excluded from this release type: _shapeUtilsByAssetType */
|
|
1186
1331
|
styleProps: {
|
|
1187
1332
|
[key: string]: Map<StyleProp<any>, string>;
|
|
1188
1333
|
};
|
|
@@ -1214,6 +1359,15 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1214
1359
|
hasShapeUtil(shape: TLShape | TLShapePartial<TLShape>): boolean;
|
|
1215
1360
|
hasShapeUtil(type: TLShape['type']): boolean;
|
|
1216
1361
|
hasShapeUtil<T extends ShapeUtil>(type: T extends ShapeUtil<infer R> ? R['type'] : string): boolean;
|
|
1362
|
+
/**
|
|
1363
|
+
* Get the shape util that handles the given asset type.
|
|
1364
|
+
* Returns the shape util whose {@link ShapeUtil.handledAssetTypes} includes
|
|
1365
|
+
* the given asset type, or undefined if none matches.
|
|
1366
|
+
*
|
|
1367
|
+
* @param assetType - The asset type string.
|
|
1368
|
+
* @public
|
|
1369
|
+
*/
|
|
1370
|
+
getShapeUtilForAssetType(assetType: string): ShapeUtil | undefined;
|
|
1217
1371
|
/**
|
|
1218
1372
|
* A map of shape utility classes (TLShapeUtils) by shape type.
|
|
1219
1373
|
*
|
|
@@ -1244,6 +1398,40 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1244
1398
|
type: S['type'];
|
|
1245
1399
|
} | S): BindingUtil<S>;
|
|
1246
1400
|
getBindingUtil<T extends BindingUtil>(type: T extends BindingUtil<infer R> ? R['type'] : string): T;
|
|
1401
|
+
/**
|
|
1402
|
+
* A map of asset utility classes by asset type.
|
|
1403
|
+
*
|
|
1404
|
+
* @public
|
|
1405
|
+
*/
|
|
1406
|
+
assetUtils: {
|
|
1407
|
+
readonly [K in string]?: AssetUtil<TLAsset>;
|
|
1408
|
+
};
|
|
1409
|
+
/**
|
|
1410
|
+
* Get an asset util from an asset or asset type.
|
|
1411
|
+
*
|
|
1412
|
+
* @param arg - An asset, asset type string, or object with type.
|
|
1413
|
+
*
|
|
1414
|
+
* @public
|
|
1415
|
+
*/
|
|
1416
|
+
getAssetUtil<S extends TLAsset>(asset: {
|
|
1417
|
+
type: S['type'];
|
|
1418
|
+
} | S): AssetUtil<S>;
|
|
1419
|
+
getAssetUtil(type: string): AssetUtil;
|
|
1420
|
+
/**
|
|
1421
|
+
* Returns true if the editor has an asset util for the given asset type.
|
|
1422
|
+
*
|
|
1423
|
+
* @public
|
|
1424
|
+
*/
|
|
1425
|
+
hasAssetUtil(arg: {
|
|
1426
|
+
type: string;
|
|
1427
|
+
} | string): boolean;
|
|
1428
|
+
/**
|
|
1429
|
+
* Get the asset util that accepts the given MIME type.
|
|
1430
|
+
* Returns null if no registered asset util accepts the MIME type.
|
|
1431
|
+
*
|
|
1432
|
+
* @public
|
|
1433
|
+
*/
|
|
1434
|
+
getAssetUtilForMimeType(mimeType: string): AssetUtil | null;
|
|
1247
1435
|
/**
|
|
1248
1436
|
* A manager for the editor's history.
|
|
1249
1437
|
*
|
|
@@ -4394,6 +4582,35 @@ export declare interface Geometry2dOptions extends TransformedGeometry2dOptions
|
|
|
4394
4582
|
*/
|
|
4395
4583
|
export declare function getArcMeasure(A: number, B: number, sweepFlag: number, largeArcFlag: number): number;
|
|
4396
4584
|
|
|
4585
|
+
/**
|
|
4586
|
+
* Resolves a color style value to its actual CSS color string for a given theme and variant.
|
|
4587
|
+
* If the color is not a default theme color, returns the color value as-is.
|
|
4588
|
+
*
|
|
4589
|
+
* @param colors - The color palette for the current color mode (e.g. `theme.colors[colorMode]`)
|
|
4590
|
+
* @param color - The color style value to resolve
|
|
4591
|
+
* @param variant - Which variant of the color to return (solid, fill, pattern, etc.)
|
|
4592
|
+
* @returns The CSS color string for the specified color and variant
|
|
4593
|
+
*
|
|
4594
|
+
* @example
|
|
4595
|
+
* ```ts
|
|
4596
|
+
* import { getColorValue } from 'tldraw'
|
|
4597
|
+
*
|
|
4598
|
+
* const colors = editor.getCurrentTheme().colors[editor.getColorMode()]
|
|
4599
|
+
*
|
|
4600
|
+
* // Get the solid variant of red
|
|
4601
|
+
* const redSolid = getColorValue(colors, 'red', 'solid') // '#e03131'
|
|
4602
|
+
*
|
|
4603
|
+
* // Get the fill variant of blue
|
|
4604
|
+
* const blueFill = getColorValue(colors, 'blue', 'fill') // '#4465e9'
|
|
4605
|
+
*
|
|
4606
|
+
* // Custom color passes through unchanged
|
|
4607
|
+
* const customColor = getColorValue(colors, '#ff0000', 'solid') // '#ff0000'
|
|
4608
|
+
* ```
|
|
4609
|
+
*
|
|
4610
|
+
* @public
|
|
4611
|
+
*/
|
|
4612
|
+
export declare function getColorValue(colors: TLThemeColors, color: string | TLDefaultColorStyle, variant: keyof TLDefaultColor): string;
|
|
4613
|
+
|
|
4397
4614
|
/** @public */
|
|
4398
4615
|
export declare function getCursor(cursor: TLCursorType, rotation?: number, color?: string): string;
|
|
4399
4616
|
|
|
@@ -4564,7 +4781,7 @@ export declare class GroupShapeUtil extends ShapeUtil<TLGroupShape> {
|
|
|
4564
4781
|
static type: "group";
|
|
4565
4782
|
static props: RecordProps<TLGroupShape>;
|
|
4566
4783
|
static migrations: TLPropsMigrations;
|
|
4567
|
-
hideSelectionBoundsFg(): boolean;
|
|
4784
|
+
hideSelectionBoundsFg(shape: TLGroupShape): boolean;
|
|
4568
4785
|
canBind(): boolean;
|
|
4569
4786
|
canResize(): boolean;
|
|
4570
4787
|
canResizeChildren(): boolean;
|
|
@@ -5206,6 +5423,94 @@ export declare function parseDeepLinkString(deepLinkString: string): TLDeepLink;
|
|
|
5206
5423
|
/** @public */
|
|
5207
5424
|
export declare type PerfectDashTerminal = 'none' | 'outset' | 'skip';
|
|
5208
5425
|
|
|
5426
|
+
/**
|
|
5427
|
+
* Optional adapter that pipes PerformanceManager events into browser
|
|
5428
|
+
* `performance.mark()` / `performance.measure()` for DevTools integration.
|
|
5429
|
+
*
|
|
5430
|
+
* Tree-shakeable — only included if imported.
|
|
5431
|
+
*
|
|
5432
|
+
* @example
|
|
5433
|
+
* ```ts
|
|
5434
|
+
* const adapter = new PerformanceApiAdapter(editor.performance)
|
|
5435
|
+
* // ... later
|
|
5436
|
+
* adapter.dispose()
|
|
5437
|
+
* ```
|
|
5438
|
+
*
|
|
5439
|
+
* @public
|
|
5440
|
+
*/
|
|
5441
|
+
export declare class PerformanceApiAdapter {
|
|
5442
|
+
private cleanups;
|
|
5443
|
+
constructor(perfManager: PerformanceManager);
|
|
5444
|
+
/** Remove all listeners and stop piping events. @public */
|
|
5445
|
+
dispose(): void;
|
|
5446
|
+
}
|
|
5447
|
+
|
|
5448
|
+
/**
|
|
5449
|
+
* Manages performance event subscriptions for the editor. Available as `editor.performance`.
|
|
5450
|
+
*
|
|
5451
|
+
* Listeners are lazy — internal editor hooks (frame, shape events) are only attached while
|
|
5452
|
+
* at least one subscriber exists, so there is zero overhead when unused.
|
|
5453
|
+
*
|
|
5454
|
+
* @example
|
|
5455
|
+
* ```ts
|
|
5456
|
+
* const unsub = editor.performance.on('interaction-end', (event) => {
|
|
5457
|
+
* console.log(`${event.name}: ${event.fps.toFixed(1)} fps, p95=${event.p95FrameTime.toFixed(1)}ms`)
|
|
5458
|
+
* })
|
|
5459
|
+
* ```
|
|
5460
|
+
*
|
|
5461
|
+
* @public
|
|
5462
|
+
*/
|
|
5463
|
+
export declare class PerformanceManager {
|
|
5464
|
+
/* Excluded from this release type: emitter */
|
|
5465
|
+
private editor;
|
|
5466
|
+
private activeInteraction;
|
|
5467
|
+
private activeCamera;
|
|
5468
|
+
private frameCleanup;
|
|
5469
|
+
private shapeCreatedCleanup;
|
|
5470
|
+
private shapeEditedCleanup;
|
|
5471
|
+
private shapeDeletedCleanup;
|
|
5472
|
+
private loafObserver;
|
|
5473
|
+
constructor(editor: Editor);
|
|
5474
|
+
/**
|
|
5475
|
+
* Subscribe to a performance event. Returns an unsubscribe function.
|
|
5476
|
+
*
|
|
5477
|
+
* @example
|
|
5478
|
+
* ```ts
|
|
5479
|
+
* const unsub = editor.performance.on('interaction-end', (event) => {
|
|
5480
|
+
* sendToAnalytics({ name: event.name, fps: event.fps, p95: event.p95FrameTime })
|
|
5481
|
+
* })
|
|
5482
|
+
* // later: unsub()
|
|
5483
|
+
* ```
|
|
5484
|
+
*
|
|
5485
|
+
* @public
|
|
5486
|
+
*/
|
|
5487
|
+
on<K extends keyof TLPerfEventMap>(event: K, fn: (...args: TLPerfEventMap[K]) => void): () => void;
|
|
5488
|
+
/**
|
|
5489
|
+
* Subscribe to a performance event once. The listener is removed after the first invocation.
|
|
5490
|
+
* Returns an unsubscribe function for early removal.
|
|
5491
|
+
*
|
|
5492
|
+
* @public
|
|
5493
|
+
*/
|
|
5494
|
+
once<K extends keyof TLPerfEventMap>(event: K, fn: (...args: TLPerfEventMap[K]) => void): () => void;
|
|
5495
|
+
/* Excluded from this release type: dispose */
|
|
5496
|
+
/* Excluded from this release type: _notifyInteractionStart */
|
|
5497
|
+
/* Excluded from this release type: _notifyInteractionEnd */
|
|
5498
|
+
/* Excluded from this release type: _notifyCameraOperation */
|
|
5499
|
+
/* Excluded from this release type: _notifyUndoRedo */
|
|
5500
|
+
private _startCameraSession;
|
|
5501
|
+
private _endCameraSession;
|
|
5502
|
+
private _onFrame;
|
|
5503
|
+
private _onShapesCreated;
|
|
5504
|
+
private _onShapesEdited;
|
|
5505
|
+
private _onShapesDeleted;
|
|
5506
|
+
private _startLoafObserver;
|
|
5507
|
+
private _stopLoafObserver;
|
|
5508
|
+
private _needsFrameListener;
|
|
5509
|
+
private _needsLoafObserver;
|
|
5510
|
+
private _maybeAttachLazyListeners;
|
|
5511
|
+
private _maybeDetachLazyListeners;
|
|
5512
|
+
}
|
|
5513
|
+
|
|
5209
5514
|
/**
|
|
5210
5515
|
* Find the approximate perimeter of an ellipse.
|
|
5211
5516
|
*
|
|
@@ -5400,6 +5705,16 @@ export declare function resizeScaled(shape: TLBaseShape<any, {
|
|
|
5400
5705
|
y: number;
|
|
5401
5706
|
};
|
|
5402
5707
|
|
|
5708
|
+
/**
|
|
5709
|
+
* Resolve a partial set of user-provided themes into a complete `TLThemes`
|
|
5710
|
+
* record by merging with `DEFAULT_THEME`. The result is suitable for passing to
|
|
5711
|
+
* `registerColorsFromThemes`, `registerFontsFromThemes`, and the
|
|
5712
|
+
* `ThemeManager` constructor.
|
|
5713
|
+
*
|
|
5714
|
+
* @public
|
|
5715
|
+
*/
|
|
5716
|
+
export declare function resolveThemes(themes?: Partial<TLThemes>): TLThemes;
|
|
5717
|
+
|
|
5403
5718
|
/** @public */
|
|
5404
5719
|
export declare type RichTextFontVisitor = (node: TiptapNode, state: RichTextFontVisitorState, addFont: (font: TLFontFace) => void) => RichTextFontVisitorState;
|
|
5405
5720
|
|
|
@@ -5681,12 +5996,32 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5681
5996
|
* @public
|
|
5682
5997
|
*/
|
|
5683
5998
|
static type: string;
|
|
5999
|
+
/**
|
|
6000
|
+
* The asset types that this shape can be created from.
|
|
6001
|
+
* When a file is dropped on the canvas, the editor finds the shape util
|
|
6002
|
+
* whose `handledAssetTypes` includes the asset's type and calls
|
|
6003
|
+
* {@link ShapeUtil.createShapeForAsset} to produce the shape.
|
|
6004
|
+
*
|
|
6005
|
+
* @public
|
|
6006
|
+
*/
|
|
6007
|
+
static handledAssetTypes?: readonly string[];
|
|
5684
6008
|
/**
|
|
5685
6009
|
* Get the default props for a shape.
|
|
5686
6010
|
*
|
|
5687
6011
|
* @public
|
|
5688
6012
|
*/
|
|
5689
6013
|
abstract getDefaultProps(): Shape['props'];
|
|
6014
|
+
/**
|
|
6015
|
+
* Create a shape partial for placing an asset on the canvas.
|
|
6016
|
+
* Only called for shapes whose constructor declares matching
|
|
6017
|
+
* {@link ShapeUtil.handledAssetTypes | `handledAssetTypes`}.
|
|
6018
|
+
*
|
|
6019
|
+
* @param asset - The asset to create a shape for.
|
|
6020
|
+
* @param position - Where to place the shape.
|
|
6021
|
+
* @returns A shape partial, or null if this shape can't be created for the asset.
|
|
6022
|
+
* @public
|
|
6023
|
+
*/
|
|
6024
|
+
createShapeForAsset?(asset: TLAsset, position: VecModel): null | TLShapePartial;
|
|
5690
6025
|
/**
|
|
5691
6026
|
* Get the shape's geometry.
|
|
5692
6027
|
*
|
|
@@ -5767,7 +6102,7 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5767
6102
|
*
|
|
5768
6103
|
* @public
|
|
5769
6104
|
*/
|
|
5770
|
-
canBind(
|
|
6105
|
+
canBind(opts: TLShapeUtilCanBindOpts): boolean;
|
|
5771
6106
|
/**
|
|
5772
6107
|
* Whether the shape can be double clicked to edit.
|
|
5773
6108
|
*
|
|
@@ -5948,7 +6283,7 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5948
6283
|
* @param type - The shape type.
|
|
5949
6284
|
* @public
|
|
5950
6285
|
*/
|
|
5951
|
-
canReceiveNewChildrenOfType(shape: Shape,
|
|
6286
|
+
canReceiveNewChildrenOfType(shape: Shape, type: TLShape['type']): boolean;
|
|
5952
6287
|
/**
|
|
5953
6288
|
* Get the shape as an SVG object.
|
|
5954
6289
|
*
|
|
@@ -6391,6 +6726,8 @@ export declare abstract class StateNode implements Partial<TLEventHandlers> {
|
|
|
6391
6726
|
static children?: () => TLStateNodeConstructor[];
|
|
6392
6727
|
static isLockable: boolean;
|
|
6393
6728
|
static useCoalescedEvents: boolean;
|
|
6729
|
+
/** Set to `true` in subclasses to emit interaction-start/end performance events when this state is entered/exited. */
|
|
6730
|
+
static trackPerformance: boolean;
|
|
6394
6731
|
id: string;
|
|
6395
6732
|
type: 'branch' | 'leaf' | 'root';
|
|
6396
6733
|
shapeType?: string;
|
|
@@ -6525,6 +6862,10 @@ export declare interface SvgExportContext {
|
|
|
6525
6862
|
* Whether the export should be in dark mode.
|
|
6526
6863
|
*/
|
|
6527
6864
|
readonly isDarkMode: boolean;
|
|
6865
|
+
/**
|
|
6866
|
+
* The color mode to use for this export.
|
|
6867
|
+
*/
|
|
6868
|
+
readonly colorMode: 'dark' | 'light';
|
|
6528
6869
|
/**
|
|
6529
6870
|
* The scale of the export - how much CSS pixels will be scaled up/down by.
|
|
6530
6871
|
*/
|
|
@@ -6595,6 +6936,47 @@ export declare class TextManager {
|
|
|
6595
6936
|
}[];
|
|
6596
6937
|
}
|
|
6597
6938
|
|
|
6939
|
+
/**
|
|
6940
|
+
* Manages the editor's color themes.
|
|
6941
|
+
*
|
|
6942
|
+
* Stores named theme definitions (each containing light and dark color palettes
|
|
6943
|
+
* alongside shared properties like font size). The current theme is resolved by
|
|
6944
|
+
* combining the current theme name with the user's color mode preference.
|
|
6945
|
+
*
|
|
6946
|
+
* **Terminology:**
|
|
6947
|
+
* - **Theme** (`TLTheme`): A named set of colors and typographic values for both light and dark modes.
|
|
6948
|
+
* - **Color mode** (`'light' | 'dark'`): The resolved appearance mode, derived from the user's
|
|
6949
|
+
* `colorScheme` preference (`'light' | 'dark' | 'system'`). Access via `getColorMode()`.
|
|
6950
|
+
*
|
|
6951
|
+
* @public
|
|
6952
|
+
*/
|
|
6953
|
+
export declare class ThemeManager {
|
|
6954
|
+
private readonly editor;
|
|
6955
|
+
private readonly _themes;
|
|
6956
|
+
private readonly _currentThemeId;
|
|
6957
|
+
constructor(editor: Editor, options: {
|
|
6958
|
+
initial: TLThemeId;
|
|
6959
|
+
themes: TLThemes;
|
|
6960
|
+
});
|
|
6961
|
+
/** Get the current color mode based on the user's dark mode preference. */
|
|
6962
|
+
getColorMode(): 'dark' | 'light';
|
|
6963
|
+
/** Get all registered theme definitions. */
|
|
6964
|
+
getThemes(): TLThemes;
|
|
6965
|
+
/** Get a single theme definition by id. */
|
|
6966
|
+
getTheme(id: TLThemeId): TLTheme | undefined;
|
|
6967
|
+
/** Get the id of the current theme. */
|
|
6968
|
+
getCurrentThemeId(): TLThemeId;
|
|
6969
|
+
getCurrentTheme(): TLTheme;
|
|
6970
|
+
/** Set the current theme by id. The theme must have been previously registered. */
|
|
6971
|
+
setCurrentTheme(id: TLThemeId): void;
|
|
6972
|
+
/** Replace all theme definitions, or update them via a callback that receives a deep copy. */
|
|
6973
|
+
updateThemes(themes: ((themes: TLThemes) => TLThemes) | TLThemes): void;
|
|
6974
|
+
/** Register or update a named theme definition. */
|
|
6975
|
+
updateTheme(theme: TLTheme): void;
|
|
6976
|
+
/** Clean up any resources held by the manager. */
|
|
6977
|
+
dispose(): void;
|
|
6978
|
+
}
|
|
6979
|
+
|
|
6598
6980
|
/* Excluded from this release type: TickManager */
|
|
6599
6981
|
|
|
6600
6982
|
/**
|
|
@@ -6613,12 +6995,23 @@ export declare type TiptapNode = Node_2;
|
|
|
6613
6995
|
/** @public */
|
|
6614
6996
|
export declare type TLAdjacentDirection = 'down' | 'left' | 'next' | 'prev' | 'right' | 'up';
|
|
6615
6997
|
|
|
6998
|
+
/** @public */
|
|
6999
|
+
export declare type TLAnyAssetUtilConstructor = TLAssetUtilConstructor<any>;
|
|
7000
|
+
|
|
6616
7001
|
/** @public */
|
|
6617
7002
|
export declare type TLAnyBindingUtilConstructor = TLBindingUtilConstructor<any>;
|
|
6618
7003
|
|
|
6619
7004
|
/** @public */
|
|
6620
7005
|
export declare type TLAnyShapeUtilConstructor = TLShapeUtilConstructor<any>;
|
|
6621
7006
|
|
|
7007
|
+
/** @public */
|
|
7008
|
+
export declare interface TLAssetUtilConstructor<T extends TLAsset = TLAsset, U extends AssetUtil<T> = AssetUtil<T>> {
|
|
7009
|
+
new (editor: Editor): U;
|
|
7010
|
+
type: T['type'];
|
|
7011
|
+
props?: RecordProps<T>;
|
|
7012
|
+
migrations?: LegacyMigrations | MigrationSequence | TLPropsMigrations;
|
|
7013
|
+
}
|
|
7014
|
+
|
|
6622
7015
|
/** @public */
|
|
6623
7016
|
export declare type TLBaseBoxShape = ExtractShapeByProps<{
|
|
6624
7017
|
h: number;
|
|
@@ -6708,6 +7101,29 @@ export declare interface TLCameraConstraints {
|
|
|
6708
7101
|
};
|
|
6709
7102
|
}
|
|
6710
7103
|
|
|
7104
|
+
/**
|
|
7105
|
+
* Emitted when a camera operation ends (after a 50ms debounce), with aggregated frame time stats.
|
|
7106
|
+
* @public
|
|
7107
|
+
*/
|
|
7108
|
+
export declare interface TLCameraEndPerfEvent extends TLPerfFrameTimeStats {
|
|
7109
|
+
/** Whether this was a pan or zoom operation. */
|
|
7110
|
+
type: 'panning' | 'zooming';
|
|
7111
|
+
/** Total shapes on the current page. */
|
|
7112
|
+
shapeCount: number;
|
|
7113
|
+
/** Number of shapes visible (not culled) in the viewport. */
|
|
7114
|
+
visibleShapeCount: number;
|
|
7115
|
+
/** Number of shapes culled (off-screen) from rendering. */
|
|
7116
|
+
culledShapeCount: number;
|
|
7117
|
+
/** Viewport width in screen pixels. */
|
|
7118
|
+
viewportWidth: number;
|
|
7119
|
+
/** Viewport height in screen pixels. */
|
|
7120
|
+
viewportHeight: number;
|
|
7121
|
+
/** Camera zoom level (`camera.z`) at session end. */
|
|
7122
|
+
zoomLevel: number;
|
|
7123
|
+
/** `performance.now()` when the camera session ended. */
|
|
7124
|
+
timestamp: number;
|
|
7125
|
+
}
|
|
7126
|
+
|
|
6711
7127
|
/** @public */
|
|
6712
7128
|
export declare interface TLCameraMoveOptions {
|
|
6713
7129
|
/** Whether to move the camera immediately, rather than on the next tick. */
|
|
@@ -6746,6 +7162,17 @@ export declare interface TLCameraOptions {
|
|
|
6746
7162
|
constraints?: TLCameraConstraints;
|
|
6747
7163
|
}
|
|
6748
7164
|
|
|
7165
|
+
/**
|
|
7166
|
+
* Emitted when a camera operation (pan or zoom) begins.
|
|
7167
|
+
* @public
|
|
7168
|
+
*/
|
|
7169
|
+
export declare interface TLCameraStartPerfEvent {
|
|
7170
|
+
/** Whether this is a pan or zoom operation. */
|
|
7171
|
+
type: 'panning' | 'zooming';
|
|
7172
|
+
/** `performance.now()` when the camera session started. */
|
|
7173
|
+
timestamp: number;
|
|
7174
|
+
}
|
|
7175
|
+
|
|
6749
7176
|
/** @public */
|
|
6750
7177
|
export declare type TLCancelEvent = (info: TLCancelEventInfo) => void;
|
|
6751
7178
|
|
|
@@ -6968,6 +7395,10 @@ export declare interface TldrawEditorBaseProps {
|
|
|
6968
7395
|
* An array of binding utils to use in the editor.
|
|
6969
7396
|
*/
|
|
6970
7397
|
bindingUtils?: readonly TLAnyBindingUtilConstructor[];
|
|
7398
|
+
/**
|
|
7399
|
+
* An array of asset utils to use in the editor.
|
|
7400
|
+
*/
|
|
7401
|
+
assetUtils?: readonly TLAnyAssetUtilConstructor[];
|
|
6971
7402
|
/**
|
|
6972
7403
|
* An array of tools to add to the editor's state chart.
|
|
6973
7404
|
*/
|
|
@@ -6997,9 +7428,21 @@ export declare interface TldrawEditorBaseProps {
|
|
|
6997
7428
|
*/
|
|
6998
7429
|
user?: TLCurrentUser;
|
|
6999
7430
|
/**
|
|
7000
|
-
*
|
|
7431
|
+
* The editor's color scheme. Defaults to `'light'`.
|
|
7432
|
+
*
|
|
7433
|
+
* - `'light'` - Always use light mode.
|
|
7434
|
+
* - `'dark'` - Always use dark mode.
|
|
7435
|
+
* - `'system'` - Follow the OS color scheme preference.
|
|
7436
|
+
*/
|
|
7437
|
+
colorScheme?: 'dark' | 'light' | 'system';
|
|
7438
|
+
/**
|
|
7439
|
+
* Named themes for the editor.
|
|
7440
|
+
*/
|
|
7441
|
+
themes?: Partial<TLThemes>;
|
|
7442
|
+
/**
|
|
7443
|
+
* The id of the initially active theme. Defaults to `'default'`.
|
|
7001
7444
|
*/
|
|
7002
|
-
|
|
7445
|
+
initialTheme?: TLThemeId;
|
|
7003
7446
|
/**
|
|
7004
7447
|
* Camera options for the editor.
|
|
7005
7448
|
*
|
|
@@ -7392,14 +7835,13 @@ export declare interface TLEditorOptions {
|
|
|
7392
7835
|
*/
|
|
7393
7836
|
bindingUtils: readonly TLAnyBindingUtilConstructor[];
|
|
7394
7837
|
/**
|
|
7395
|
-
* An array of
|
|
7838
|
+
* An array of asset utils to use in the editor. These will be used to handle asset-type-specific behavior.
|
|
7396
7839
|
*/
|
|
7397
|
-
|
|
7840
|
+
assetUtils?: readonly TLAnyAssetUtilConstructor[];
|
|
7398
7841
|
/**
|
|
7399
|
-
*
|
|
7400
|
-
* given, the body element will be used.
|
|
7842
|
+
* An array of tools to use in the editor. These will be used to handle events and manage user interactions in the editor.
|
|
7401
7843
|
*/
|
|
7402
|
-
|
|
7844
|
+
tools: readonly TLStateNodeConstructor[];
|
|
7403
7845
|
/**
|
|
7404
7846
|
* A user defined externally to replace the default user.
|
|
7405
7847
|
*/
|
|
@@ -7412,27 +7854,15 @@ export declare interface TLEditorOptions {
|
|
|
7412
7854
|
* Whether to automatically focus the editor when it mounts.
|
|
7413
7855
|
*/
|
|
7414
7856
|
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
7857
|
licenseKey?: string;
|
|
7433
7858
|
fontAssetUrls?: {
|
|
7434
7859
|
[key: string]: string | undefined;
|
|
7435
7860
|
};
|
|
7861
|
+
/**
|
|
7862
|
+
* Should return a containing html element which has all the styles applied to the editor. If not
|
|
7863
|
+
* given, the body element will be used.
|
|
7864
|
+
*/
|
|
7865
|
+
getContainer(): HTMLElement;
|
|
7436
7866
|
/**
|
|
7437
7867
|
* Provides a way to hide shapes.
|
|
7438
7868
|
*
|
|
@@ -7449,6 +7879,40 @@ export declare interface TLEditorOptions {
|
|
|
7449
7879
|
* @param editor - The editor instance.
|
|
7450
7880
|
*/
|
|
7451
7881
|
getShapeVisibility?(shape: TLShape, editor: Editor): 'hidden' | 'inherit' | 'visible' | null | undefined;
|
|
7882
|
+
/**
|
|
7883
|
+
* Named theme definitions for the editor. Each theme contains shared
|
|
7884
|
+
* properties (font size, line height, stroke width) and color palettes
|
|
7885
|
+
* for both light and dark modes.
|
|
7886
|
+
*/
|
|
7887
|
+
themes?: Partial<TLThemes>;
|
|
7888
|
+
/**
|
|
7889
|
+
* The id of the initially active theme. Defaults to `'default'`.
|
|
7890
|
+
*/
|
|
7891
|
+
initialTheme?: TLThemeId;
|
|
7892
|
+
/**
|
|
7893
|
+
* The editor's color scheme preference, controls the default color mode. Defaults to `'light'`.
|
|
7894
|
+
*
|
|
7895
|
+
* - `'light'` - Always use light mode.
|
|
7896
|
+
* - `'dark'` - Always use dark mode.
|
|
7897
|
+
* - `'system'` - Follow the OS color scheme preference.
|
|
7898
|
+
*/
|
|
7899
|
+
colorScheme?: 'dark' | 'light' | 'system';
|
|
7900
|
+
/**
|
|
7901
|
+
* Additional configuration options for the tldraw editor.
|
|
7902
|
+
*/
|
|
7903
|
+
options?: Partial<TldrawOptions>;
|
|
7904
|
+
/**
|
|
7905
|
+
* Options for the editor's camera.
|
|
7906
|
+
*
|
|
7907
|
+
* @deprecated Use `options.cameraOptions` instead. This will be removed in a future release.
|
|
7908
|
+
*/
|
|
7909
|
+
cameraOptions?: Partial<TLCameraOptions>;
|
|
7910
|
+
/**
|
|
7911
|
+
* Text options for the editor.
|
|
7912
|
+
*
|
|
7913
|
+
* @deprecated Use `options.text` instead. This prop will be removed in a future release.
|
|
7914
|
+
*/
|
|
7915
|
+
textOptions?: TLTextOptions;
|
|
7452
7916
|
}
|
|
7453
7917
|
|
|
7454
7918
|
/**
|
|
@@ -7507,6 +7971,7 @@ export declare const tlenv: {
|
|
|
7507
7971
|
*/
|
|
7508
7972
|
export declare const tlenvReactive: Atom< {
|
|
7509
7973
|
isCoarsePointer: boolean;
|
|
7974
|
+
supportsP3ColorSpace: boolean;
|
|
7510
7975
|
}, unknown>;
|
|
7511
7976
|
|
|
7512
7977
|
/** @public */
|
|
@@ -7635,6 +8100,7 @@ export declare interface TLFileReplaceExternalContent extends TLBaseExternalCont
|
|
|
7635
8100
|
type: 'file-replace';
|
|
7636
8101
|
file: File;
|
|
7637
8102
|
shapeId: TLShapeId;
|
|
8103
|
+
/** @deprecated This field is no longer used by the default handler. It may be removed in a future version. */
|
|
7638
8104
|
isImage: boolean;
|
|
7639
8105
|
}
|
|
7640
8106
|
|
|
@@ -7646,69 +8112,18 @@ export declare interface TLFilesExternalContent extends TLBaseExternalContent {
|
|
|
7646
8112
|
}
|
|
7647
8113
|
|
|
7648
8114
|
/**
|
|
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.
|
|
8115
|
+
* Emitted every animation frame when at least one `'frame'` listener is registered.
|
|
7702
8116
|
* @public
|
|
7703
8117
|
*/
|
|
7704
|
-
export declare interface
|
|
7705
|
-
/**
|
|
7706
|
-
|
|
7707
|
-
|
|
7708
|
-
|
|
7709
|
-
|
|
7710
|
-
|
|
7711
|
-
|
|
8118
|
+
export declare interface TLFramePerfEvent {
|
|
8119
|
+
/** Time since the last frame in ms. */
|
|
8120
|
+
elapsed: number;
|
|
8121
|
+
/** Total shapes on the current page. */
|
|
8122
|
+
shapeCount: number;
|
|
8123
|
+
/** Number of shapes culled (off-screen) from rendering. */
|
|
8124
|
+
culledShapeCount: number;
|
|
8125
|
+
/** Number of shapes visible (not culled) in the viewport. */
|
|
8126
|
+
visibleShapeCount: number;
|
|
7712
8127
|
}
|
|
7713
8128
|
|
|
7714
8129
|
/** Additional options for the {@link ShapeUtil.getGeometry} method.
|
|
@@ -7853,6 +8268,38 @@ export declare type TLIndicatorPath = {
|
|
|
7853
8268
|
path: Path2D;
|
|
7854
8269
|
} | Path2D;
|
|
7855
8270
|
|
|
8271
|
+
/**
|
|
8272
|
+
* Emitted when an interaction state is exited, with aggregated frame time stats.
|
|
8273
|
+
* @public
|
|
8274
|
+
*/
|
|
8275
|
+
export declare interface TLInteractionEndPerfEvent extends TLPerfFrameTimeStats {
|
|
8276
|
+
/** The state node id (e.g. `'translating'`). */
|
|
8277
|
+
name: string;
|
|
8278
|
+
/** Full tool path (e.g. `'select.translating'`). */
|
|
8279
|
+
path: string;
|
|
8280
|
+
/** Total shapes on the current page. */
|
|
8281
|
+
shapeCount: number;
|
|
8282
|
+
/** Breakdown of selected shape types at interaction start (e.g. `{ geo: 2, draw: 1 }`). */
|
|
8283
|
+
selectedShapeTypes: Record<string, number>;
|
|
8284
|
+
/** Camera zoom level (`camera.z`) at interaction end. */
|
|
8285
|
+
zoomLevel: number;
|
|
8286
|
+
/** `performance.now()` when the interaction ended. */
|
|
8287
|
+
timestamp: number;
|
|
8288
|
+
}
|
|
8289
|
+
|
|
8290
|
+
/**
|
|
8291
|
+
* Emitted when an interaction state (e.g. translating, resizing) is entered.
|
|
8292
|
+
* @public
|
|
8293
|
+
*/
|
|
8294
|
+
export declare interface TLInteractionStartPerfEvent {
|
|
8295
|
+
/** The state node id (e.g. `'translating'`). */
|
|
8296
|
+
name: string;
|
|
8297
|
+
/** Full tool path (e.g. `'select.translating'`). */
|
|
8298
|
+
path: string;
|
|
8299
|
+
/** `performance.now()` when the interaction started. */
|
|
8300
|
+
timestamp: number;
|
|
8301
|
+
}
|
|
8302
|
+
|
|
7856
8303
|
/** @public */
|
|
7857
8304
|
export declare type TLInterruptEvent = (info: TLInterruptEventInfo) => void;
|
|
7858
8305
|
|
|
@@ -8100,6 +8547,94 @@ export declare const tlmenus: {
|
|
|
8100
8547
|
*/
|
|
8101
8548
|
export declare type TLOnMountHandler = (editor: Editor) => (() => undefined | void) | undefined | void;
|
|
8102
8549
|
|
|
8550
|
+
/**
|
|
8551
|
+
* Map of all performance event names to their payload types.
|
|
8552
|
+
* Used with {@link PerformanceManager.on} and {@link PerformanceManager.once}.
|
|
8553
|
+
* @public
|
|
8554
|
+
*/
|
|
8555
|
+
export declare interface TLPerfEventMap {
|
|
8556
|
+
/** An interaction state was entered. */
|
|
8557
|
+
'interaction-start': [TLInteractionStartPerfEvent];
|
|
8558
|
+
/** An interaction state was exited, with aggregated frame time stats. */
|
|
8559
|
+
'interaction-end': [TLInteractionEndPerfEvent];
|
|
8560
|
+
/** A camera operation (pan/zoom) began. */
|
|
8561
|
+
'camera-start': [TLCameraStartPerfEvent];
|
|
8562
|
+
/** A camera operation ended (after debounce), with aggregated frame time stats. */
|
|
8563
|
+
'camera-end': [TLCameraEndPerfEvent];
|
|
8564
|
+
/** Shapes were created. */
|
|
8565
|
+
'shapes-created': [TLShapeOperationPerfEvent];
|
|
8566
|
+
/** Shapes were updated. */
|
|
8567
|
+
'shapes-updated': [TLShapeOperationPerfEvent];
|
|
8568
|
+
/** Shapes were deleted. */
|
|
8569
|
+
'shapes-deleted': [TLShapeOperationPerfEvent];
|
|
8570
|
+
/** An animation frame was rendered. Only fires when listeners are registered. */
|
|
8571
|
+
frame: [TLFramePerfEvent];
|
|
8572
|
+
/** An undo operation was performed. */
|
|
8573
|
+
undo: [TLUndoRedoPerfEvent];
|
|
8574
|
+
/** A redo operation was performed. */
|
|
8575
|
+
redo: [TLUndoRedoPerfEvent];
|
|
8576
|
+
}
|
|
8577
|
+
|
|
8578
|
+
/**
|
|
8579
|
+
* Common frame time statistics shared by interaction and camera end events.
|
|
8580
|
+
* @public
|
|
8581
|
+
*/
|
|
8582
|
+
export declare interface TLPerfFrameTimeStats {
|
|
8583
|
+
/** Total duration of the session in ms. */
|
|
8584
|
+
duration: number;
|
|
8585
|
+
/** Average frames per second during the session. */
|
|
8586
|
+
fps: number;
|
|
8587
|
+
/** Total number of frames recorded. */
|
|
8588
|
+
frameCount: number;
|
|
8589
|
+
/** Mean frame duration in ms. */
|
|
8590
|
+
avgFrameTime: number;
|
|
8591
|
+
/** Median (p50) frame duration in ms. */
|
|
8592
|
+
medianFrameTime: number;
|
|
8593
|
+
/** 95th percentile frame duration in ms. */
|
|
8594
|
+
p95FrameTime: number;
|
|
8595
|
+
/** 99th percentile frame duration in ms. */
|
|
8596
|
+
p99FrameTime: number;
|
|
8597
|
+
/** Shortest frame duration in ms. */
|
|
8598
|
+
minFrameTime: number;
|
|
8599
|
+
/** Longest frame duration in ms. */
|
|
8600
|
+
maxFrameTime: number;
|
|
8601
|
+
/** Raw frame durations for local analysis. Exclude when sending to analytics. */
|
|
8602
|
+
frameTimes: number[];
|
|
8603
|
+
/**
|
|
8604
|
+
* Long animation frames observed during this period (Chromium 123+).
|
|
8605
|
+
* Only present when the browser supports the Long Animation Frames API and
|
|
8606
|
+
* at least one long frame was observed.
|
|
8607
|
+
* Exclude when sending to analytics — entries are large and contain script URLs.
|
|
8608
|
+
*/
|
|
8609
|
+
longAnimationFrames?: TLPerfLongAnimationFrame[];
|
|
8610
|
+
}
|
|
8611
|
+
|
|
8612
|
+
/**
|
|
8613
|
+
* A long animation frame observed by the browser during an interaction.
|
|
8614
|
+
* Available only in browsers that support the Long Animation Frames API (Chromium 123+).
|
|
8615
|
+
* @public
|
|
8616
|
+
*/
|
|
8617
|
+
export declare interface TLPerfLongAnimationFrame {
|
|
8618
|
+
/** Frame start time (relative to timeOrigin). */
|
|
8619
|
+
startTime: number;
|
|
8620
|
+
/** Total frame duration in ms. */
|
|
8621
|
+
duration: number;
|
|
8622
|
+
/** Time the main thread was blocked in ms. */
|
|
8623
|
+
blockingDuration: number;
|
|
8624
|
+
/** Scripts that contributed to the long frame. */
|
|
8625
|
+
scripts: TLPerfLongAnimationFrameScript[];
|
|
8626
|
+
}
|
|
8627
|
+
|
|
8628
|
+
/** A script attribution entry from a long animation frame. @public */
|
|
8629
|
+
export declare interface TLPerfLongAnimationFrameScript {
|
|
8630
|
+
/** The script source URL (may be empty for inline scripts). */
|
|
8631
|
+
sourceURL: string;
|
|
8632
|
+
/** The function name or invoker description. */
|
|
8633
|
+
invoker: string;
|
|
8634
|
+
/** Time spent in this script in ms. */
|
|
8635
|
+
duration: number;
|
|
8636
|
+
}
|
|
8637
|
+
|
|
8103
8638
|
/** @public */
|
|
8104
8639
|
export declare type TLPinchEvent = (info: TLPinchEventInfo) => void;
|
|
8105
8640
|
|
|
@@ -8287,6 +8822,21 @@ export declare interface TLShapeIndicatorsProps {
|
|
|
8287
8822
|
showAll?: boolean;
|
|
8288
8823
|
}
|
|
8289
8824
|
|
|
8825
|
+
/**
|
|
8826
|
+
* Emitted when shapes are created, updated, or deleted.
|
|
8827
|
+
* @public
|
|
8828
|
+
*/
|
|
8829
|
+
export declare interface TLShapeOperationPerfEvent {
|
|
8830
|
+
/** The operation type. */
|
|
8831
|
+
operation: 'create' | 'delete' | 'update';
|
|
8832
|
+
/** Number of shapes affected. */
|
|
8833
|
+
count: number;
|
|
8834
|
+
/** Breakdown by shape type (e.g. `{ geo: 2, draw: 1 }`). */
|
|
8835
|
+
shapeTypes: Record<string, number>;
|
|
8836
|
+
/** `performance.now()` when the operation occurred. */
|
|
8837
|
+
timestamp: number;
|
|
8838
|
+
}
|
|
8839
|
+
|
|
8290
8840
|
/**
|
|
8291
8841
|
* Options passed to {@link ShapeUtil.canBeLaidOut}.
|
|
8292
8842
|
*
|
|
@@ -8344,6 +8894,7 @@ export declare interface TLShapeUtilConstructor<T extends TLShape, U extends Sha
|
|
|
8344
8894
|
type: T['type'];
|
|
8345
8895
|
props?: RecordProps<T>;
|
|
8346
8896
|
migrations?: LegacyMigrations | MigrationSequence | TLPropsMigrations;
|
|
8897
|
+
handledAssetTypes?: readonly string[];
|
|
8347
8898
|
}
|
|
8348
8899
|
|
|
8349
8900
|
/** @public */
|
|
@@ -8371,6 +8922,7 @@ export declare interface TLStateNodeConstructor {
|
|
|
8371
8922
|
children?(): TLStateNodeConstructor[];
|
|
8372
8923
|
isLockable: boolean;
|
|
8373
8924
|
useCoalescedEvents: boolean;
|
|
8925
|
+
trackPerformance: boolean;
|
|
8374
8926
|
}
|
|
8375
8927
|
|
|
8376
8928
|
/** @public */
|
|
@@ -8383,6 +8935,12 @@ export declare interface TLStoreBaseOptions {
|
|
|
8383
8935
|
defaultName?: string;
|
|
8384
8936
|
/** How should this store upload & resolve assets? */
|
|
8385
8937
|
assets?: TLAssetStore;
|
|
8938
|
+
/**
|
|
8939
|
+
* Named theme definitions. When provided, custom color names are automatically
|
|
8940
|
+
* registered before the store is constructed so persisted data with those
|
|
8941
|
+
* colors passes validation on load.
|
|
8942
|
+
*/
|
|
8943
|
+
themes?: Partial<TLThemes>;
|
|
8386
8944
|
/** How should this store resolve users for attribution? */
|
|
8387
8945
|
users?: TLUserStore;
|
|
8388
8946
|
/** Called when the store is connected to an {@link @tldraw/editor#Editor}. */
|
|
@@ -8404,6 +8962,7 @@ export declare type TLStoreOptions = TLStoreBaseOptions & {
|
|
|
8404
8962
|
|
|
8405
8963
|
/** @public */
|
|
8406
8964
|
export declare type TLStoreSchemaOptions = {
|
|
8965
|
+
assetUtils?: readonly TLAnyAssetUtilConstructor[];
|
|
8407
8966
|
bindingUtils?: readonly TLAnyBindingUtilConstructor[];
|
|
8408
8967
|
migrations?: readonly MigrationSequence[];
|
|
8409
8968
|
records?: Record<string, CustomRecordInfo>;
|
|
@@ -8541,6 +9100,19 @@ export declare interface TLTldrawExternalContentSource {
|
|
|
8541
9100
|
data: TLContent;
|
|
8542
9101
|
}
|
|
8543
9102
|
|
|
9103
|
+
/**
|
|
9104
|
+
* Emitted after an undo or redo operation.
|
|
9105
|
+
* @public
|
|
9106
|
+
*/
|
|
9107
|
+
export declare interface TLUndoRedoPerfEvent {
|
|
9108
|
+
/** Whether this was an undo or redo. */
|
|
9109
|
+
type: 'redo' | 'undo';
|
|
9110
|
+
/** Number of undo steps remaining. */
|
|
9111
|
+
undoDepth: number;
|
|
9112
|
+
/** Number of redo steps remaining. */
|
|
9113
|
+
redoDepth: number;
|
|
9114
|
+
}
|
|
9115
|
+
|
|
8544
9116
|
/** @public */
|
|
8545
9117
|
export declare interface TLUpdatePointerOptions {
|
|
8546
9118
|
/** Whether to update the pointer immediately, rather than on the next tick. */
|
|
@@ -8672,6 +9244,9 @@ export declare function uniq<T>(array: {
|
|
|
8672
9244
|
readonly length: number;
|
|
8673
9245
|
} | null | undefined): T[];
|
|
8674
9246
|
|
|
9247
|
+
/** @public */
|
|
9248
|
+
export declare function useColorMode(): 'dark' | 'light';
|
|
9249
|
+
|
|
8675
9250
|
/** @public */
|
|
8676
9251
|
export declare function useContainer(): HTMLElement;
|
|
8677
9252
|
|
|
@@ -8710,9 +9285,6 @@ export declare function useGlobalMenuIsOpen(id: string, onChange?: (isOpen: bool
|
|
|
8710
9285
|
/** @public */
|
|
8711
9286
|
export declare function useIsCropping(shapeId: TLShapeId): boolean;
|
|
8712
9287
|
|
|
8713
|
-
/** @public */
|
|
8714
|
-
export declare function useIsDarkMode(): boolean;
|
|
8715
|
-
|
|
8716
9288
|
/** @public */
|
|
8717
9289
|
export declare function useIsEditing(shapeId: TLShapeId): boolean;
|
|
8718
9290
|
|
|
@@ -8750,11 +9322,11 @@ export declare function usePresence(userId: string): null | TLInstancePresence;
|
|
|
8750
9322
|
/** @public */
|
|
8751
9323
|
export declare class UserPreferencesManager {
|
|
8752
9324
|
private readonly user;
|
|
8753
|
-
private readonly
|
|
9325
|
+
private readonly colorScheme;
|
|
8754
9326
|
systemColorScheme: Atom<"dark" | "light", unknown>;
|
|
8755
9327
|
disposables: Set<() => void>;
|
|
8756
9328
|
dispose(): void;
|
|
8757
|
-
constructor(user: TLCurrentUser,
|
|
9329
|
+
constructor(user: TLCurrentUser, colorScheme: 'dark' | 'light' | 'system');
|
|
8758
9330
|
updateUserPreferences(userPreferences: Partial<TLUserPreferences>): void;
|
|
8759
9331
|
getUserPreferences(): {
|
|
8760
9332
|
animationSpeed: number;
|