@tldraw/editor 4.6.0-next.d15997ff5a4b → 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 +726 -112
- package/dist-cjs/index.js +20 -6
- package/dist-cjs/index.js.map +3 -3
- package/dist-cjs/lib/TldrawEditor.js +59 -14
- 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/{createTLUser.js → createTLCurrentUser.js} +9 -9
- package/dist-cjs/lib/config/createTLCurrentUser.js.map +7 -0
- package/dist-cjs/lib/config/createTLStore.js +30 -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 +325 -8
- package/dist-cjs/lib/editor/Editor.js.map +3 -3
- 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 +21 -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/clipboard-types.js.map +1 -1
- 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/hooks/useGestureEvents.js +171 -127
- package/dist-cjs/lib/hooks/useGestureEvents.js.map +3 -3
- 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 +726 -112
- package/dist-esm/index.mjs +25 -9
- package/dist-esm/index.mjs.map +2 -2
- package/dist-esm/lib/TldrawEditor.mjs +62 -14
- 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/{createTLUser.mjs → createTLCurrentUser.mjs} +6 -6
- package/dist-esm/lib/config/createTLCurrentUser.mjs.map +7 -0
- package/dist-esm/lib/config/createTLStore.mjs +36 -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 +327 -8
- package/dist-esm/lib/editor/Editor.mjs.map +3 -3
- 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 +21 -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/hooks/useGestureEvents.mjs +171 -127
- package/dist-esm/lib/hooks/useGestureEvents.mjs.map +3 -3
- 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 +13 -33
- package/package.json +8 -9
- package/src/index.ts +29 -7
- package/src/lib/TldrawEditor.tsx +98 -19
- package/src/lib/components/MenuClickCapture.tsx +20 -0
- package/src/lib/components/default-components/CanvasShapeIndicators.tsx +3 -3
- package/src/lib/config/{createTLUser.ts → createTLCurrentUser.ts} +6 -6
- package/src/lib/config/createTLStore.ts +57 -2
- package/src/lib/config/defaultAssets.ts +19 -0
- package/src/lib/editor/Editor.ts +440 -29
- 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 +25 -31
- package/src/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.ts +7 -5
- package/src/lib/editor/shapes/ShapeUtil.ts +39 -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/clipboard-types.ts +2 -1
- 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/hooks/useGestureEvents.ts +240 -168
- package/src/lib/primitives/Box.test.ts +30 -0
- package/src/lib/primitives/geometry/Geometry2d.test.ts +21 -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/config/createTLUser.js.map +0 -7
- package/dist-cjs/lib/hooks/useIsDarkMode.js.map +0 -7
- package/dist-esm/lib/config/createTLUser.mjs.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,8 +84,15 @@ 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';
|
|
94
|
+
import { TLUser } from '@tldraw/tlschema';
|
|
95
|
+
import { TLUserStore } from '@tldraw/tlschema';
|
|
86
96
|
import { TLVideoAsset } from '@tldraw/tlschema';
|
|
87
97
|
import { UnknownRecord } from '@tldraw/store';
|
|
88
98
|
import { VecModel } from '@tldraw/tlschema';
|
|
@@ -145,6 +155,51 @@ export declare class Arc2d extends Geometry2d {
|
|
|
145
155
|
*/
|
|
146
156
|
export declare function areAnglesCompatible(a: number, b: number): boolean;
|
|
147
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
|
+
|
|
148
203
|
/** @public */
|
|
149
204
|
export declare function average(A: VecLike, B: VecLike): string;
|
|
150
205
|
|
|
@@ -718,6 +773,12 @@ export declare function createDeepLinkString(deepLink: TLDeepLink): string;
|
|
|
718
773
|
*/
|
|
719
774
|
export declare function createSessionStateSnapshotSignal(store: TLStore): Signal<null | TLSessionStateSnapshot>;
|
|
720
775
|
|
|
776
|
+
/** @public */
|
|
777
|
+
export declare function createTLCurrentUser(opts?: {
|
|
778
|
+
setUserPreferences?: ((userPreferences: TLUserPreferences) => void) | undefined;
|
|
779
|
+
userPreferences?: Signal<TLUserPreferences, unknown> | undefined;
|
|
780
|
+
}): TLCurrentUser;
|
|
781
|
+
|
|
721
782
|
/**
|
|
722
783
|
* A helper for creating a TLStore schema from either an object with shapeUtils, bindingUtils, and
|
|
723
784
|
* migrations, or a schema.
|
|
@@ -735,13 +796,7 @@ export declare function createTLSchemaFromUtils(opts: TLStoreSchemaOptions): Sto
|
|
|
735
796
|
*
|
|
736
797
|
* @public
|
|
737
798
|
*/
|
|
738
|
-
export declare function createTLStore({ initialData, defaultName, id, assets, onMount, collaboration, ...rest }?: TLStoreOptions): TLStore;
|
|
739
|
-
|
|
740
|
-
/** @public */
|
|
741
|
-
export declare function createTLUser(opts?: {
|
|
742
|
-
setUserPreferences?: ((userPreferences: TLUserPreferences) => void) | undefined;
|
|
743
|
-
userPreferences?: Signal<TLUserPreferences, unknown> | undefined;
|
|
744
|
-
}): TLUser;
|
|
799
|
+
export declare function createTLStore({ initialData, defaultName, id, assets, users, onMount, collaboration, themes, ...rest }?: TLStoreOptions): TLStore;
|
|
745
800
|
|
|
746
801
|
/** @public */
|
|
747
802
|
export declare class CubicBezier2d extends Polyline2d {
|
|
@@ -816,6 +871,13 @@ export declare interface DebugFlagDefaults<T> {
|
|
|
816
871
|
|
|
817
872
|
/* Excluded from this release type: DEFAULT_CAMERA_OPTIONS */
|
|
818
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
|
+
|
|
819
881
|
/** @public @react */
|
|
820
882
|
export declare function DefaultBackground(): JSX.Element;
|
|
821
883
|
|
|
@@ -963,6 +1025,9 @@ export declare const defaultUserPreferences: Readonly<{
|
|
|
963
1025
|
name: "";
|
|
964
1026
|
}>;
|
|
965
1027
|
|
|
1028
|
+
/** @public */
|
|
1029
|
+
export declare const defaultUserStore: TLUserStore;
|
|
1030
|
+
|
|
966
1031
|
/**
|
|
967
1032
|
* Convert degrees to radians.
|
|
968
1033
|
*
|
|
@@ -1038,7 +1103,7 @@ export declare class EdgeScrollManager {
|
|
|
1038
1103
|
/** @public */
|
|
1039
1104
|
export declare class Editor extends EventEmitter<TLEventMap> {
|
|
1040
1105
|
readonly id: string;
|
|
1041
|
-
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);
|
|
1042
1107
|
private readonly _getShapeVisibility?;
|
|
1043
1108
|
private getIsShapeHiddenCache;
|
|
1044
1109
|
isShapeHidden(shapeOrId: TLShape | TLShapeId): boolean;
|
|
@@ -1101,7 +1166,13 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1101
1166
|
* @public
|
|
1102
1167
|
*/
|
|
1103
1168
|
readonly snaps: SnapManager;
|
|
1104
|
-
|
|
1169
|
+
/**
|
|
1170
|
+
* A manager for performance measurement hooks.
|
|
1171
|
+
*
|
|
1172
|
+
* @public
|
|
1173
|
+
*/
|
|
1174
|
+
readonly performance: PerformanceManager;
|
|
1175
|
+
/* Excluded from this release type: _spatialIndex */
|
|
1105
1176
|
/**
|
|
1106
1177
|
* A manager for the any asynchronous events and making sure they're
|
|
1107
1178
|
* cleaned up upon disposal.
|
|
@@ -1120,6 +1191,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1120
1191
|
* @public
|
|
1121
1192
|
*/
|
|
1122
1193
|
readonly user: UserPreferencesManager;
|
|
1194
|
+
/* Excluded from this release type: _themeManager */
|
|
1123
1195
|
/**
|
|
1124
1196
|
* A helper for measuring text.
|
|
1125
1197
|
*
|
|
@@ -1170,6 +1242,83 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1170
1242
|
* @public
|
|
1171
1243
|
*/
|
|
1172
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;
|
|
1173
1322
|
/**
|
|
1174
1323
|
* A map of shape utility classes (TLShapeUtils) by shape type.
|
|
1175
1324
|
*
|
|
@@ -1178,6 +1327,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1178
1327
|
shapeUtils: {
|
|
1179
1328
|
readonly [K in string]?: ShapeUtil<TLShape>;
|
|
1180
1329
|
};
|
|
1330
|
+
/* Excluded from this release type: _shapeUtilsByAssetType */
|
|
1181
1331
|
styleProps: {
|
|
1182
1332
|
[key: string]: Map<StyleProp<any>, string>;
|
|
1183
1333
|
};
|
|
@@ -1209,6 +1359,15 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1209
1359
|
hasShapeUtil(shape: TLShape | TLShapePartial<TLShape>): boolean;
|
|
1210
1360
|
hasShapeUtil(type: TLShape['type']): boolean;
|
|
1211
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;
|
|
1212
1371
|
/**
|
|
1213
1372
|
* A map of shape utility classes (TLShapeUtils) by shape type.
|
|
1214
1373
|
*
|
|
@@ -1239,6 +1398,40 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1239
1398
|
type: S['type'];
|
|
1240
1399
|
} | S): BindingUtil<S>;
|
|
1241
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;
|
|
1242
1435
|
/**
|
|
1243
1436
|
* A manager for the editor's history.
|
|
1244
1437
|
*
|
|
@@ -2269,6 +2462,32 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
2269
2462
|
* @public
|
|
2270
2463
|
*/
|
|
2271
2464
|
getCollaboratorsOnCurrentPage(): TLInstancePresence[];
|
|
2465
|
+
/**
|
|
2466
|
+
* Get the current user's ID for attribution purposes.
|
|
2467
|
+
* Also ensures a `user:` record exists in the store for the current user.
|
|
2468
|
+
* Returns `null` when the user store has no current user.
|
|
2469
|
+
*
|
|
2470
|
+
* @public
|
|
2471
|
+
*/
|
|
2472
|
+
getAttributionUserId(): null | string;
|
|
2473
|
+
/* Excluded from this release type: _ensureUserRecord */
|
|
2474
|
+
/**
|
|
2475
|
+
* Resolve a display name for a user ID. Asks the
|
|
2476
|
+
* {@link @tldraw/tlschema#TLUserStore} first (the app's source of truth),
|
|
2477
|
+
* falling back to the `user:` record in the store.
|
|
2478
|
+
*
|
|
2479
|
+
* @public
|
|
2480
|
+
*/
|
|
2481
|
+
getAttributionDisplayName(userId: null | string): null | string;
|
|
2482
|
+
/**
|
|
2483
|
+
* Resolve a user record by ID. Asks the
|
|
2484
|
+
* {@link @tldraw/tlschema#TLUserStore} first (the app's source of truth),
|
|
2485
|
+
* falling back to the `user:` record in the store.
|
|
2486
|
+
*
|
|
2487
|
+
* @public
|
|
2488
|
+
*/
|
|
2489
|
+
getAttributionUser(userId: null | string): null | TLUser;
|
|
2490
|
+
/* Excluded from this release type: _getReferencedUserIds */
|
|
2272
2491
|
private _isLockedOnFollowingUser;
|
|
2273
2492
|
/**
|
|
2274
2493
|
* Start viewport-following a user.
|
|
@@ -4363,6 +4582,35 @@ export declare interface Geometry2dOptions extends TransformedGeometry2dOptions
|
|
|
4363
4582
|
*/
|
|
4364
4583
|
export declare function getArcMeasure(A: number, B: number, sweepFlag: number, largeArcFlag: number): number;
|
|
4365
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
|
+
|
|
4366
4614
|
/** @public */
|
|
4367
4615
|
export declare function getCursor(cursor: TLCursorType, rotation?: number, color?: string): string;
|
|
4368
4616
|
|
|
@@ -4533,7 +4781,7 @@ export declare class GroupShapeUtil extends ShapeUtil<TLGroupShape> {
|
|
|
4533
4781
|
static type: "group";
|
|
4534
4782
|
static props: RecordProps<TLGroupShape>;
|
|
4535
4783
|
static migrations: TLPropsMigrations;
|
|
4536
|
-
hideSelectionBoundsFg(): boolean;
|
|
4784
|
+
hideSelectionBoundsFg(shape: TLGroupShape): boolean;
|
|
4537
4785
|
canBind(): boolean;
|
|
4538
4786
|
canResize(): boolean;
|
|
4539
4787
|
canResizeChildren(): boolean;
|
|
@@ -5175,6 +5423,94 @@ export declare function parseDeepLinkString(deepLinkString: string): TLDeepLink;
|
|
|
5175
5423
|
/** @public */
|
|
5176
5424
|
export declare type PerfectDashTerminal = 'none' | 'outset' | 'skip';
|
|
5177
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
|
+
|
|
5178
5514
|
/**
|
|
5179
5515
|
* Find the approximate perimeter of an ellipse.
|
|
5180
5516
|
*
|
|
@@ -5369,6 +5705,16 @@ export declare function resizeScaled(shape: TLBaseShape<any, {
|
|
|
5369
5705
|
y: number;
|
|
5370
5706
|
};
|
|
5371
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
|
+
|
|
5372
5718
|
/** @public */
|
|
5373
5719
|
export declare type RichTextFontVisitor = (node: TiptapNode, state: RichTextFontVisitorState, addFont: (font: TLFontFace) => void) => RichTextFontVisitorState;
|
|
5374
5720
|
|
|
@@ -5650,12 +5996,32 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5650
5996
|
* @public
|
|
5651
5997
|
*/
|
|
5652
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[];
|
|
5653
6008
|
/**
|
|
5654
6009
|
* Get the default props for a shape.
|
|
5655
6010
|
*
|
|
5656
6011
|
* @public
|
|
5657
6012
|
*/
|
|
5658
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;
|
|
5659
6025
|
/**
|
|
5660
6026
|
* Get the shape's geometry.
|
|
5661
6027
|
*
|
|
@@ -5736,7 +6102,7 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5736
6102
|
*
|
|
5737
6103
|
* @public
|
|
5738
6104
|
*/
|
|
5739
|
-
canBind(
|
|
6105
|
+
canBind(opts: TLShapeUtilCanBindOpts): boolean;
|
|
5740
6106
|
/**
|
|
5741
6107
|
* Whether the shape can be double clicked to edit.
|
|
5742
6108
|
*
|
|
@@ -5917,7 +6283,7 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5917
6283
|
* @param type - The shape type.
|
|
5918
6284
|
* @public
|
|
5919
6285
|
*/
|
|
5920
|
-
canReceiveNewChildrenOfType(shape: Shape,
|
|
6286
|
+
canReceiveNewChildrenOfType(shape: Shape, type: TLShape['type']): boolean;
|
|
5921
6287
|
/**
|
|
5922
6288
|
* Get the shape as an SVG object.
|
|
5923
6289
|
*
|
|
@@ -5957,6 +6323,14 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5957
6323
|
*/
|
|
5958
6324
|
getHandleSnapGeometry(shape: Shape): HandleSnapGeometry;
|
|
5959
6325
|
getText(shape: Shape): string | undefined;
|
|
6326
|
+
/**
|
|
6327
|
+
* Return user IDs referenced in shape-specific props.
|
|
6328
|
+
* Used when copying shapes to include referenced users on the clipboard.
|
|
6329
|
+
* Override this if your shape stores user IDs in custom props.
|
|
6330
|
+
*
|
|
6331
|
+
* @public
|
|
6332
|
+
*/
|
|
6333
|
+
getReferencedUserIds(shape: Shape): string[];
|
|
5960
6334
|
getAriaDescriptor(shape: Shape): string | undefined;
|
|
5961
6335
|
/**
|
|
5962
6336
|
* A callback called just before a shape is created. This method provides a last chance to modify
|
|
@@ -6352,6 +6726,8 @@ export declare abstract class StateNode implements Partial<TLEventHandlers> {
|
|
|
6352
6726
|
static children?: () => TLStateNodeConstructor[];
|
|
6353
6727
|
static isLockable: boolean;
|
|
6354
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;
|
|
6355
6731
|
id: string;
|
|
6356
6732
|
type: 'branch' | 'leaf' | 'root';
|
|
6357
6733
|
shapeType?: string;
|
|
@@ -6486,6 +6862,10 @@ export declare interface SvgExportContext {
|
|
|
6486
6862
|
* Whether the export should be in dark mode.
|
|
6487
6863
|
*/
|
|
6488
6864
|
readonly isDarkMode: boolean;
|
|
6865
|
+
/**
|
|
6866
|
+
* The color mode to use for this export.
|
|
6867
|
+
*/
|
|
6868
|
+
readonly colorMode: 'dark' | 'light';
|
|
6489
6869
|
/**
|
|
6490
6870
|
* The scale of the export - how much CSS pixels will be scaled up/down by.
|
|
6491
6871
|
*/
|
|
@@ -6556,6 +6936,47 @@ export declare class TextManager {
|
|
|
6556
6936
|
}[];
|
|
6557
6937
|
}
|
|
6558
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
|
+
|
|
6559
6980
|
/* Excluded from this release type: TickManager */
|
|
6560
6981
|
|
|
6561
6982
|
/**
|
|
@@ -6574,12 +6995,23 @@ export declare type TiptapNode = Node_2;
|
|
|
6574
6995
|
/** @public */
|
|
6575
6996
|
export declare type TLAdjacentDirection = 'down' | 'left' | 'next' | 'prev' | 'right' | 'up';
|
|
6576
6997
|
|
|
6998
|
+
/** @public */
|
|
6999
|
+
export declare type TLAnyAssetUtilConstructor = TLAssetUtilConstructor<any>;
|
|
7000
|
+
|
|
6577
7001
|
/** @public */
|
|
6578
7002
|
export declare type TLAnyBindingUtilConstructor = TLBindingUtilConstructor<any>;
|
|
6579
7003
|
|
|
6580
7004
|
/** @public */
|
|
6581
7005
|
export declare type TLAnyShapeUtilConstructor = TLShapeUtilConstructor<any>;
|
|
6582
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
|
+
|
|
6583
7015
|
/** @public */
|
|
6584
7016
|
export declare type TLBaseBoxShape = ExtractShapeByProps<{
|
|
6585
7017
|
h: number;
|
|
@@ -6669,6 +7101,29 @@ export declare interface TLCameraConstraints {
|
|
|
6669
7101
|
};
|
|
6670
7102
|
}
|
|
6671
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
|
+
|
|
6672
7127
|
/** @public */
|
|
6673
7128
|
export declare interface TLCameraMoveOptions {
|
|
6674
7129
|
/** Whether to move the camera immediately, rather than on the next tick. */
|
|
@@ -6707,6 +7162,17 @@ export declare interface TLCameraOptions {
|
|
|
6707
7162
|
constraints?: TLCameraConstraints;
|
|
6708
7163
|
}
|
|
6709
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
|
+
|
|
6710
7176
|
/** @public */
|
|
6711
7177
|
export declare type TLCancelEvent = (info: TLCancelEventInfo) => void;
|
|
6712
7178
|
|
|
@@ -6801,6 +7267,7 @@ export declare interface TLContent {
|
|
|
6801
7267
|
rootShapeIds: TLShapeId[];
|
|
6802
7268
|
assets: TLAsset[];
|
|
6803
7269
|
schema: SerializedSchema;
|
|
7270
|
+
users?: TLUser[];
|
|
6804
7271
|
}
|
|
6805
7272
|
|
|
6806
7273
|
/**
|
|
@@ -6822,6 +7289,12 @@ export declare interface TLCropInfo<T extends TLShape> {
|
|
|
6822
7289
|
aspectRatioLocked?: boolean;
|
|
6823
7290
|
}
|
|
6824
7291
|
|
|
7292
|
+
/** @public */
|
|
7293
|
+
export declare interface TLCurrentUser {
|
|
7294
|
+
readonly userPreferences: Signal<TLUserPreferences>;
|
|
7295
|
+
readonly setUserPreferences: (userPreferences: TLUserPreferences) => void;
|
|
7296
|
+
}
|
|
7297
|
+
|
|
6825
7298
|
/** @public */
|
|
6826
7299
|
export declare interface TLCursorProps {
|
|
6827
7300
|
userId: string;
|
|
@@ -6922,6 +7395,10 @@ export declare interface TldrawEditorBaseProps {
|
|
|
6922
7395
|
* An array of binding utils to use in the editor.
|
|
6923
7396
|
*/
|
|
6924
7397
|
bindingUtils?: readonly TLAnyBindingUtilConstructor[];
|
|
7398
|
+
/**
|
|
7399
|
+
* An array of asset utils to use in the editor.
|
|
7400
|
+
*/
|
|
7401
|
+
assetUtils?: readonly TLAnyAssetUtilConstructor[];
|
|
6925
7402
|
/**
|
|
6926
7403
|
* An array of tools to add to the editor's state chart.
|
|
6927
7404
|
*/
|
|
@@ -6949,11 +7426,23 @@ export declare interface TldrawEditorBaseProps {
|
|
|
6949
7426
|
/**
|
|
6950
7427
|
* The user interacting with the editor.
|
|
6951
7428
|
*/
|
|
6952
|
-
user?:
|
|
7429
|
+
user?: TLCurrentUser;
|
|
7430
|
+
/**
|
|
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>;
|
|
6953
7442
|
/**
|
|
6954
|
-
*
|
|
7443
|
+
* The id of the initially active theme. Defaults to `'default'`.
|
|
6955
7444
|
*/
|
|
6956
|
-
|
|
7445
|
+
initialTheme?: TLThemeId;
|
|
6957
7446
|
/**
|
|
6958
7447
|
* Camera options for the editor.
|
|
6959
7448
|
*
|
|
@@ -7346,18 +7835,17 @@ export declare interface TLEditorOptions {
|
|
|
7346
7835
|
*/
|
|
7347
7836
|
bindingUtils: readonly TLAnyBindingUtilConstructor[];
|
|
7348
7837
|
/**
|
|
7349
|
-
* An array of
|
|
7838
|
+
* An array of asset utils to use in the editor. These will be used to handle asset-type-specific behavior.
|
|
7350
7839
|
*/
|
|
7351
|
-
|
|
7840
|
+
assetUtils?: readonly TLAnyAssetUtilConstructor[];
|
|
7352
7841
|
/**
|
|
7353
|
-
*
|
|
7354
|
-
* 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.
|
|
7355
7843
|
*/
|
|
7356
|
-
|
|
7844
|
+
tools: readonly TLStateNodeConstructor[];
|
|
7357
7845
|
/**
|
|
7358
7846
|
* A user defined externally to replace the default user.
|
|
7359
7847
|
*/
|
|
7360
|
-
user?:
|
|
7848
|
+
user?: TLCurrentUser;
|
|
7361
7849
|
/**
|
|
7362
7850
|
* The editor's initial active tool (or other state node id).
|
|
7363
7851
|
*/
|
|
@@ -7366,27 +7854,15 @@ export declare interface TLEditorOptions {
|
|
|
7366
7854
|
* Whether to automatically focus the editor when it mounts.
|
|
7367
7855
|
*/
|
|
7368
7856
|
autoFocus?: boolean;
|
|
7369
|
-
/**
|
|
7370
|
-
* Whether to infer dark mode from the user's system preferences. Defaults to false.
|
|
7371
|
-
*/
|
|
7372
|
-
inferDarkMode?: boolean;
|
|
7373
|
-
/**
|
|
7374
|
-
* Options for the editor's camera.
|
|
7375
|
-
*
|
|
7376
|
-
* @deprecated Use `options.cameraOptions` instead. This will be removed in a future release.
|
|
7377
|
-
*/
|
|
7378
|
-
cameraOptions?: Partial<TLCameraOptions>;
|
|
7379
|
-
options?: Partial<TldrawOptions>;
|
|
7380
|
-
/**
|
|
7381
|
-
* Text options for the editor.
|
|
7382
|
-
*
|
|
7383
|
-
* @deprecated Use `options.text` instead. This prop will be removed in a future release.
|
|
7384
|
-
*/
|
|
7385
|
-
textOptions?: TLTextOptions;
|
|
7386
7857
|
licenseKey?: string;
|
|
7387
7858
|
fontAssetUrls?: {
|
|
7388
7859
|
[key: string]: string | undefined;
|
|
7389
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;
|
|
7390
7866
|
/**
|
|
7391
7867
|
* Provides a way to hide shapes.
|
|
7392
7868
|
*
|
|
@@ -7403,6 +7879,40 @@ export declare interface TLEditorOptions {
|
|
|
7403
7879
|
* @param editor - The editor instance.
|
|
7404
7880
|
*/
|
|
7405
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;
|
|
7406
7916
|
}
|
|
7407
7917
|
|
|
7408
7918
|
/**
|
|
@@ -7461,6 +7971,7 @@ export declare const tlenv: {
|
|
|
7461
7971
|
*/
|
|
7462
7972
|
export declare const tlenvReactive: Atom< {
|
|
7463
7973
|
isCoarsePointer: boolean;
|
|
7974
|
+
supportsP3ColorSpace: boolean;
|
|
7464
7975
|
}, unknown>;
|
|
7465
7976
|
|
|
7466
7977
|
/** @public */
|
|
@@ -7589,6 +8100,7 @@ export declare interface TLFileReplaceExternalContent extends TLBaseExternalCont
|
|
|
7589
8100
|
type: 'file-replace';
|
|
7590
8101
|
file: File;
|
|
7591
8102
|
shapeId: TLShapeId;
|
|
8103
|
+
/** @deprecated This field is no longer used by the default handler. It may be removed in a future version. */
|
|
7592
8104
|
isImage: boolean;
|
|
7593
8105
|
}
|
|
7594
8106
|
|
|
@@ -7600,69 +8112,18 @@ export declare interface TLFilesExternalContent extends TLBaseExternalContent {
|
|
|
7600
8112
|
}
|
|
7601
8113
|
|
|
7602
8114
|
/**
|
|
7603
|
-
*
|
|
7604
|
-
* ones in the
|
|
7605
|
-
* {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face | css `@font-face` rule}.
|
|
7606
|
-
* @public
|
|
7607
|
-
*/
|
|
7608
|
-
export declare interface TLFontFace {
|
|
7609
|
-
/**
|
|
7610
|
-
* How this font can be referred to in CSS.
|
|
7611
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-family | `font-family`}.
|
|
7612
|
-
*/
|
|
7613
|
-
readonly family: string;
|
|
7614
|
-
/**
|
|
7615
|
-
* The source of the font. This
|
|
7616
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src | `src`}.
|
|
7617
|
-
*/
|
|
7618
|
-
readonly src: TLFontFaceSource;
|
|
7619
|
-
/**
|
|
7620
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/ascent-override | `ascent-override`}.
|
|
7621
|
-
*/
|
|
7622
|
-
readonly ascentOverride?: string;
|
|
7623
|
-
/**
|
|
7624
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/descent-override | `descent-override`}.
|
|
7625
|
-
*/
|
|
7626
|
-
readonly descentOverride?: string;
|
|
7627
|
-
/**
|
|
7628
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-stretch | `font-stretch`}.
|
|
7629
|
-
*/
|
|
7630
|
-
readonly stretch?: string;
|
|
7631
|
-
/**
|
|
7632
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-style | `font-style`}.
|
|
7633
|
-
*/
|
|
7634
|
-
readonly style?: string;
|
|
7635
|
-
/**
|
|
7636
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-weight | `font-weight`}.
|
|
7637
|
-
*/
|
|
7638
|
-
readonly weight?: string;
|
|
7639
|
-
/**
|
|
7640
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-feature-settings | `font-feature-settings`}.
|
|
7641
|
-
*/
|
|
7642
|
-
readonly featureSettings?: string;
|
|
7643
|
-
/**
|
|
7644
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/line-gap-override | `line-gap-override`}.
|
|
7645
|
-
*/
|
|
7646
|
-
readonly lineGapOverride?: string;
|
|
7647
|
-
/**
|
|
7648
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/unicode-range | `unicode-range`}.
|
|
7649
|
-
*/
|
|
7650
|
-
readonly unicodeRange?: string;
|
|
7651
|
-
}
|
|
7652
|
-
|
|
7653
|
-
/**
|
|
7654
|
-
* Represents the `src` property of a {@link TLFontFace}.
|
|
7655
|
-
* 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.
|
|
7656
8116
|
* @public
|
|
7657
8117
|
*/
|
|
7658
|
-
export declare interface
|
|
7659
|
-
/**
|
|
7660
|
-
|
|
7661
|
-
|
|
7662
|
-
|
|
7663
|
-
|
|
7664
|
-
|
|
7665
|
-
|
|
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;
|
|
7666
8127
|
}
|
|
7667
8128
|
|
|
7668
8129
|
/** Additional options for the {@link ShapeUtil.getGeometry} method.
|
|
@@ -7807,6 +8268,38 @@ export declare type TLIndicatorPath = {
|
|
|
7807
8268
|
path: Path2D;
|
|
7808
8269
|
} | Path2D;
|
|
7809
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
|
+
|
|
7810
8303
|
/** @public */
|
|
7811
8304
|
export declare type TLInterruptEvent = (info: TLInterruptEventInfo) => void;
|
|
7812
8305
|
|
|
@@ -8054,6 +8547,94 @@ export declare const tlmenus: {
|
|
|
8054
8547
|
*/
|
|
8055
8548
|
export declare type TLOnMountHandler = (editor: Editor) => (() => undefined | void) | undefined | void;
|
|
8056
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
|
+
|
|
8057
8638
|
/** @public */
|
|
8058
8639
|
export declare type TLPinchEvent = (info: TLPinchEventInfo) => void;
|
|
8059
8640
|
|
|
@@ -8241,6 +8822,21 @@ export declare interface TLShapeIndicatorsProps {
|
|
|
8241
8822
|
showAll?: boolean;
|
|
8242
8823
|
}
|
|
8243
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
|
+
|
|
8244
8840
|
/**
|
|
8245
8841
|
* Options passed to {@link ShapeUtil.canBeLaidOut}.
|
|
8246
8842
|
*
|
|
@@ -8298,6 +8894,7 @@ export declare interface TLShapeUtilConstructor<T extends TLShape, U extends Sha
|
|
|
8298
8894
|
type: T['type'];
|
|
8299
8895
|
props?: RecordProps<T>;
|
|
8300
8896
|
migrations?: LegacyMigrations | MigrationSequence | TLPropsMigrations;
|
|
8897
|
+
handledAssetTypes?: readonly string[];
|
|
8301
8898
|
}
|
|
8302
8899
|
|
|
8303
8900
|
/** @public */
|
|
@@ -8325,6 +8922,7 @@ export declare interface TLStateNodeConstructor {
|
|
|
8325
8922
|
children?(): TLStateNodeConstructor[];
|
|
8326
8923
|
isLockable: boolean;
|
|
8327
8924
|
useCoalescedEvents: boolean;
|
|
8925
|
+
trackPerformance: boolean;
|
|
8328
8926
|
}
|
|
8329
8927
|
|
|
8330
8928
|
/** @public */
|
|
@@ -8337,6 +8935,14 @@ export declare interface TLStoreBaseOptions {
|
|
|
8337
8935
|
defaultName?: string;
|
|
8338
8936
|
/** How should this store upload & resolve assets? */
|
|
8339
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>;
|
|
8944
|
+
/** How should this store resolve users for attribution? */
|
|
8945
|
+
users?: TLUserStore;
|
|
8340
8946
|
/** Called when the store is connected to an {@link @tldraw/editor#Editor}. */
|
|
8341
8947
|
onMount?(editor: Editor): (() => void) | void;
|
|
8342
8948
|
}
|
|
@@ -8356,6 +8962,7 @@ export declare type TLStoreOptions = TLStoreBaseOptions & {
|
|
|
8356
8962
|
|
|
8357
8963
|
/** @public */
|
|
8358
8964
|
export declare type TLStoreSchemaOptions = {
|
|
8965
|
+
assetUtils?: readonly TLAnyAssetUtilConstructor[];
|
|
8359
8966
|
bindingUtils?: readonly TLAnyBindingUtilConstructor[];
|
|
8360
8967
|
migrations?: readonly MigrationSequence[];
|
|
8361
8968
|
records?: Record<string, CustomRecordInfo>;
|
|
@@ -8493,6 +9100,19 @@ export declare interface TLTldrawExternalContentSource {
|
|
|
8493
9100
|
data: TLContent;
|
|
8494
9101
|
}
|
|
8495
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
|
+
|
|
8496
9116
|
/** @public */
|
|
8497
9117
|
export declare interface TLUpdatePointerOptions {
|
|
8498
9118
|
/** Whether to update the pointer immediately, rather than on the next tick. */
|
|
@@ -8524,12 +9144,6 @@ export declare interface TLUrlExternalContent extends TLBaseExternalContent {
|
|
|
8524
9144
|
url: string;
|
|
8525
9145
|
}
|
|
8526
9146
|
|
|
8527
|
-
/** @public */
|
|
8528
|
-
export declare interface TLUser {
|
|
8529
|
-
readonly userPreferences: Signal<TLUserPreferences>;
|
|
8530
|
-
readonly setUserPreferences: (userPreferences: TLUserPreferences) => void;
|
|
8531
|
-
}
|
|
8532
|
-
|
|
8533
9147
|
/**
|
|
8534
9148
|
* A user of tldraw
|
|
8535
9149
|
*
|
|
@@ -8630,6 +9244,9 @@ export declare function uniq<T>(array: {
|
|
|
8630
9244
|
readonly length: number;
|
|
8631
9245
|
} | null | undefined): T[];
|
|
8632
9246
|
|
|
9247
|
+
/** @public */
|
|
9248
|
+
export declare function useColorMode(): 'dark' | 'light';
|
|
9249
|
+
|
|
8633
9250
|
/** @public */
|
|
8634
9251
|
export declare function useContainer(): HTMLElement;
|
|
8635
9252
|
|
|
@@ -8668,9 +9285,6 @@ export declare function useGlobalMenuIsOpen(id: string, onChange?: (isOpen: bool
|
|
|
8668
9285
|
/** @public */
|
|
8669
9286
|
export declare function useIsCropping(shapeId: TLShapeId): boolean;
|
|
8670
9287
|
|
|
8671
|
-
/** @public */
|
|
8672
|
-
export declare function useIsDarkMode(): boolean;
|
|
8673
|
-
|
|
8674
9288
|
/** @public */
|
|
8675
9289
|
export declare function useIsEditing(shapeId: TLShapeId): boolean;
|
|
8676
9290
|
|
|
@@ -8708,11 +9322,11 @@ export declare function usePresence(userId: string): null | TLInstancePresence;
|
|
|
8708
9322
|
/** @public */
|
|
8709
9323
|
export declare class UserPreferencesManager {
|
|
8710
9324
|
private readonly user;
|
|
8711
|
-
private readonly
|
|
9325
|
+
private readonly colorScheme;
|
|
8712
9326
|
systemColorScheme: Atom<"dark" | "light", unknown>;
|
|
8713
9327
|
disposables: Set<() => void>;
|
|
8714
9328
|
dispose(): void;
|
|
8715
|
-
constructor(user:
|
|
9329
|
+
constructor(user: TLCurrentUser, colorScheme: 'dark' | 'light' | 'system');
|
|
8716
9330
|
updateUserPreferences(userPreferences: Partial<TLUserPreferences>): void;
|
|
8717
9331
|
getUserPreferences(): {
|
|
8718
9332
|
animationSpeed: number;
|
|
@@ -8783,10 +9397,10 @@ export declare function useSvgExportContext(): null | SvgExportContext;
|
|
|
8783
9397
|
/**
|
|
8784
9398
|
* @public
|
|
8785
9399
|
*/
|
|
8786
|
-
export declare function
|
|
9400
|
+
export declare function useTldrawCurrentUser(opts: {
|
|
8787
9401
|
setUserPreferences?: (userPreferences: TLUserPreferences) => void;
|
|
8788
9402
|
userPreferences?: Signal<TLUserPreferences> | TLUserPreferences;
|
|
8789
|
-
}):
|
|
9403
|
+
}): TLCurrentUser;
|
|
8790
9404
|
|
|
8791
9405
|
/** @public */
|
|
8792
9406
|
export declare function useTLSchemaFromUtils(opts: TLStoreSchemaOptions): StoreSchema<TLRecord, TLStoreProps>;
|