@tldraw/editor 4.6.0-canary.239a3cd0bda5 → 4.6.0-canary.2704cdc4a4e9
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 +378 -169
- package/dist-cjs/index.js +10 -21
- package/dist-cjs/index.js.map +2 -2
- package/dist-cjs/lib/TldrawEditor.js +3 -0
- package/dist-cjs/lib/TldrawEditor.js.map +2 -2
- package/dist-cjs/lib/components/default-components/CanvasOverlays.js +180 -0
- package/dist-cjs/lib/components/default-components/CanvasOverlays.js.map +7 -0
- package/dist-cjs/lib/components/default-components/DefaultCanvas.js +31 -237
- package/dist-cjs/lib/components/default-components/DefaultCanvas.js.map +3 -3
- package/dist-cjs/lib/editor/Editor.js +78 -28
- package/dist-cjs/lib/editor/Editor.js.map +2 -2
- package/dist-cjs/lib/editor/managers/CollaboratorsManager/CollaboratorsManager.js +98 -0
- package/dist-cjs/lib/editor/managers/CollaboratorsManager/CollaboratorsManager.js.map +7 -0
- package/dist-cjs/lib/editor/managers/ThemeManager/defaultThemes.js +14 -0
- package/dist-cjs/lib/editor/managers/ThemeManager/defaultThemes.js.map +2 -2
- package/dist-cjs/lib/editor/overlays/OverlayManager.js +154 -0
- package/dist-cjs/lib/editor/overlays/OverlayManager.js.map +7 -0
- package/dist-cjs/lib/editor/overlays/OverlayUtil.js +92 -0
- package/dist-cjs/lib/editor/overlays/OverlayUtil.js.map +7 -0
- package/dist-cjs/lib/editor/overlays/ShapeIndicatorOverlayUtil.js +161 -0
- package/dist-cjs/lib/editor/overlays/ShapeIndicatorOverlayUtil.js.map +7 -0
- package/dist-cjs/lib/editor/shapes/BaseFrameLikeShapeUtil.js.map +2 -2
- package/dist-cjs/lib/editor/shapes/ShapeUtil.js +7 -22
- package/dist-cjs/lib/editor/shapes/ShapeUtil.js.map +2 -2
- package/dist-cjs/lib/editor/shapes/group/GroupShapeUtil.js +32 -2
- package/dist-cjs/lib/editor/shapes/group/GroupShapeUtil.js.map +2 -2
- package/dist-cjs/lib/editor/types/event-types.js.map +2 -2
- package/dist-cjs/lib/exports/fetchCache.js +1 -1
- package/dist-cjs/lib/exports/fetchCache.js.map +2 -2
- package/dist-cjs/lib/hooks/EditorComponentsContext.js.map +2 -2
- package/dist-cjs/lib/hooks/useEditorComponents.js +0 -28
- package/dist-cjs/lib/hooks/useEditorComponents.js.map +2 -2
- package/dist-cjs/lib/hooks/usePeerIds.js +1 -36
- package/dist-cjs/lib/hooks/usePeerIds.js.map +2 -2
- package/dist-cjs/lib/hooks/useShapeCulling.js +2 -1
- package/dist-cjs/lib/hooks/useShapeCulling.js.map +2 -2
- package/dist-cjs/lib/options.js +0 -1
- package/dist-cjs/lib/options.js.map +2 -2
- package/dist-cjs/lib/utils/sync/TLLocalSyncClient.js +3 -0
- package/dist-cjs/lib/utils/sync/TLLocalSyncClient.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 +378 -169
- package/dist-esm/index.mjs +15 -39
- package/dist-esm/index.mjs.map +2 -2
- package/dist-esm/lib/TldrawEditor.mjs +3 -0
- package/dist-esm/lib/TldrawEditor.mjs.map +2 -2
- package/dist-esm/lib/components/default-components/CanvasOverlays.mjs +160 -0
- package/dist-esm/lib/components/default-components/CanvasOverlays.mjs.map +7 -0
- package/dist-esm/lib/components/default-components/DefaultCanvas.mjs +32 -238
- package/dist-esm/lib/components/default-components/DefaultCanvas.mjs.map +3 -3
- package/dist-esm/lib/editor/Editor.mjs +78 -29
- package/dist-esm/lib/editor/Editor.mjs.map +2 -2
- package/dist-esm/lib/editor/managers/CollaboratorsManager/CollaboratorsManager.mjs +83 -0
- package/dist-esm/lib/editor/managers/CollaboratorsManager/CollaboratorsManager.mjs.map +7 -0
- package/dist-esm/lib/editor/managers/ThemeManager/defaultThemes.mjs +14 -0
- package/dist-esm/lib/editor/managers/ThemeManager/defaultThemes.mjs.map +2 -2
- package/dist-esm/lib/editor/overlays/OverlayManager.mjs +136 -0
- package/dist-esm/lib/editor/overlays/OverlayManager.mjs.map +7 -0
- package/dist-esm/lib/editor/overlays/OverlayUtil.mjs +72 -0
- package/dist-esm/lib/editor/overlays/OverlayUtil.mjs.map +7 -0
- package/dist-esm/lib/editor/overlays/ShapeIndicatorOverlayUtil.mjs +141 -0
- package/dist-esm/lib/editor/overlays/ShapeIndicatorOverlayUtil.mjs.map +7 -0
- package/dist-esm/lib/editor/shapes/BaseFrameLikeShapeUtil.mjs.map +2 -2
- package/dist-esm/lib/editor/shapes/ShapeUtil.mjs +7 -22
- package/dist-esm/lib/editor/shapes/ShapeUtil.mjs.map +2 -2
- package/dist-esm/lib/editor/shapes/group/GroupShapeUtil.mjs +32 -2
- package/dist-esm/lib/editor/shapes/group/GroupShapeUtil.mjs.map +2 -2
- package/dist-esm/lib/editor/types/event-types.mjs.map +2 -2
- package/dist-esm/lib/exports/fetchCache.mjs +2 -2
- package/dist-esm/lib/exports/fetchCache.mjs.map +2 -2
- package/dist-esm/lib/hooks/EditorComponentsContext.mjs.map +2 -2
- package/dist-esm/lib/hooks/useEditorComponents.mjs +0 -28
- package/dist-esm/lib/hooks/useEditorComponents.mjs.map +2 -2
- package/dist-esm/lib/hooks/usePeerIds.mjs +2 -40
- package/dist-esm/lib/hooks/usePeerIds.mjs.map +2 -2
- package/dist-esm/lib/hooks/useShapeCulling.mjs +2 -1
- package/dist-esm/lib/hooks/useShapeCulling.mjs.map +2 -2
- package/dist-esm/lib/options.mjs +0 -1
- package/dist-esm/lib/options.mjs.map +2 -2
- package/dist-esm/lib/utils/sync/TLLocalSyncClient.mjs +3 -0
- package/dist-esm/lib/utils/sync/TLLocalSyncClient.mjs.map +2 -2
- package/dist-esm/version.mjs +3 -3
- package/dist-esm/version.mjs.map +1 -1
- package/editor.css +3 -219
- package/package.json +7 -7
- package/src/index.ts +13 -38
- package/src/lib/TldrawEditor.tsx +9 -0
- package/src/lib/components/default-components/CanvasOverlays.tsx +208 -0
- package/src/lib/components/default-components/DefaultCanvas.tsx +36 -312
- package/src/lib/editor/Editor.test.ts +3 -1
- package/src/lib/editor/Editor.ts +80 -24
- package/src/lib/editor/managers/CollaboratorsManager/CollaboratorsManager.ts +98 -0
- package/src/lib/editor/managers/ThemeManager/defaultThemes.ts +14 -0
- package/src/lib/editor/overlays/OverlayManager.ts +183 -0
- package/src/lib/editor/overlays/OverlayUtil.ts +143 -0
- package/src/lib/editor/overlays/ShapeIndicatorOverlayUtil.ts +216 -0
- package/src/lib/editor/shapes/BaseFrameLikeShapeUtil.tsx +4 -2
- package/src/lib/editor/shapes/ShapeUtil.ts +15 -25
- package/src/lib/editor/shapes/group/GroupShapeUtil.tsx +40 -3
- package/src/lib/editor/types/event-types.ts +2 -0
- package/src/lib/exports/fetchCache.ts +2 -4
- package/src/lib/exports/getSvgJsx.test.ts +3 -1
- package/src/lib/hooks/EditorComponentsContext.tsx +0 -27
- package/src/lib/hooks/useEditorComponents.tsx +0 -28
- package/src/lib/hooks/usePeerIds.ts +6 -55
- package/src/lib/hooks/useShapeCulling.tsx +3 -1
- package/src/lib/options.ts +0 -7
- package/src/lib/utils/sync/TLLocalSyncClient.ts +3 -0
- package/src/version.ts +3 -3
- package/dist-cjs/lib/components/LiveCollaborators.js +0 -152
- package/dist-cjs/lib/components/LiveCollaborators.js.map +0 -7
- package/dist-cjs/lib/components/default-components/CanvasShapeIndicators.js +0 -234
- package/dist-cjs/lib/components/default-components/CanvasShapeIndicators.js.map +0 -7
- package/dist-cjs/lib/components/default-components/DefaultBrush.js +0 -38
- package/dist-cjs/lib/components/default-components/DefaultBrush.js.map +0 -7
- package/dist-cjs/lib/components/default-components/DefaultCollaboratorHint.js +0 -71
- package/dist-cjs/lib/components/default-components/DefaultCollaboratorHint.js.map +0 -7
- package/dist-cjs/lib/components/default-components/DefaultHandle.js +0 -56
- package/dist-cjs/lib/components/default-components/DefaultHandle.js.map +0 -7
- package/dist-cjs/lib/components/default-components/DefaultHandles.js +0 -28
- package/dist-cjs/lib/components/default-components/DefaultHandles.js.map +0 -7
- package/dist-cjs/lib/components/default-components/DefaultScribble.js +0 -51
- package/dist-cjs/lib/components/default-components/DefaultScribble.js.map +0 -7
- package/dist-cjs/lib/components/default-components/DefaultSelectionForeground.js +0 -69
- package/dist-cjs/lib/components/default-components/DefaultSelectionForeground.js.map +0 -7
- package/dist-cjs/lib/components/default-components/DefaultShapeIndicator.js +0 -107
- package/dist-cjs/lib/components/default-components/DefaultShapeIndicator.js.map +0 -7
- package/dist-cjs/lib/components/default-components/DefaultShapeIndicatorErrorFallback.js +0 -28
- package/dist-cjs/lib/components/default-components/DefaultShapeIndicatorErrorFallback.js.map +0 -7
- package/dist-cjs/lib/components/default-components/DefaultShapeIndicators.js +0 -102
- package/dist-cjs/lib/components/default-components/DefaultShapeIndicators.js.map +0 -7
- package/dist-cjs/lib/components/default-components/DefaultSnapIndictor.js +0 -170
- package/dist-cjs/lib/components/default-components/DefaultSnapIndictor.js.map +0 -7
- package/dist-esm/lib/components/LiveCollaborators.mjs +0 -135
- package/dist-esm/lib/components/LiveCollaborators.mjs.map +0 -7
- package/dist-esm/lib/components/default-components/CanvasShapeIndicators.mjs +0 -214
- package/dist-esm/lib/components/default-components/CanvasShapeIndicators.mjs.map +0 -7
- package/dist-esm/lib/components/default-components/DefaultBrush.mjs +0 -18
- package/dist-esm/lib/components/default-components/DefaultBrush.mjs.map +0 -7
- package/dist-esm/lib/components/default-components/DefaultCollaboratorHint.mjs +0 -41
- package/dist-esm/lib/components/default-components/DefaultCollaboratorHint.mjs.map +0 -7
- package/dist-esm/lib/components/default-components/DefaultHandle.mjs +0 -26
- package/dist-esm/lib/components/default-components/DefaultHandle.mjs.map +0 -7
- package/dist-esm/lib/components/default-components/DefaultHandles.mjs +0 -8
- package/dist-esm/lib/components/default-components/DefaultHandles.mjs.map +0 -7
- package/dist-esm/lib/components/default-components/DefaultScribble.mjs +0 -21
- package/dist-esm/lib/components/default-components/DefaultScribble.mjs.map +0 -7
- package/dist-esm/lib/components/default-components/DefaultSelectionForeground.mjs +0 -39
- package/dist-esm/lib/components/default-components/DefaultSelectionForeground.mjs.map +0 -7
- package/dist-esm/lib/components/default-components/DefaultShapeIndicator.mjs +0 -77
- package/dist-esm/lib/components/default-components/DefaultShapeIndicator.mjs.map +0 -7
- package/dist-esm/lib/components/default-components/DefaultShapeIndicatorErrorFallback.mjs +0 -8
- package/dist-esm/lib/components/default-components/DefaultShapeIndicatorErrorFallback.mjs.map +0 -7
- package/dist-esm/lib/components/default-components/DefaultShapeIndicators.mjs +0 -82
- package/dist-esm/lib/components/default-components/DefaultShapeIndicators.mjs.map +0 -7
- package/dist-esm/lib/components/default-components/DefaultSnapIndictor.mjs +0 -142
- package/dist-esm/lib/components/default-components/DefaultSnapIndictor.mjs.map +0 -7
- package/src/lib/components/LiveCollaborators.tsx +0 -180
- package/src/lib/components/default-components/CanvasShapeIndicators.tsx +0 -300
- package/src/lib/components/default-components/DefaultBrush.tsx +0 -35
- package/src/lib/components/default-components/DefaultCollaboratorHint.tsx +0 -52
- package/src/lib/components/default-components/DefaultHandle.tsx +0 -42
- package/src/lib/components/default-components/DefaultHandles.tsx +0 -15
- package/src/lib/components/default-components/DefaultScribble.tsx +0 -31
- package/src/lib/components/default-components/DefaultSelectionForeground.tsx +0 -50
- package/src/lib/components/default-components/DefaultShapeIndicator.tsx +0 -104
- package/src/lib/components/default-components/DefaultShapeIndicatorErrorFallback.tsx +0 -9
- package/src/lib/components/default-components/DefaultShapeIndicators.tsx +0 -118
- package/src/lib/components/default-components/DefaultSnapIndictor.tsx +0 -174
package/dist-cjs/index.d.ts
CHANGED
|
@@ -19,7 +19,6 @@ import { JsonObject } from '@tldraw/utils';
|
|
|
19
19
|
import { JSX } from 'react/jsx-runtime';
|
|
20
20
|
import { LegacyMigrations } from '@tldraw/store';
|
|
21
21
|
import { MigrationSequence } from '@tldraw/store';
|
|
22
|
-
import { NamedExoticComponent } from 'react';
|
|
23
22
|
import { Node as Node_2 } from '@tiptap/pm/model';
|
|
24
23
|
import { PerformanceTracker } from '@tldraw/utils';
|
|
25
24
|
import { PointerEvent as PointerEvent_2 } from 'react';
|
|
@@ -251,8 +250,10 @@ export declare abstract class BaseBoxShapeUtil<Shape extends TLBaseBoxShape> ext
|
|
|
251
250
|
* return <SVGContainer>...</SVGContainer>
|
|
252
251
|
* }
|
|
253
252
|
*
|
|
254
|
-
* override
|
|
255
|
-
*
|
|
253
|
+
* override getIndicatorPath(shape: MyContainerShape) {
|
|
254
|
+
* const path = new Path2D()
|
|
255
|
+
* path.rect(0, 0, shape.props.w, shape.props.h)
|
|
256
|
+
* return path
|
|
256
257
|
* }
|
|
257
258
|
* }
|
|
258
259
|
* ```
|
|
@@ -767,6 +768,49 @@ export declare class ClickManager {
|
|
|
767
768
|
*/
|
|
768
769
|
export declare function clockwiseAngleDist(a0: number, a1: number): number;
|
|
769
770
|
|
|
771
|
+
/**
|
|
772
|
+
* Tracks remote peers and exposes the collaborator-related queries used by the
|
|
773
|
+
* editor and its overlays. Encapsulates the visibility clock that periodically
|
|
774
|
+
* re-evaluates which collaborators should be visible based on activity.
|
|
775
|
+
*
|
|
776
|
+
* Accessed via {@link Editor.collaborators}.
|
|
777
|
+
*
|
|
778
|
+
* @public
|
|
779
|
+
*/
|
|
780
|
+
export declare class CollaboratorsManager {
|
|
781
|
+
private readonly editor;
|
|
782
|
+
constructor(editor: Editor);
|
|
783
|
+
/**
|
|
784
|
+
* Drives reactive re-evaluation of {@link CollaboratorsManager.getVisibleCollaborators}.
|
|
785
|
+
* Ticked on a fixed interval so callers don't need to manage their own activity timers.
|
|
786
|
+
*/
|
|
787
|
+
private readonly _visibilityClock;
|
|
788
|
+
private _getCollaboratorsQuery;
|
|
789
|
+
/**
|
|
790
|
+
* Returns a list of presence records for all peer collaborators.
|
|
791
|
+
* This will return the latest presence record for each connected user.
|
|
792
|
+
*/
|
|
793
|
+
getCollaborators(): TLInstancePresence[];
|
|
794
|
+
/**
|
|
795
|
+
* Returns a list of presence records for all peer collaborators on the current page.
|
|
796
|
+
* This will return the latest presence record for each connected user.
|
|
797
|
+
*/
|
|
798
|
+
getCollaboratorsOnCurrentPage(): TLInstancePresence[];
|
|
799
|
+
/**
|
|
800
|
+
* Returns a list of presence records for peer collaborators who should currently be
|
|
801
|
+
* shown in the UI. Filters {@link CollaboratorsManager.getCollaborators} by activity
|
|
802
|
+
* state (active / idle / inactive) and visibility rules such as following and
|
|
803
|
+
* highlighted users. Re-evaluates on the visibility clock, so callers don't need to
|
|
804
|
+
* drive their own activity timer.
|
|
805
|
+
*/
|
|
806
|
+
getVisibleCollaborators(): TLInstancePresence[];
|
|
807
|
+
/**
|
|
808
|
+
* Returns a list of presence records for peer collaborators who should currently be
|
|
809
|
+
* shown in the UI, filtered to those on the current page.
|
|
810
|
+
*/
|
|
811
|
+
getVisibleCollaboratorsOnCurrentPage(): TLInstancePresence[];
|
|
812
|
+
}
|
|
813
|
+
|
|
770
814
|
/**
|
|
771
815
|
* @public
|
|
772
816
|
* @react
|
|
@@ -929,51 +973,21 @@ export declare const DEFAULT_THEME: TLTheme;
|
|
|
929
973
|
/** @public @react */
|
|
930
974
|
export declare function DefaultBackground(): JSX.Element;
|
|
931
975
|
|
|
932
|
-
/** @public @react */
|
|
933
|
-
export declare const DefaultBrush: ({ brush, color, opacity, className }: TLBrushProps) => JSX.Element;
|
|
934
|
-
|
|
935
976
|
/** @public @react */
|
|
936
977
|
export declare function DefaultCanvas({ className }: TLCanvasComponentProps): JSX.Element;
|
|
937
978
|
|
|
938
|
-
/** @public @react */
|
|
939
|
-
export declare function DefaultCollaboratorHint({ className, zoom, point, color, viewport, opacity }: TLCollaboratorHintProps): JSX.Element;
|
|
940
|
-
|
|
941
|
-
/** @public @react */
|
|
942
|
-
export declare const DefaultCursor: NamedExoticComponent<TLCursorProps>;
|
|
943
|
-
|
|
944
979
|
/** @public @react */
|
|
945
980
|
export declare const DefaultErrorFallback: TLErrorFallbackComponent;
|
|
946
981
|
|
|
947
982
|
/** @public @react */
|
|
948
983
|
export declare function DefaultGrid({ x, y, z, size }: TLGridProps): JSX.Element;
|
|
949
984
|
|
|
950
|
-
/** @public @react */
|
|
951
|
-
export declare function DefaultHandle({ handle, isCoarse, className, zoom }: TLHandleProps): JSX.Element;
|
|
952
|
-
|
|
953
|
-
/** @public @react */
|
|
954
|
-
export declare const DefaultHandles: ({ children }: TLHandlesProps) => JSX.Element;
|
|
955
|
-
|
|
956
|
-
/** @public @react */
|
|
957
|
-
export declare function DefaultScribble({ scribble, zoom, color, opacity, className }: TLScribbleProps): JSX.Element | null;
|
|
958
|
-
|
|
959
985
|
/** @public @react */
|
|
960
986
|
export declare function DefaultSelectionBackground({ bounds, rotation }: TLSelectionBackgroundProps): JSX.Element;
|
|
961
987
|
|
|
962
|
-
/** @public @react */
|
|
963
|
-
export declare function DefaultSelectionForeground({ bounds, rotation }: TLSelectionForegroundProps): JSX.Element;
|
|
964
|
-
|
|
965
|
-
/** @public @react */
|
|
966
|
-
export declare const DefaultShapeIndicator: NamedExoticComponent<TLShapeIndicatorProps>;
|
|
967
|
-
|
|
968
|
-
/** @public @react */
|
|
969
|
-
export declare const DefaultShapeIndicators: NamedExoticComponent<TLShapeIndicatorsProps>;
|
|
970
|
-
|
|
971
988
|
/** @public @react */
|
|
972
989
|
export declare const DefaultShapeWrapper: ForwardRefExoticComponent<TLShapeWrapperProps & RefAttributes<HTMLDivElement>>;
|
|
973
990
|
|
|
974
|
-
/** @public @react */
|
|
975
|
-
export declare function DefaultSnapIndicator({ className, line, zoom }: TLSnapIndicatorProps): JSX.Element;
|
|
976
|
-
|
|
977
991
|
/** @public @react */
|
|
978
992
|
export declare function DefaultSpinner(props: React.SVGProps<SVGSVGElement>): JSX.Element;
|
|
979
993
|
|
|
@@ -1053,7 +1067,6 @@ export declare const defaultTldrawOptions: {
|
|
|
1053
1067
|
readonly tooltipDelayMs: 700;
|
|
1054
1068
|
readonly uiCoarseDragDistanceSquared: 625;
|
|
1055
1069
|
readonly uiDragDistanceSquared: 16;
|
|
1056
|
-
readonly useCanvasIndicators: true;
|
|
1057
1070
|
readonly zoomToFitPadding: 128;
|
|
1058
1071
|
};
|
|
1059
1072
|
|
|
@@ -1153,7 +1166,7 @@ export declare class EdgeScrollManager {
|
|
|
1153
1166
|
/** @public */
|
|
1154
1167
|
export declare class Editor extends EventEmitter<TLEventMap> {
|
|
1155
1168
|
readonly id: string;
|
|
1156
|
-
constructor({ store, user, shapeUtils, bindingUtils, assetUtils: assetUtilConstructors, tools, getContainer, cameraOptions, initialState, autoFocus, options: _options, textOptions: _textOptions, getShapeVisibility, colorScheme, fontAssetUrls, themes, initialTheme }: TLEditorOptions);
|
|
1169
|
+
constructor({ store, user, shapeUtils, bindingUtils, assetUtils: assetUtilConstructors, overlayUtils: overlayUtilConstructors, tools, getContainer, cameraOptions, initialState, autoFocus, options: _options, textOptions: _textOptions, getShapeVisibility, colorScheme, fontAssetUrls, themes, initialTheme }: TLEditorOptions);
|
|
1157
1170
|
private readonly _getShapeVisibility?;
|
|
1158
1171
|
private getIsShapeHiddenCache;
|
|
1159
1172
|
isShapeHidden(shapeOrId: TLShape | TLShapeId): boolean;
|
|
@@ -1235,6 +1248,12 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1235
1248
|
setInterval: (handler: TimerHandler, timeout?: number | undefined, ...args: any[]) => number;
|
|
1236
1249
|
setTimeout: (handler: TimerHandler, timeout?: number | undefined, ...args: any[]) => number;
|
|
1237
1250
|
};
|
|
1251
|
+
/**
|
|
1252
|
+
* A manager for remote peer collaborators connected to this editor.
|
|
1253
|
+
*
|
|
1254
|
+
* @public
|
|
1255
|
+
*/
|
|
1256
|
+
readonly collaborators: CollaboratorsManager;
|
|
1238
1257
|
/**
|
|
1239
1258
|
* A manager for the user and their preferences.
|
|
1240
1259
|
*
|
|
@@ -1260,6 +1279,12 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1260
1279
|
* @public
|
|
1261
1280
|
*/
|
|
1262
1281
|
readonly scribbles: ScribbleManager;
|
|
1282
|
+
/**
|
|
1283
|
+
* A manager for canvas overlay UI elements (selection handles, shape handles, etc.).
|
|
1284
|
+
*
|
|
1285
|
+
* @public
|
|
1286
|
+
*/
|
|
1287
|
+
readonly overlays: OverlayManager;
|
|
1263
1288
|
/**
|
|
1264
1289
|
* A manager for side effects and correct state enforcement. See {@link @tldraw/store#StoreSideEffects} for details.
|
|
1265
1290
|
*
|
|
@@ -1738,6 +1763,11 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1738
1763
|
/**
|
|
1739
1764
|
* Set the cursor.
|
|
1740
1765
|
*
|
|
1766
|
+
* No-op when the partial wouldn't change the current cursor — `setCursor`
|
|
1767
|
+
* is called from pointer-move hot paths (see `updateHoveredOverlayId`,
|
|
1768
|
+
* various tool states) and skipping redundant writes avoids needlessly
|
|
1769
|
+
* dirtying instance state.
|
|
1770
|
+
*
|
|
1741
1771
|
* @param cursor - The cursor to set.
|
|
1742
1772
|
* @public
|
|
1743
1773
|
*/
|
|
@@ -2497,11 +2527,12 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
2497
2527
|
* @public
|
|
2498
2528
|
*/
|
|
2499
2529
|
pageToViewport(point: VecLike): Vec;
|
|
2500
|
-
private _getCollaboratorsQuery;
|
|
2501
2530
|
/**
|
|
2502
2531
|
* Returns a list of presence records for all peer collaborators.
|
|
2503
2532
|
* This will return the latest presence record for each connected user.
|
|
2504
2533
|
*
|
|
2534
|
+
* Convenience wrapper for {@link CollaboratorsManager.getCollaborators}.
|
|
2535
|
+
*
|
|
2505
2536
|
* @public
|
|
2506
2537
|
*/
|
|
2507
2538
|
getCollaborators(): TLInstancePresence[];
|
|
@@ -2509,9 +2540,32 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
2509
2540
|
* Returns a list of presence records for all peer collaborators on the current page.
|
|
2510
2541
|
* This will return the latest presence record for each connected user.
|
|
2511
2542
|
*
|
|
2543
|
+
* Convenience wrapper for {@link CollaboratorsManager.getCollaboratorsOnCurrentPage}.
|
|
2544
|
+
*
|
|
2512
2545
|
* @public
|
|
2513
2546
|
*/
|
|
2514
2547
|
getCollaboratorsOnCurrentPage(): TLInstancePresence[];
|
|
2548
|
+
/**
|
|
2549
|
+
* Returns a list of presence records for peer collaborators who should currently be
|
|
2550
|
+
* shown in the UI. Filters {@link Editor.getCollaborators} by activity state
|
|
2551
|
+
* (active / idle / inactive) and visibility rules such as following and highlighted
|
|
2552
|
+
* users. Re-evaluates on the collaborator visibility clock, so callers don't need to
|
|
2553
|
+
* drive their own activity timer.
|
|
2554
|
+
*
|
|
2555
|
+
* Convenience wrapper for {@link CollaboratorsManager.getVisibleCollaborators}.
|
|
2556
|
+
*
|
|
2557
|
+
* @public
|
|
2558
|
+
*/
|
|
2559
|
+
getVisibleCollaborators(): TLInstancePresence[];
|
|
2560
|
+
/**
|
|
2561
|
+
* Returns a list of presence records for peer collaborators who should currently be
|
|
2562
|
+
* shown in the UI, filtered to those on the current page.
|
|
2563
|
+
*
|
|
2564
|
+
* Convenience wrapper for {@link CollaboratorsManager.getVisibleCollaboratorsOnCurrentPage}.
|
|
2565
|
+
*
|
|
2566
|
+
* @public
|
|
2567
|
+
*/
|
|
2568
|
+
getVisibleCollaboratorsOnCurrentPage(): TLInstancePresence[];
|
|
2515
2569
|
/**
|
|
2516
2570
|
* Get the current user's ID for attribution purposes.
|
|
2517
2571
|
* Also ensures a `user:` record exists in the store for the current user.
|
|
@@ -4852,7 +4906,7 @@ export declare class GroupShapeUtil extends ShapeUtil<TLGroupShape> {
|
|
|
4852
4906
|
getDefaultProps(): TLGroupShape['props'];
|
|
4853
4907
|
getGeometry(shape: TLGroupShape): Geometry2d;
|
|
4854
4908
|
component(shape: TLGroupShape): JSX.Element | null;
|
|
4855
|
-
|
|
4909
|
+
getIndicatorPath(shape: TLGroupShape): Path2D;
|
|
4856
4910
|
onChildrenChange(group: TLGroupShape): void;
|
|
4857
4911
|
}
|
|
4858
4912
|
|
|
@@ -5480,6 +5534,179 @@ export declare function openWindow(url: string, target?: string, allowReferrer?:
|
|
|
5480
5534
|
/** @public */
|
|
5481
5535
|
export declare type OptionalKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
5482
5536
|
|
|
5537
|
+
/** @public */
|
|
5538
|
+
export declare class OverlayManager {
|
|
5539
|
+
readonly editor: Editor;
|
|
5540
|
+
constructor(editor: Editor);
|
|
5541
|
+
/* Excluded from this release type: _overlayUtils */
|
|
5542
|
+
/* Excluded from this release type: registerUtil */
|
|
5543
|
+
/**
|
|
5544
|
+
* Get an overlay util by type string, overlay instance, or by passing
|
|
5545
|
+
* a util class as a generic parameter for type-safe lookup.
|
|
5546
|
+
*
|
|
5547
|
+
* @example
|
|
5548
|
+
* ```ts
|
|
5549
|
+
* const util = editor.overlays.getOverlayUtil('brush')
|
|
5550
|
+
* const util = editor.overlays.getOverlayUtil<BrushOverlayUtil>('brush')
|
|
5551
|
+
* const util = editor.overlays.getOverlayUtil(myOverlay)
|
|
5552
|
+
* ```
|
|
5553
|
+
*
|
|
5554
|
+
* @public
|
|
5555
|
+
*/
|
|
5556
|
+
getOverlayUtil<T extends OverlayUtil>(type: T extends OverlayUtil<infer O> ? O['type'] : string): T;
|
|
5557
|
+
getOverlayUtil<O extends TLOverlay>(overlay: O): OverlayUtil<O>;
|
|
5558
|
+
/**
|
|
5559
|
+
* Returns all registered overlay utils in paint order (ascending zIndex).
|
|
5560
|
+
* Utils with the same zIndex preserve their registration order.
|
|
5561
|
+
*
|
|
5562
|
+
* @public
|
|
5563
|
+
*/
|
|
5564
|
+
getOverlayUtilsInZOrder(): OverlayUtil[];
|
|
5565
|
+
/**
|
|
5566
|
+
* Reactive list of active overlay utils paired with the overlays they
|
|
5567
|
+
* produced for the current editor state, in paint order (ascending
|
|
5568
|
+
* zIndex). Both the hit-test and render paths read from this single
|
|
5569
|
+
* cached scan instead of each re-deriving the active set. Active utils
|
|
5570
|
+
* are included even when their `getOverlays()` returns an empty array,
|
|
5571
|
+
* since `render()` may still draw non-interactive UI (e.g. the selection
|
|
5572
|
+
* bounding box during brushing).
|
|
5573
|
+
*
|
|
5574
|
+
* @public
|
|
5575
|
+
*/
|
|
5576
|
+
getActiveOverlayEntries(): TLOverlayEntry[];
|
|
5577
|
+
/**
|
|
5578
|
+
* Reactively computed list of all currently active overlays, in paint order.
|
|
5579
|
+
* @public
|
|
5580
|
+
*/
|
|
5581
|
+
getCurrentOverlays(): TLOverlay[];
|
|
5582
|
+
private _geometryCache;
|
|
5583
|
+
/**
|
|
5584
|
+
* Get hit-test geometry for an overlay, cached by overlay identity. Lets
|
|
5585
|
+
* hit-testing on a pointermove storm skip the per-overlay geometry
|
|
5586
|
+
* allocation that {@link OverlayUtil.getGeometry} would otherwise do on
|
|
5587
|
+
* every call.
|
|
5588
|
+
*
|
|
5589
|
+
* @public
|
|
5590
|
+
*/
|
|
5591
|
+
getOverlayGeometry(overlay: TLOverlay): Geometry2d | null;
|
|
5592
|
+
/**
|
|
5593
|
+
* The currently hovered overlay id.
|
|
5594
|
+
* @public
|
|
5595
|
+
*/
|
|
5596
|
+
private _hoveredOverlayId;
|
|
5597
|
+
getHoveredOverlayId(): null | string;
|
|
5598
|
+
getHoveredOverlay(): null | TLOverlay;
|
|
5599
|
+
setHoveredOverlay(id: null | string): void;
|
|
5600
|
+
/**
|
|
5601
|
+
* Hit test all active overlays at a given page point.
|
|
5602
|
+
* Returns the topmost overlay whose geometry contains the point, or null.
|
|
5603
|
+
* Utils are walked from highest zIndex to lowest so the overlay painted on
|
|
5604
|
+
* top also wins the hit test. Within a util, overlays are walked in
|
|
5605
|
+
* array order: the first overlay whose geometry contains the point wins,
|
|
5606
|
+
* so utils should place highest-priority overlays first in `getOverlays`.
|
|
5607
|
+
* Interactive overlays (those with geometry) are checked; non-interactive are skipped.
|
|
5608
|
+
*
|
|
5609
|
+
* @param point - Point in page coordinates
|
|
5610
|
+
* @param margin - Hit test margin
|
|
5611
|
+
* @public
|
|
5612
|
+
*/
|
|
5613
|
+
getOverlayAtPoint(point: VecLike, margin?: number): null | TLOverlay;
|
|
5614
|
+
}
|
|
5615
|
+
|
|
5616
|
+
/**
|
|
5617
|
+
* Base class for overlay utilities. Overlays are ephemeral UI elements rendered
|
|
5618
|
+
* on top of the canvas (selection handles, rotation corners, shape handles, etc.).
|
|
5619
|
+
*
|
|
5620
|
+
* Each OverlayUtil defines a type of overlay and knows how to:
|
|
5621
|
+
* - Determine when its overlays should be active (predicate)
|
|
5622
|
+
* - Produce overlay instances from current editor state
|
|
5623
|
+
* - Provide hit-test geometry for interactive overlays
|
|
5624
|
+
* - Provide cursor style on hover
|
|
5625
|
+
* - Render into a canvas 2D context
|
|
5626
|
+
*
|
|
5627
|
+
* @public
|
|
5628
|
+
*/
|
|
5629
|
+
export declare abstract class OverlayUtil<T extends TLOverlay = TLOverlay> {
|
|
5630
|
+
editor: Editor;
|
|
5631
|
+
constructor(editor: Editor);
|
|
5632
|
+
static type: string;
|
|
5633
|
+
/**
|
|
5634
|
+
* Options for this overlay util. Override this to provide customization options.
|
|
5635
|
+
* Use {@link OverlayUtil.configure} to customize existing overlay utils.
|
|
5636
|
+
*
|
|
5637
|
+
* `zIndex` controls paint and hit-test order across utils — higher numbers
|
|
5638
|
+
* paint on top and are hit-tested first. Ties resolve by registration order.
|
|
5639
|
+
* Defaults to `0`; built-in utils use larger integers (100, 200, …) with
|
|
5640
|
+
* gaps so custom utils can slot between.
|
|
5641
|
+
*
|
|
5642
|
+
* @public
|
|
5643
|
+
*/
|
|
5644
|
+
options: {
|
|
5645
|
+
zIndex?: number;
|
|
5646
|
+
};
|
|
5647
|
+
/**
|
|
5648
|
+
* Create a new overlay util class with the given options merged in.
|
|
5649
|
+
*
|
|
5650
|
+
* @example
|
|
5651
|
+
* ```ts
|
|
5652
|
+
* const MyBrush = BrushOverlayUtil.configure({ fill: 'rgba(0,0,255,0.1)' })
|
|
5653
|
+
* ```
|
|
5654
|
+
*
|
|
5655
|
+
* @public
|
|
5656
|
+
*/
|
|
5657
|
+
static configure<T extends TLOverlayUtilConstructor<any>>(this: T, options: T extends new (...args: any[]) => {
|
|
5658
|
+
options: infer Options;
|
|
5659
|
+
} ? Partial<Options> : never): T;
|
|
5660
|
+
/**
|
|
5661
|
+
* Whether this overlay util's overlays should currently be active.
|
|
5662
|
+
* Checked reactively to determine which overlays exist at any given time.
|
|
5663
|
+
*/
|
|
5664
|
+
abstract isActive(): boolean;
|
|
5665
|
+
/**
|
|
5666
|
+
* Returns the overlay instances that currently exist.
|
|
5667
|
+
* Called only when `isActive()` returns true.
|
|
5668
|
+
*/
|
|
5669
|
+
abstract getOverlays(): T[];
|
|
5670
|
+
/**
|
|
5671
|
+
* Returns hit-test geometry for an overlay instance, in page coordinates.
|
|
5672
|
+
* Return null for non-interactive overlays (e.g. snap indicators, scribbles).
|
|
5673
|
+
*/
|
|
5674
|
+
getGeometry(_overlay: T): Geometry2d | null;
|
|
5675
|
+
/**
|
|
5676
|
+
* Returns the cursor type to show when hovering this overlay.
|
|
5677
|
+
*/
|
|
5678
|
+
getCursor(_overlay: T): TLCursorType | undefined;
|
|
5679
|
+
/**
|
|
5680
|
+
* Called when the user points down on this overlay, before the default
|
|
5681
|
+
* routing runs. Acts as an interrupt: define it to take over the event.
|
|
5682
|
+
*
|
|
5683
|
+
* Return `false` to continue with the default behavior (e.g. the
|
|
5684
|
+
* built-in rotate/resize handle transitions or shape-handle dispatch).
|
|
5685
|
+
* Return `true` — or nothing at all — to skip the default. In other
|
|
5686
|
+
* words, once you override this method you own the event unless you
|
|
5687
|
+
* explicitly opt back in by returning `false`.
|
|
5688
|
+
*/
|
|
5689
|
+
onPointerDown?(overlay: T, info: TLPointerEventInfo): boolean | void;
|
|
5690
|
+
/**
|
|
5691
|
+
* Render all active overlays into the canvas context.
|
|
5692
|
+
* The context is already transformed to page space (camera transform applied).
|
|
5693
|
+
* Called reactively when overlays or editor state changes.
|
|
5694
|
+
*/
|
|
5695
|
+
render(_ctx: CanvasRenderingContext2D, _overlays: T[]): void;
|
|
5696
|
+
/**
|
|
5697
|
+
* Optional: render all active overlays into the minimap canvas.
|
|
5698
|
+
* The context is already transformed to page space (minimap camera applied),
|
|
5699
|
+
* so overlays can use the same page-space coordinates as in {@link OverlayUtil.render}.
|
|
5700
|
+
*
|
|
5701
|
+
* `zoom` is the minimap's screen-pixels-per-page-unit, analogous to
|
|
5702
|
+
* `editor.getCamera().z`; use `1 / zoom` for one-minimap-pixel line widths.
|
|
5703
|
+
*
|
|
5704
|
+
* Most overlays should leave this blank — only overlays that are meaningful
|
|
5705
|
+
* at minimap scale (e.g. brushes, collaborator cursors) should opt in.
|
|
5706
|
+
*/
|
|
5707
|
+
renderMinimap(_ctx: CanvasRenderingContext2D, _overlays: T[], _zoom: number): void;
|
|
5708
|
+
}
|
|
5709
|
+
|
|
5483
5710
|
/**
|
|
5484
5711
|
* Parses a string created by {@link createDeepLinkString} back into a deep link descriptor.
|
|
5485
5712
|
*
|
|
@@ -6012,6 +6239,32 @@ export declare function setRuntimeOverrides(input: Partial<typeof runtime>): voi
|
|
|
6012
6239
|
/** @public */
|
|
6013
6240
|
export declare function setUserPreferences(user: TLUserPreferences): void;
|
|
6014
6241
|
|
|
6242
|
+
/**
|
|
6243
|
+
* Overlay util for shape indicators — the selection / hover / hint outlines drawn
|
|
6244
|
+
* under the selection foreground. Paints local indicators in the theme's
|
|
6245
|
+
* selection color.
|
|
6246
|
+
*
|
|
6247
|
+
* Remote collaborator selection indicators are drawn by a separate overlay util
|
|
6248
|
+
* (e.g. `CollaboratorShapeIndicatorOverlayUtil` from `tldraw`) that runs at a
|
|
6249
|
+
* lower z-index so peer selections appear under the local indicators.
|
|
6250
|
+
*
|
|
6251
|
+
* Non-interactive: contributes no hit-test geometry.
|
|
6252
|
+
*
|
|
6253
|
+
* @public
|
|
6254
|
+
*/
|
|
6255
|
+
export declare class ShapeIndicatorOverlayUtil extends OverlayUtil<TLShapeIndicatorOverlay> {
|
|
6256
|
+
static type: string;
|
|
6257
|
+
options: {
|
|
6258
|
+
hintedLineWidth: number;
|
|
6259
|
+
lineWidth: number;
|
|
6260
|
+
zIndex: number;
|
|
6261
|
+
};
|
|
6262
|
+
private _instanceFlags$;
|
|
6263
|
+
isActive(): boolean;
|
|
6264
|
+
getOverlays(): TLShapeIndicatorOverlay[];
|
|
6265
|
+
render(ctx: CanvasRenderingContext2D, overlays: TLShapeIndicatorOverlay[]): void;
|
|
6266
|
+
}
|
|
6267
|
+
|
|
6015
6268
|
/** @public */
|
|
6016
6269
|
export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
6017
6270
|
editor: Editor;
|
|
@@ -6108,37 +6361,30 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
6108
6361
|
*/
|
|
6109
6362
|
abstract component(shape: Shape): any;
|
|
6110
6363
|
/**
|
|
6111
|
-
* Get
|
|
6364
|
+
* Get a Path2D (or a richer object with clip/additional paths) for rendering the
|
|
6365
|
+
* shape's indicator on the canvas. Shapes that return `undefined` will not render
|
|
6366
|
+
* an indicator.
|
|
6112
6367
|
*
|
|
6113
|
-
*
|
|
6114
|
-
*
|
|
6115
|
-
*/
|
|
6116
|
-
abstract indicator(shape: Shape): any;
|
|
6117
|
-
/**
|
|
6118
|
-
* Whether to use the legacy React-based indicator rendering.
|
|
6119
|
-
*
|
|
6120
|
-
* Override this to return `false` if your shape implements {@link ShapeUtil.getIndicatorPath}
|
|
6121
|
-
* for canvas-based indicator rendering.
|
|
6368
|
+
* For complex indicators that need clipping (e.g., arrows with labels), return an
|
|
6369
|
+
* object with `path`, `clipPath`, and `additionalPaths` properties.
|
|
6122
6370
|
*
|
|
6123
|
-
* @
|
|
6371
|
+
* @param shape - The shape.
|
|
6372
|
+
* @returns A Path2D to stroke, or an object with clipping info, or undefined to skip.
|
|
6124
6373
|
* @public
|
|
6125
6374
|
*/
|
|
6126
|
-
|
|
6375
|
+
abstract getIndicatorPath(shape: Shape): TLIndicatorPath | undefined;
|
|
6127
6376
|
/**
|
|
6128
|
-
* Get
|
|
6129
|
-
*
|
|
6130
|
-
* When implemented, this is used instead of {@link ShapeUtil.indicator} for more
|
|
6131
|
-
* efficient canvas-based indicator rendering. Shapes that return `undefined` will
|
|
6132
|
-
* fall back to SVG-based rendering via {@link ShapeUtil.indicator}.
|
|
6377
|
+
* Get JSX describing the shape's indicator (as an SVG element).
|
|
6133
6378
|
*
|
|
6134
|
-
*
|
|
6135
|
-
*
|
|
6379
|
+
* @deprecated SVG indicators are no longer rendered. Override
|
|
6380
|
+
* {@link ShapeUtil.getIndicatorPath} instead. This stub is retained so legacy
|
|
6381
|
+
* subclasses that still call `super.indicator()` keep type-checking; new shapes
|
|
6382
|
+
* should not implement it.
|
|
6136
6383
|
*
|
|
6137
6384
|
* @param shape - The shape.
|
|
6138
|
-
* @returns A Path2D to stroke, or an object with clipping info, or undefined to use SVG fallback.
|
|
6139
6385
|
* @public
|
|
6140
6386
|
*/
|
|
6141
|
-
|
|
6387
|
+
indicator(_shape: Shape): any;
|
|
6142
6388
|
/**
|
|
6143
6389
|
* Get the font faces that should be rendered in the document in order for this shape to render
|
|
6144
6390
|
* correctly.
|
|
@@ -6905,6 +7151,19 @@ export declare const stopEventPropagation: (e: any) => any;
|
|
|
6905
7151
|
|
|
6906
7152
|
/* Excluded from this release type: StoreName */
|
|
6907
7153
|
|
|
7154
|
+
/**
|
|
7155
|
+
* Combine every batchable shape indicator into a single page-space `Path2D` and
|
|
7156
|
+
* emit one stroke call. Shapes whose indicator needs an evenodd clip (e.g.
|
|
7157
|
+
* arrows with labels or complex arrowheads) can't be batched — they still
|
|
7158
|
+
* stroke individually inside a save/restore with `ctx.clip` applied.
|
|
7159
|
+
*
|
|
7160
|
+
* Shared by {@link ShapeIndicatorOverlayUtil} and any overlay util that paints
|
|
7161
|
+
* shape indicators (e.g. collaborator selections).
|
|
7162
|
+
*
|
|
7163
|
+
* @public
|
|
7164
|
+
*/
|
|
7165
|
+
export declare function strokeShapeIndicators(editor: Editor, ctx: CanvasRenderingContext2D, shapeIds: TLShapeId[]): void;
|
|
7166
|
+
|
|
6908
7167
|
/** @public */
|
|
6909
7168
|
export declare function suffixSafeId(id: SafeId, suffix: string): SafeId;
|
|
6910
7169
|
|
|
@@ -7079,6 +7338,9 @@ export declare type TLAnyAssetUtilConstructor = TLAssetUtilConstructor<any>;
|
|
|
7079
7338
|
/** @public */
|
|
7080
7339
|
export declare type TLAnyBindingUtilConstructor = TLBindingUtilConstructor<any>;
|
|
7081
7340
|
|
|
7341
|
+
/** @public */
|
|
7342
|
+
export declare type TLAnyOverlayUtilConstructor = TLOverlayUtilConstructor<any>;
|
|
7343
|
+
|
|
7082
7344
|
/** @public */
|
|
7083
7345
|
export declare type TLAnyShapeUtilConstructor = TLShapeUtilConstructor<any>;
|
|
7084
7346
|
|
|
@@ -7122,15 +7384,6 @@ export declare interface TLBindingUtilConstructor<T extends TLBinding, U extends
|
|
|
7122
7384
|
migrations?: TLPropsMigrations;
|
|
7123
7385
|
}
|
|
7124
7386
|
|
|
7125
|
-
/** @public */
|
|
7126
|
-
export declare interface TLBrushProps {
|
|
7127
|
-
userId?: string;
|
|
7128
|
-
brush: BoxModel;
|
|
7129
|
-
color?: string;
|
|
7130
|
-
opacity?: number;
|
|
7131
|
-
className?: string;
|
|
7132
|
-
}
|
|
7133
|
-
|
|
7134
7387
|
/** @public */
|
|
7135
7388
|
export declare interface TLCameraConstraints {
|
|
7136
7389
|
/** The bounds (in page space) of the constrained space */
|
|
@@ -7318,17 +7571,6 @@ export declare interface TLClipboardWriteInfo {
|
|
|
7318
7571
|
readonly source: 'menu' | 'native';
|
|
7319
7572
|
}
|
|
7320
7573
|
|
|
7321
|
-
/** @public */
|
|
7322
|
-
export declare interface TLCollaboratorHintProps {
|
|
7323
|
-
userId: string;
|
|
7324
|
-
className?: string;
|
|
7325
|
-
point: VecModel;
|
|
7326
|
-
viewport: Box;
|
|
7327
|
-
zoom: number;
|
|
7328
|
-
opacity?: number;
|
|
7329
|
-
color: string;
|
|
7330
|
-
}
|
|
7331
|
-
|
|
7332
7574
|
/** @public */
|
|
7333
7575
|
export declare type TLCompleteEvent = (info: TLCompleteEventInfo) => void;
|
|
7334
7576
|
|
|
@@ -7373,17 +7615,6 @@ export declare interface TLCurrentUser {
|
|
|
7373
7615
|
readonly setUserPreferences: (userPreferences: TLUserPreferences) => void;
|
|
7374
7616
|
}
|
|
7375
7617
|
|
|
7376
|
-
/** @public */
|
|
7377
|
-
export declare interface TLCursorProps {
|
|
7378
|
-
userId: string;
|
|
7379
|
-
className?: string;
|
|
7380
|
-
point: null | VecModel;
|
|
7381
|
-
zoom: number;
|
|
7382
|
-
color?: string;
|
|
7383
|
-
name: null | string;
|
|
7384
|
-
chatMessage: string;
|
|
7385
|
-
}
|
|
7386
|
-
|
|
7387
7618
|
/** @public */
|
|
7388
7619
|
export declare type TLDeepLink = {
|
|
7389
7620
|
bounds: BoxModel;
|
|
@@ -7477,6 +7708,10 @@ export declare interface TldrawEditorBaseProps {
|
|
|
7477
7708
|
* An array of asset utils to use in the editor.
|
|
7478
7709
|
*/
|
|
7479
7710
|
assetUtils?: readonly TLAnyAssetUtilConstructor[];
|
|
7711
|
+
/**
|
|
7712
|
+
* An array of overlay utils to use in the editor for canvas overlay UI elements.
|
|
7713
|
+
*/
|
|
7714
|
+
overlayUtils?: readonly TLAnyOverlayUtilConstructor[];
|
|
7480
7715
|
/**
|
|
7481
7716
|
* An array of tools to add to the editor's state chart.
|
|
7482
7717
|
*/
|
|
@@ -7786,12 +8021,6 @@ export declare interface TldrawOptions {
|
|
|
7786
8021
|
* viewport's page dimensions regardless of overview zoom changes.
|
|
7787
8022
|
*/
|
|
7788
8023
|
readonly quickZoomPreservesScreenBounds: boolean;
|
|
7789
|
-
/**
|
|
7790
|
-
* Whether to use 2D canvas rendering for shape indicators. When true (default),
|
|
7791
|
-
* shapes that support it will render indicators on a 2D canvas for better
|
|
7792
|
-
* performance. When false, all indicators use legacy SVG rendering.
|
|
7793
|
-
*/
|
|
7794
|
-
readonly useCanvasIndicators: boolean;
|
|
7795
8024
|
/**
|
|
7796
8025
|
* Called before content is written to the clipboard during a copy or cut operation.
|
|
7797
8026
|
* Receives the serialized content (shapes, bindings, assets) and can filter or transform
|
|
@@ -7879,34 +8108,17 @@ export declare interface TLDropShapesOverInfo {
|
|
|
7879
8108
|
/** @public */
|
|
7880
8109
|
export declare interface TLEditorComponents {
|
|
7881
8110
|
Background?: ComponentType | null;
|
|
7882
|
-
Brush?: ComponentType<TLBrushProps> | null;
|
|
7883
8111
|
Canvas?: ComponentType<TLCanvasComponentProps> | null;
|
|
7884
|
-
CollaboratorBrush?: ComponentType<TLBrushProps> | null;
|
|
7885
|
-
CollaboratorCursor?: ComponentType<TLCursorProps> | null;
|
|
7886
|
-
CollaboratorHint?: ComponentType<TLCollaboratorHintProps> | null;
|
|
7887
|
-
CollaboratorScribble?: ComponentType<TLScribbleProps> | null;
|
|
7888
|
-
CollaboratorShapeIndicator?: ComponentType<TLShapeIndicatorProps> | null;
|
|
7889
|
-
Cursor?: ComponentType<TLCursorProps> | null;
|
|
7890
8112
|
Grid?: ComponentType<TLGridProps> | null;
|
|
7891
|
-
Handle?: ComponentType<TLHandleProps> | null;
|
|
7892
|
-
Handles?: ComponentType<TLHandlesProps> | null;
|
|
7893
8113
|
InFrontOfTheCanvas?: ComponentType | null;
|
|
7894
8114
|
LoadingScreen?: ComponentType | null;
|
|
7895
8115
|
OnTheCanvas?: ComponentType | null;
|
|
7896
|
-
Overlays?: ComponentType | null;
|
|
7897
|
-
Scribble?: ComponentType<TLScribbleProps> | null;
|
|
7898
8116
|
SelectionBackground?: ComponentType<TLSelectionBackgroundProps> | null;
|
|
7899
|
-
SelectionForeground?: ComponentType<TLSelectionForegroundProps> | null;
|
|
7900
|
-
ShapeIndicator?: ComponentType<TLShapeIndicatorProps> | null;
|
|
7901
|
-
ShapeIndicators?: ComponentType | null;
|
|
7902
8117
|
ShapeWrapper?: ComponentType<TLShapeWrapperProps & RefAttributes<HTMLDivElement>> | null;
|
|
7903
|
-
SnapIndicator?: ComponentType<TLSnapIndicatorProps> | null;
|
|
7904
8118
|
Spinner?: ComponentType<React.SVGProps<SVGSVGElement>> | null;
|
|
7905
8119
|
SvgDefs?: ComponentType | null;
|
|
7906
|
-
ZoomBrush?: ComponentType<TLBrushProps> | null;
|
|
7907
8120
|
ErrorFallback?: TLErrorFallbackComponent;
|
|
7908
8121
|
ShapeErrorFallback?: TLShapeErrorFallbackComponent;
|
|
7909
|
-
ShapeIndicatorErrorFallback?: TLShapeIndicatorErrorFallbackComponent;
|
|
7910
8122
|
}
|
|
7911
8123
|
|
|
7912
8124
|
/** @public */
|
|
@@ -7928,6 +8140,11 @@ export declare interface TLEditorOptions {
|
|
|
7928
8140
|
* An array of asset utils to use in the editor. These will be used to handle asset-type-specific behavior.
|
|
7929
8141
|
*/
|
|
7930
8142
|
assetUtils?: readonly TLAnyAssetUtilConstructor[];
|
|
8143
|
+
/**
|
|
8144
|
+
* An array of overlay utils to use in the editor. These define canvas overlay UI elements
|
|
8145
|
+
* like selection handles, rotation corners, shape handles, etc.
|
|
8146
|
+
*/
|
|
8147
|
+
overlayUtils?: readonly TLAnyOverlayUtilConstructor[];
|
|
7931
8148
|
/**
|
|
7932
8149
|
* An array of tools to use in the editor. These will be used to handle events and manage user interactions in the editor.
|
|
7933
8150
|
*/
|
|
@@ -8294,20 +8511,6 @@ export declare interface TLHandleDragInfo<T extends TLShape> {
|
|
|
8294
8511
|
initial?: T | undefined;
|
|
8295
8512
|
}
|
|
8296
8513
|
|
|
8297
|
-
/** @public */
|
|
8298
|
-
export declare interface TLHandleProps {
|
|
8299
|
-
shapeId: TLShapeId;
|
|
8300
|
-
handle: TLHandle;
|
|
8301
|
-
zoom: number;
|
|
8302
|
-
isCoarse: boolean;
|
|
8303
|
-
className?: string;
|
|
8304
|
-
}
|
|
8305
|
-
|
|
8306
|
-
/** @public */
|
|
8307
|
-
export declare interface TLHandlesProps {
|
|
8308
|
-
children: ReactNode;
|
|
8309
|
-
}
|
|
8310
|
-
|
|
8311
8514
|
/** @public */
|
|
8312
8515
|
export declare interface TLHistoryBatchOptions {
|
|
8313
8516
|
/**
|
|
@@ -8637,6 +8840,42 @@ export declare const tlmenus: {
|
|
|
8637
8840
|
*/
|
|
8638
8841
|
export declare type TLOnMountHandler = (editor: Editor) => (() => undefined | void) | undefined | void;
|
|
8639
8842
|
|
|
8843
|
+
/** @public */
|
|
8844
|
+
export declare interface TLOverlay<Props = Record<string, unknown>> {
|
|
8845
|
+
/**
|
|
8846
|
+
* Globally unique id for this overlay instance across all overlay utils.
|
|
8847
|
+
* Hit-test and hover lookup key on `id` alone, so utils must namespace their
|
|
8848
|
+
* ids (e.g. `'selection_fg:top_left'`, `'handle:<shapeId>:<handleId>'`) to
|
|
8849
|
+
* avoid colliding with overlays from other utils.
|
|
8850
|
+
*/
|
|
8851
|
+
id: string;
|
|
8852
|
+
/** The overlay util type that owns this instance */
|
|
8853
|
+
type: string;
|
|
8854
|
+
/** Arbitrary props for the overlay (handle id, corner name, etc.) */
|
|
8855
|
+
props: Props;
|
|
8856
|
+
}
|
|
8857
|
+
|
|
8858
|
+
/**
|
|
8859
|
+
* An active overlay util paired with the overlays it produced for the current
|
|
8860
|
+
* editor state. Returned by {@link OverlayManager.getActiveOverlayEntries} so
|
|
8861
|
+
* hit-test, render, and debug paths share a single scan per reactive tick.
|
|
8862
|
+
*
|
|
8863
|
+
* @public
|
|
8864
|
+
*/
|
|
8865
|
+
export declare interface TLOverlayEntry {
|
|
8866
|
+
util: OverlayUtil;
|
|
8867
|
+
overlays: TLOverlay[];
|
|
8868
|
+
}
|
|
8869
|
+
|
|
8870
|
+
/** @public */
|
|
8871
|
+
export declare interface TLOverlayUtilConstructor<U extends OverlayUtil = OverlayUtil> {
|
|
8872
|
+
new (editor: Editor): U;
|
|
8873
|
+
type: string;
|
|
8874
|
+
configure<T extends TLOverlayUtilConstructor<any>>(this: T, options: T extends new (...args: any[]) => {
|
|
8875
|
+
options: infer Options;
|
|
8876
|
+
} ? Partial<Options> : never): T;
|
|
8877
|
+
}
|
|
8878
|
+
|
|
8640
8879
|
/**
|
|
8641
8880
|
* Map of all performance event names to their payload types.
|
|
8642
8881
|
* Used with {@link PerformanceManager.on} and {@link PerformanceManager.once}.
|
|
@@ -8764,6 +9003,10 @@ export declare type TLPointerEventTarget = {
|
|
|
8764
9003
|
handle?: TLSelectionHandle;
|
|
8765
9004
|
shape?: undefined;
|
|
8766
9005
|
target: 'selection';
|
|
9006
|
+
} | {
|
|
9007
|
+
overlay: TLOverlay;
|
|
9008
|
+
shape?: undefined;
|
|
9009
|
+
target: 'overlay';
|
|
8767
9010
|
} | {
|
|
8768
9011
|
shape: TLShape;
|
|
8769
9012
|
target: 'shape';
|
|
@@ -8834,28 +9077,12 @@ export declare type TLResizeShapeOptions = Partial<{
|
|
|
8834
9077
|
|
|
8835
9078
|
/* Excluded from this release type: TLRotationSnapshot */
|
|
8836
9079
|
|
|
8837
|
-
/** @public */
|
|
8838
|
-
export declare interface TLScribbleProps {
|
|
8839
|
-
userId?: string;
|
|
8840
|
-
scribble: TLScribble;
|
|
8841
|
-
zoom: number;
|
|
8842
|
-
color?: string;
|
|
8843
|
-
opacity?: number;
|
|
8844
|
-
className?: string;
|
|
8845
|
-
}
|
|
8846
|
-
|
|
8847
9080
|
/** @public */
|
|
8848
9081
|
export declare interface TLSelectionBackgroundProps {
|
|
8849
9082
|
bounds: Box;
|
|
8850
9083
|
rotation: number;
|
|
8851
9084
|
}
|
|
8852
9085
|
|
|
8853
|
-
/** @public */
|
|
8854
|
-
export declare interface TLSelectionForegroundProps {
|
|
8855
|
-
bounds: Box;
|
|
8856
|
-
rotation: number;
|
|
8857
|
-
}
|
|
8858
|
-
|
|
8859
9086
|
/** @public */
|
|
8860
9087
|
export declare type TLSelectionHandle = RotateCorner | SelectionCorner | SelectionEdge;
|
|
8861
9088
|
|
|
@@ -8890,26 +9117,11 @@ export declare type TLShapeErrorFallbackComponent = ComponentType<{
|
|
|
8890
9117
|
}>;
|
|
8891
9118
|
|
|
8892
9119
|
/** @public */
|
|
8893
|
-
export declare
|
|
8894
|
-
|
|
8895
|
-
|
|
8896
|
-
|
|
8897
|
-
|
|
8898
|
-
export declare interface TLShapeIndicatorProps {
|
|
8899
|
-
userId?: string;
|
|
8900
|
-
shapeId: TLShapeId;
|
|
8901
|
-
color?: string | undefined;
|
|
8902
|
-
opacity?: number;
|
|
8903
|
-
className?: string;
|
|
8904
|
-
hidden?: boolean;
|
|
8905
|
-
}
|
|
8906
|
-
|
|
8907
|
-
/** @public */
|
|
8908
|
-
export declare interface TLShapeIndicatorsProps {
|
|
8909
|
-
/** Whether to hide all of the indicators */
|
|
8910
|
-
hideAll?: boolean;
|
|
8911
|
-
/** Whether to show all of the indicators */
|
|
8912
|
-
showAll?: boolean;
|
|
9120
|
+
export declare interface TLShapeIndicatorOverlay extends TLOverlay {
|
|
9121
|
+
props: {
|
|
9122
|
+
hintingShapeIds: TLShapeId[];
|
|
9123
|
+
idsToDisplay: TLShapeId[];
|
|
9124
|
+
};
|
|
8913
9125
|
}
|
|
8914
9126
|
|
|
8915
9127
|
/**
|
|
@@ -8997,13 +9209,6 @@ export declare interface TLShapeWrapperProps extends React.HTMLAttributes<HTMLDi
|
|
|
8997
9209
|
children: ReactNode;
|
|
8998
9210
|
}
|
|
8999
9211
|
|
|
9000
|
-
/** @public */
|
|
9001
|
-
export declare interface TLSnapIndicatorProps {
|
|
9002
|
-
className?: string;
|
|
9003
|
-
line: SnapIndicator;
|
|
9004
|
-
zoom: number;
|
|
9005
|
-
}
|
|
9006
|
-
|
|
9007
9212
|
/** @public */
|
|
9008
9213
|
export declare interface TLStateNodeConstructor {
|
|
9009
9214
|
new (editor: Editor, parent?: StateNode): StateNode;
|
|
@@ -9392,6 +9597,10 @@ export declare function usePassThroughMouseOverEvents(ref: RefObject<HTMLElement
|
|
|
9392
9597
|
export declare function usePassThroughWheelEvents(ref: RefObject<HTMLElement | null>): void;
|
|
9393
9598
|
|
|
9394
9599
|
/**
|
|
9600
|
+
* Reactive list of peer user IDs for collaborators currently shown in the UI.
|
|
9601
|
+
* Mirrors {@link Editor.getVisibleCollaborators} — peers fade out as they
|
|
9602
|
+
* transition to idle/inactive, without requiring a manual re-render.
|
|
9603
|
+
*
|
|
9395
9604
|
* @returns The list of peer UserIDs
|
|
9396
9605
|
* @public
|
|
9397
9606
|
*/
|