@tldraw/editor 4.6.0-canary.e3e961872cdb → 4.6.0-canary.e4eb89eee45f
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 +1129 -258
- package/dist-cjs/index.js +27 -23
- package/dist-cjs/index.js.map +3 -3
- package/dist-cjs/lib/TldrawEditor.js +58 -12
- package/dist-cjs/lib/TldrawEditor.js.map +3 -3
- package/dist-cjs/lib/components/MenuClickCapture.js +99 -38
- package/dist-cjs/lib/components/MenuClickCapture.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 +33 -236
- package/dist-cjs/lib/components/default-components/DefaultCanvas.js.map +3 -3
- package/dist-cjs/lib/config/createTLStore.js +7 -0
- package/dist-cjs/lib/config/createTLStore.js.map +2 -2
- package/dist-cjs/lib/{components/default-components/DefaultShapeIndicatorErrorFallback.js → config/defaultAssets.js} +17 -9
- package/dist-cjs/lib/config/defaultAssets.js.map +7 -0
- package/dist-cjs/lib/editor/Editor.js +361 -38
- package/dist-cjs/lib/editor/Editor.js.map +2 -2
- package/dist-cjs/lib/editor/assets/AssetUtil.js +67 -0
- package/dist-cjs/lib/editor/assets/AssetUtil.js.map +7 -0
- package/dist-cjs/lib/editor/bindings/BindingUtil.js +1 -0
- package/dist-cjs/lib/editor/bindings/BindingUtil.js.map +1 -1
- package/dist-cjs/lib/editor/managers/ClickManager/ClickManager.js +1 -0
- package/dist-cjs/lib/editor/managers/ClickManager/ClickManager.js.map +1 -1
- 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/EdgeScrollManager/EdgeScrollManager.js +1 -0
- package/dist-cjs/lib/editor/managers/EdgeScrollManager/EdgeScrollManager.js.map +1 -1
- package/dist-cjs/lib/editor/managers/FocusManager/FocusManager.js +1 -0
- package/dist-cjs/lib/editor/managers/FocusManager/FocusManager.js.map +1 -1
- package/dist-cjs/lib/editor/managers/FontManager/FontManager.js +2 -0
- package/dist-cjs/lib/editor/managers/FontManager/FontManager.js.map +2 -2
- package/dist-cjs/lib/editor/managers/HistoryManager/HistoryManager.js +2 -0
- package/dist-cjs/lib/editor/managers/HistoryManager/HistoryManager.js.map +1 -1
- package/dist-cjs/lib/editor/managers/InputsManager/InputsManager.js +12 -0
- package/dist-cjs/lib/editor/managers/InputsManager/InputsManager.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/{components/default-components/DefaultHandles.js → editor/managers/PerformanceManager/perf-types.js} +3 -14
- package/dist-cjs/lib/editor/managers/PerformanceManager/perf-types.js.map +7 -0
- package/dist-cjs/lib/editor/managers/ScribbleManager/ScribbleManager.js +1 -0
- package/dist-cjs/lib/editor/managers/ScribbleManager/ScribbleManager.js.map +1 -1
- package/dist-cjs/lib/editor/managers/SnapManager/BoundsSnaps.js +1 -0
- package/dist-cjs/lib/editor/managers/SnapManager/BoundsSnaps.js.map +1 -1
- package/dist-cjs/lib/editor/managers/SnapManager/HandleSnaps.js +1 -0
- package/dist-cjs/lib/editor/managers/SnapManager/HandleSnaps.js.map +1 -1
- package/dist-cjs/lib/editor/managers/SnapManager/SnapManager.js +2 -1
- package/dist-cjs/lib/editor/managers/SnapManager/SnapManager.js.map +2 -2
- package/dist-cjs/lib/editor/managers/SpatialIndexManager/SpatialIndexManager.js +1 -0
- package/dist-cjs/lib/editor/managers/SpatialIndexManager/SpatialIndexManager.js.map +1 -1
- package/dist-cjs/lib/editor/managers/TextManager/TextManager.js +1 -0
- package/dist-cjs/lib/editor/managers/TextManager/TextManager.js.map +1 -1
- package/dist-cjs/lib/editor/managers/ThemeManager/ThemeManager.js +107 -0
- package/dist-cjs/lib/editor/managers/ThemeManager/ThemeManager.js.map +7 -0
- package/dist-cjs/lib/editor/managers/ThemeManager/defaultThemes.js +600 -0
- package/dist-cjs/lib/editor/managers/ThemeManager/defaultThemes.js.map +7 -0
- package/dist-cjs/lib/editor/managers/TickManager/TickManager.js +1 -0
- package/dist-cjs/lib/editor/managers/TickManager/TickManager.js.map +1 -1
- package/dist-cjs/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.js +8 -4
- package/dist-cjs/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.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 +76 -0
- package/dist-cjs/lib/editor/shapes/BaseFrameLikeShapeUtil.js.map +7 -0
- package/dist-cjs/lib/editor/shapes/ShapeUtil.js +25 -20
- package/dist-cjs/lib/editor/shapes/ShapeUtil.js.map +2 -2
- package/dist-cjs/lib/editor/shapes/group/GroupShapeUtil.js +33 -3
- 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 +15 -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/event-types.js.map +2 -2
- package/dist-cjs/lib/editor/types/external-content.js.map +1 -1
- package/dist-cjs/lib/exports/ExportDelay.js +1 -0
- package/dist-cjs/lib/exports/ExportDelay.js.map +1 -1
- package/dist-cjs/lib/exports/StyleEmbedder.js +1 -0
- package/dist-cjs/lib/exports/StyleEmbedder.js.map +1 -1
- package/dist-cjs/lib/exports/fetchCache.js +1 -1
- package/dist-cjs/lib/exports/fetchCache.js.map +2 -2
- package/dist-cjs/lib/exports/getSvgJsx.js +14 -8
- 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/EditorComponentsContext.js.map +2 -2
- package/dist-cjs/lib/hooks/useCanvasEvents.js +25 -4
- package/dist-cjs/lib/hooks/useCanvasEvents.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/useEditorComponents.js +0 -28
- package/dist-cjs/lib/hooks/useEditorComponents.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/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 +1 -0
- package/dist-cjs/lib/options.js.map +2 -2
- package/dist-cjs/lib/primitives/Vec.js +3 -0
- package/dist-cjs/lib/primitives/Vec.js.map +1 -1
- package/dist-cjs/lib/primitives/geometry/Circle2d.js +1 -0
- package/dist-cjs/lib/primitives/geometry/Circle2d.js.map +1 -1
- package/dist-cjs/lib/primitives/geometry/Ellipse2d.js +1 -0
- package/dist-cjs/lib/primitives/geometry/Ellipse2d.js.map +1 -1
- package/dist-cjs/lib/primitives/geometry/Geometry2d.js +2 -0
- package/dist-cjs/lib/primitives/geometry/Geometry2d.js.map +1 -1
- package/dist-cjs/lib/primitives/geometry/Stadium2d.js +1 -0
- package/dist-cjs/lib/primitives/geometry/Stadium2d.js.map +1 -1
- package/dist-cjs/lib/utils/EditorAtom.js +2 -0
- package/dist-cjs/lib/utils/EditorAtom.js.map +1 -1
- 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/TLLocalSyncClient.js +5 -0
- package/dist-cjs/lib/utils/sync/TLLocalSyncClient.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 +1129 -258
- package/dist-esm/index.mjs +33 -44
- package/dist-esm/index.mjs.map +2 -2
- package/dist-esm/lib/TldrawEditor.mjs +61 -12
- package/dist-esm/lib/TldrawEditor.mjs.map +3 -3
- package/dist-esm/lib/components/MenuClickCapture.mjs +100 -39
- package/dist-esm/lib/components/MenuClickCapture.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 +34 -237
- package/dist-esm/lib/components/default-components/DefaultCanvas.mjs.map +3 -3
- package/dist-esm/lib/config/createTLStore.mjs +10 -1
- package/dist-esm/lib/config/createTLStore.mjs.map +2 -2
- package/dist-esm/lib/config/defaultAssets.mjs +16 -0
- package/dist-esm/lib/config/defaultAssets.mjs.map +7 -0
- package/dist-esm/lib/editor/Editor.mjs +361 -39
- package/dist-esm/lib/editor/Editor.mjs.map +2 -2
- package/dist-esm/lib/editor/assets/AssetUtil.mjs +47 -0
- package/dist-esm/lib/editor/assets/AssetUtil.mjs.map +7 -0
- package/dist-esm/lib/editor/bindings/BindingUtil.mjs +1 -0
- package/dist-esm/lib/editor/bindings/BindingUtil.mjs.map +1 -1
- package/dist-esm/lib/editor/managers/ClickManager/ClickManager.mjs +1 -0
- package/dist-esm/lib/editor/managers/ClickManager/ClickManager.mjs.map +1 -1
- 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/EdgeScrollManager/EdgeScrollManager.mjs +1 -0
- package/dist-esm/lib/editor/managers/EdgeScrollManager/EdgeScrollManager.mjs.map +1 -1
- package/dist-esm/lib/editor/managers/FocusManager/FocusManager.mjs +1 -0
- package/dist-esm/lib/editor/managers/FocusManager/FocusManager.mjs.map +1 -1
- package/dist-esm/lib/editor/managers/FontManager/FontManager.mjs +2 -0
- package/dist-esm/lib/editor/managers/FontManager/FontManager.mjs.map +2 -2
- package/dist-esm/lib/editor/managers/HistoryManager/HistoryManager.mjs +2 -0
- package/dist-esm/lib/editor/managers/HistoryManager/HistoryManager.mjs.map +1 -1
- package/dist-esm/lib/editor/managers/InputsManager/InputsManager.mjs +12 -0
- package/dist-esm/lib/editor/managers/InputsManager/InputsManager.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/ScribbleManager/ScribbleManager.mjs +1 -0
- package/dist-esm/lib/editor/managers/ScribbleManager/ScribbleManager.mjs.map +1 -1
- package/dist-esm/lib/editor/managers/SnapManager/BoundsSnaps.mjs +1 -0
- package/dist-esm/lib/editor/managers/SnapManager/BoundsSnaps.mjs.map +1 -1
- package/dist-esm/lib/editor/managers/SnapManager/HandleSnaps.mjs +1 -0
- package/dist-esm/lib/editor/managers/SnapManager/HandleSnaps.mjs.map +1 -1
- package/dist-esm/lib/editor/managers/SnapManager/SnapManager.mjs +2 -1
- package/dist-esm/lib/editor/managers/SnapManager/SnapManager.mjs.map +2 -2
- package/dist-esm/lib/editor/managers/SpatialIndexManager/SpatialIndexManager.mjs +1 -0
- package/dist-esm/lib/editor/managers/SpatialIndexManager/SpatialIndexManager.mjs.map +1 -1
- package/dist-esm/lib/editor/managers/TextManager/TextManager.mjs +1 -0
- package/dist-esm/lib/editor/managers/TextManager/TextManager.mjs.map +1 -1
- package/dist-esm/lib/editor/managers/ThemeManager/ThemeManager.mjs +89 -0
- package/dist-esm/lib/editor/managers/ThemeManager/ThemeManager.mjs.map +7 -0
- package/dist-esm/lib/editor/managers/ThemeManager/defaultThemes.mjs +582 -0
- package/dist-esm/lib/editor/managers/ThemeManager/defaultThemes.mjs.map +7 -0
- package/dist-esm/lib/editor/managers/TickManager/TickManager.mjs +1 -0
- package/dist-esm/lib/editor/managers/TickManager/TickManager.mjs.map +1 -1
- package/dist-esm/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.mjs +8 -4
- package/dist-esm/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.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 +56 -0
- package/dist-esm/lib/editor/shapes/BaseFrameLikeShapeUtil.mjs.map +7 -0
- package/dist-esm/lib/editor/shapes/ShapeUtil.mjs +25 -20
- package/dist-esm/lib/editor/shapes/ShapeUtil.mjs.map +2 -2
- package/dist-esm/lib/editor/shapes/group/GroupShapeUtil.mjs +33 -3
- 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 +15 -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/editor/types/event-types.mjs.map +2 -2
- package/dist-esm/lib/exports/ExportDelay.mjs +1 -0
- package/dist-esm/lib/exports/ExportDelay.mjs.map +1 -1
- package/dist-esm/lib/exports/StyleEmbedder.mjs +1 -0
- package/dist-esm/lib/exports/StyleEmbedder.mjs.map +1 -1
- package/dist-esm/lib/exports/fetchCache.mjs +2 -2
- package/dist-esm/lib/exports/fetchCache.mjs.map +2 -2
- package/dist-esm/lib/exports/getSvgJsx.mjs +14 -11
- 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/EditorComponentsContext.mjs.map +2 -2
- package/dist-esm/lib/hooks/useCanvasEvents.mjs +25 -4
- package/dist-esm/lib/hooks/useCanvasEvents.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/useEditorComponents.mjs +0 -28
- package/dist-esm/lib/hooks/useEditorComponents.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/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 +1 -0
- package/dist-esm/lib/options.mjs.map +2 -2
- package/dist-esm/lib/primitives/Vec.mjs +3 -0
- package/dist-esm/lib/primitives/Vec.mjs.map +1 -1
- package/dist-esm/lib/primitives/geometry/Circle2d.mjs +1 -0
- package/dist-esm/lib/primitives/geometry/Circle2d.mjs.map +1 -1
- package/dist-esm/lib/primitives/geometry/Ellipse2d.mjs +1 -0
- package/dist-esm/lib/primitives/geometry/Ellipse2d.mjs.map +1 -1
- package/dist-esm/lib/primitives/geometry/Geometry2d.mjs +2 -0
- package/dist-esm/lib/primitives/geometry/Geometry2d.mjs.map +1 -1
- package/dist-esm/lib/primitives/geometry/Stadium2d.mjs +1 -0
- package/dist-esm/lib/primitives/geometry/Stadium2d.mjs.map +1 -1
- package/dist-esm/lib/utils/EditorAtom.mjs +2 -0
- package/dist-esm/lib/utils/EditorAtom.mjs.map +1 -1
- 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/TLLocalSyncClient.mjs +5 -0
- package/dist-esm/lib/utils/sync/TLLocalSyncClient.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 +3 -256
- package/package.json +8 -9
- package/src/index.ts +37 -44
- package/src/lib/TldrawEditor.tsx +99 -13
- package/src/lib/components/MenuClickCapture.tsx +129 -49
- package/src/lib/components/default-components/CanvasOverlays.tsx +208 -0
- package/src/lib/components/default-components/DefaultCanvas.tsx +38 -310
- package/src/lib/config/createTLStore.ts +22 -1
- package/src/lib/config/defaultAssets.ts +19 -0
- package/src/lib/editor/Editor.test.ts +3 -1
- package/src/lib/editor/Editor.ts +473 -64
- package/src/lib/editor/assets/AssetUtil.ts +85 -0
- package/src/lib/editor/managers/CollaboratorsManager/CollaboratorsManager.ts +98 -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/InputsManager/InputsManager.ts +12 -0
- 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/SnapManager/SnapManager.test.ts +13 -2
- package/src/lib/editor/managers/SnapManager/SnapManager.ts +1 -1
- package/src/lib/editor/managers/ThemeManager/ThemeManager.ts +116 -0
- package/src/lib/editor/managers/ThemeManager/defaultThemes.ts +619 -0
- package/src/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.test.ts +24 -30
- package/src/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.ts +6 -4
- 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 +123 -0
- package/src/lib/editor/shapes/ShapeUtil.ts +54 -28
- package/src/lib/editor/shapes/group/GroupShapeUtil.tsx +41 -4
- 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/event-types.ts +2 -0
- package/src/lib/editor/types/external-content.ts +1 -0
- package/src/lib/exports/fetchCache.ts +2 -4
- package/src/lib/exports/getSvgJsx.test.ts +3 -1
- package/src/lib/exports/getSvgJsx.tsx +23 -16
- package/src/lib/globals/environment.ts +18 -0
- package/src/lib/hooks/EditorComponentsContext.tsx +0 -27
- package/src/lib/hooks/useCanvasEvents.ts +40 -3
- 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/useEditorComponents.tsx +0 -28
- package/src/lib/hooks/useGestureEvents.ts +240 -168
- package/src/lib/hooks/usePeerIds.ts +6 -55
- package/src/lib/hooks/useShapeCulling.tsx +3 -1
- package/src/lib/options.ts +7 -0
- package/src/lib/utils/reparenting.ts +6 -2
- package/src/lib/utils/richText.ts +1 -1
- package/src/lib/utils/runtime.ts +3 -1
- package/src/lib/utils/sync/TLLocalSyncClient.ts +3 -0
- package/src/lib/utils/sync/hardReset.ts +0 -8
- package/src/version.ts +3 -3
- package/dist-cjs/lib/components/LiveCollaborators.js +0 -151
- package/dist-cjs/lib/components/LiveCollaborators.js.map +0 -7
- package/dist-cjs/lib/components/default-components/CanvasShapeIndicators.js +0 -227
- 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.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.map +0 -7
- package/dist-cjs/lib/components/default-components/DefaultShapeIndicators.js +0 -101
- 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-cjs/lib/hooks/useIsDarkMode.js.map +0 -7
- package/dist-esm/lib/components/LiveCollaborators.mjs +0 -134
- package/dist-esm/lib/components/LiveCollaborators.mjs.map +0 -7
- package/dist-esm/lib/components/default-components/CanvasShapeIndicators.mjs +0 -207
- 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 -81
- 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/dist-esm/lib/hooks/useIsDarkMode.mjs +0 -15
- package/dist-esm/lib/hooks/useIsDarkMode.mjs.map +0 -7
- package/src/lib/components/LiveCollaborators.tsx +0 -174
- package/src/lib/components/default-components/CanvasShapeIndicators.tsx +0 -289
- 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 -116
- 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';
|
|
@@ -57,9 +56,12 @@ import { TLCamera } from '@tldraw/tlschema';
|
|
|
57
56
|
import { TLCreateShapePartial } from '@tldraw/tlschema';
|
|
58
57
|
import { TLCursor } from '@tldraw/tlschema';
|
|
59
58
|
import { TLCursorType } from '@tldraw/tlschema';
|
|
59
|
+
import { TLDefaultColor } from '@tldraw/tlschema';
|
|
60
|
+
import { TLDefaultColorStyle } from '@tldraw/tlschema';
|
|
60
61
|
import { TLDefaultDashStyle } from '@tldraw/tlschema';
|
|
61
62
|
import { TLDefaultHorizontalAlignStyle } from '@tldraw/tlschema';
|
|
62
63
|
import { TLDocument } from '@tldraw/tlschema';
|
|
64
|
+
import { TLFontFace } from '@tldraw/tlschema';
|
|
63
65
|
import { TLGroupShape } from '@tldraw/tlschema';
|
|
64
66
|
import { TLHandle } from '@tldraw/tlschema';
|
|
65
67
|
import { TLImageAsset } from '@tldraw/tlschema';
|
|
@@ -81,6 +83,11 @@ import { TLStore } from '@tldraw/tlschema';
|
|
|
81
83
|
import { TLStoreProps } from '@tldraw/tlschema';
|
|
82
84
|
import { TLStoreSchema } from '@tldraw/tlschema';
|
|
83
85
|
import { TLStoreSnapshot } from '@tldraw/tlschema';
|
|
86
|
+
import { TLTheme } from '@tldraw/tlschema';
|
|
87
|
+
import { TLThemeColors } from '@tldraw/tlschema';
|
|
88
|
+
import { TLThemeId } from '@tldraw/tlschema';
|
|
89
|
+
import { TLThemes } from '@tldraw/tlschema';
|
|
90
|
+
import { TLUnknownAsset } from '@tldraw/tlschema';
|
|
84
91
|
import { TLUnknownBinding } from '@tldraw/tlschema';
|
|
85
92
|
import { TLUnknownShape } from '@tldraw/tlschema';
|
|
86
93
|
import { TLUser } from '@tldraw/tlschema';
|
|
@@ -147,6 +154,51 @@ export declare class Arc2d extends Geometry2d {
|
|
|
147
154
|
*/
|
|
148
155
|
export declare function areAnglesCompatible(a: number, b: number): boolean;
|
|
149
156
|
|
|
157
|
+
/**
|
|
158
|
+
* Abstract base class for defining asset-type-specific behavior.
|
|
159
|
+
*
|
|
160
|
+
* Each asset type (image, video, bookmark, etc.) has a corresponding AssetUtil that handles
|
|
161
|
+
* type-specific operations like determining supported MIME types and creating assets from files.
|
|
162
|
+
*
|
|
163
|
+
* @public
|
|
164
|
+
*/
|
|
165
|
+
export declare abstract class AssetUtil<Asset extends TLAsset = TLAsset> {
|
|
166
|
+
editor: Editor;
|
|
167
|
+
/** Configure this asset util's {@link AssetUtil.options | `options`}. */
|
|
168
|
+
static configure<T extends TLAssetUtilConstructor<any, any>>(this: T, options: T extends new (...args: any[]) => {
|
|
169
|
+
options: infer Options;
|
|
170
|
+
} ? Partial<Options> : never): T;
|
|
171
|
+
constructor(editor: Editor);
|
|
172
|
+
/**
|
|
173
|
+
* Options for this asset util. Override this to provide customization options for your asset.
|
|
174
|
+
* Use {@link AssetUtil.configure} to customize existing asset utils.
|
|
175
|
+
*/
|
|
176
|
+
options: {};
|
|
177
|
+
static props?: RecordProps<TLUnknownAsset>;
|
|
178
|
+
static migrations?: LegacyMigrations | MigrationSequence | TLPropsMigrations;
|
|
179
|
+
/**
|
|
180
|
+
* The type of the asset util, which should match the asset's type.
|
|
181
|
+
*/
|
|
182
|
+
static type: string;
|
|
183
|
+
/**
|
|
184
|
+
* Get the default props for an asset of this type.
|
|
185
|
+
*/
|
|
186
|
+
abstract getDefaultProps(): Asset['props'];
|
|
187
|
+
/**
|
|
188
|
+
* Get the MIME types that this asset type supports.
|
|
189
|
+
* Return an empty array if this asset type doesn't support files (e.g. bookmarks).
|
|
190
|
+
*/
|
|
191
|
+
getSupportedMimeTypes(): readonly string[];
|
|
192
|
+
/**
|
|
193
|
+
* Check whether this asset type accepts a given MIME type.
|
|
194
|
+
*/
|
|
195
|
+
acceptsMimeType(mimeType: string): boolean;
|
|
196
|
+
/**
|
|
197
|
+
* Create an asset from a file. Return null if this asset type can't handle the file.
|
|
198
|
+
*/
|
|
199
|
+
getAssetFromFile(_file: File, _assetId: TLAssetId): Promise<Asset | null>;
|
|
200
|
+
}
|
|
201
|
+
|
|
150
202
|
/** @public */
|
|
151
203
|
export declare function average(A: VecLike, B: VecLike): string;
|
|
152
204
|
|
|
@@ -167,6 +219,56 @@ export declare abstract class BaseBoxShapeUtil<Shape extends TLBaseBoxShape> ext
|
|
|
167
219
|
getInterpolatedProps(startShape: Shape, endShape: Shape, t: number): Shape['props'];
|
|
168
220
|
}
|
|
169
221
|
|
|
222
|
+
/**
|
|
223
|
+
* A base class for frame-like shapes — containers that clip their children,
|
|
224
|
+
* require full-brush selection, block erasure from inside, and support
|
|
225
|
+
* drag-and-drop reparenting.
|
|
226
|
+
*
|
|
227
|
+
* Extending this class is the easiest way to create a custom frame-like shape.
|
|
228
|
+
* It provides sensible defaults for all frame-like behaviors:
|
|
229
|
+
*
|
|
230
|
+
* - `isFrameLike()` returns `true`
|
|
231
|
+
* - `providesBackgroundForChildren()` returns `true`
|
|
232
|
+
* - `canReceiveNewChildrenOfType()` returns `true` unless the container is locked
|
|
233
|
+
* - `getClipPath()` returns the shape geometry's vertices
|
|
234
|
+
* - `onDragShapesIn()` reparents shapes into the frame (with index restoration)
|
|
235
|
+
* - `onDragShapesOut()` reparents shapes back to the page
|
|
236
|
+
*
|
|
237
|
+
* All methods can be overridden for custom behavior.
|
|
238
|
+
*
|
|
239
|
+
* @example
|
|
240
|
+
* ```ts
|
|
241
|
+
* class MyContainerUtil extends BaseFrameLikeShapeUtil<MyContainerShape> {
|
|
242
|
+
* static override type = 'my-container' as const
|
|
243
|
+
* static override props = myContainerShapeProps
|
|
244
|
+
*
|
|
245
|
+
* override getDefaultProps() {
|
|
246
|
+
* return { w: 300, h: 200 }
|
|
247
|
+
* }
|
|
248
|
+
*
|
|
249
|
+
* override component(shape: MyContainerShape) {
|
|
250
|
+
* return <SVGContainer>...</SVGContainer>
|
|
251
|
+
* }
|
|
252
|
+
*
|
|
253
|
+
* override getIndicatorPath(shape: MyContainerShape) {
|
|
254
|
+
* const path = new Path2D()
|
|
255
|
+
* path.rect(0, 0, shape.props.w, shape.props.h)
|
|
256
|
+
* return path
|
|
257
|
+
* }
|
|
258
|
+
* }
|
|
259
|
+
* ```
|
|
260
|
+
*
|
|
261
|
+
* @public
|
|
262
|
+
*/
|
|
263
|
+
export declare abstract class BaseFrameLikeShapeUtil<Shape extends TLBaseBoxShape> extends BaseBoxShapeUtil<Shape> {
|
|
264
|
+
isFrameLike(_shape: Shape): boolean;
|
|
265
|
+
providesBackgroundForChildren(): boolean;
|
|
266
|
+
canReceiveNewChildrenOfType(shape: Shape, _type: TLShape['type']): boolean;
|
|
267
|
+
getClipPath(shape: Shape): undefined | Vec[];
|
|
268
|
+
onDragShapesIn(shape: Shape, draggingShapes: TLShape[], { initialParentIds, initialIndices }: TLDragShapesInInfo): void;
|
|
269
|
+
onDragShapesOut(shape: Shape, draggingShapes: TLShape[], info: TLDragShapesOutInfo): void;
|
|
270
|
+
}
|
|
271
|
+
|
|
170
272
|
/** @public */
|
|
171
273
|
export declare interface BatchMeasurementRequest {
|
|
172
274
|
html: string;
|
|
@@ -666,6 +768,49 @@ export declare class ClickManager {
|
|
|
666
768
|
*/
|
|
667
769
|
export declare function clockwiseAngleDist(a0: number, a1: number): number;
|
|
668
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
|
+
|
|
669
814
|
/**
|
|
670
815
|
* @public
|
|
671
816
|
* @react
|
|
@@ -743,7 +888,7 @@ export declare function createTLSchemaFromUtils(opts: TLStoreSchemaOptions): Sto
|
|
|
743
888
|
*
|
|
744
889
|
* @public
|
|
745
890
|
*/
|
|
746
|
-
export declare function createTLStore({ initialData, defaultName, id, assets, users, onMount, collaboration, ...rest }?: TLStoreOptions): TLStore;
|
|
891
|
+
export declare function createTLStore({ initialData, defaultName, id, assets, users, onMount, collaboration, themes, ...rest }?: TLStoreOptions): TLStore;
|
|
747
892
|
|
|
748
893
|
/** @public */
|
|
749
894
|
export declare class CubicBezier2d extends Polyline2d {
|
|
@@ -818,54 +963,31 @@ export declare interface DebugFlagDefaults<T> {
|
|
|
818
963
|
|
|
819
964
|
/* Excluded from this release type: DEFAULT_CAMERA_OPTIONS */
|
|
820
965
|
|
|
821
|
-
/**
|
|
822
|
-
|
|
966
|
+
/**
|
|
967
|
+
* The default theme definition containing color palettes for both light and dark modes.
|
|
968
|
+
*
|
|
969
|
+
* @public
|
|
970
|
+
*/
|
|
971
|
+
export declare const DEFAULT_THEME: TLTheme;
|
|
823
972
|
|
|
824
973
|
/** @public @react */
|
|
825
|
-
export declare
|
|
974
|
+
export declare function DefaultBackground(): JSX.Element;
|
|
826
975
|
|
|
827
976
|
/** @public @react */
|
|
828
977
|
export declare function DefaultCanvas({ className }: TLCanvasComponentProps): JSX.Element;
|
|
829
978
|
|
|
830
|
-
/** @public @react */
|
|
831
|
-
export declare function DefaultCollaboratorHint({ className, zoom, point, color, viewport, opacity }: TLCollaboratorHintProps): JSX.Element;
|
|
832
|
-
|
|
833
|
-
/** @public @react */
|
|
834
|
-
export declare const DefaultCursor: NamedExoticComponent<TLCursorProps>;
|
|
835
|
-
|
|
836
979
|
/** @public @react */
|
|
837
980
|
export declare const DefaultErrorFallback: TLErrorFallbackComponent;
|
|
838
981
|
|
|
839
982
|
/** @public @react */
|
|
840
983
|
export declare function DefaultGrid({ x, y, z, size }: TLGridProps): JSX.Element;
|
|
841
984
|
|
|
842
|
-
/** @public @react */
|
|
843
|
-
export declare function DefaultHandle({ handle, isCoarse, className, zoom }: TLHandleProps): JSX.Element;
|
|
844
|
-
|
|
845
|
-
/** @public @react */
|
|
846
|
-
export declare const DefaultHandles: ({ children }: TLHandlesProps) => JSX.Element;
|
|
847
|
-
|
|
848
|
-
/** @public @react */
|
|
849
|
-
export declare function DefaultScribble({ scribble, zoom, color, opacity, className }: TLScribbleProps): JSX.Element | null;
|
|
850
|
-
|
|
851
985
|
/** @public @react */
|
|
852
986
|
export declare function DefaultSelectionBackground({ bounds, rotation }: TLSelectionBackgroundProps): JSX.Element;
|
|
853
987
|
|
|
854
|
-
/** @public @react */
|
|
855
|
-
export declare function DefaultSelectionForeground({ bounds, rotation }: TLSelectionForegroundProps): JSX.Element;
|
|
856
|
-
|
|
857
|
-
/** @public @react */
|
|
858
|
-
export declare const DefaultShapeIndicator: NamedExoticComponent<TLShapeIndicatorProps>;
|
|
859
|
-
|
|
860
|
-
/** @public @react */
|
|
861
|
-
export declare const DefaultShapeIndicators: NamedExoticComponent<TLShapeIndicatorsProps>;
|
|
862
|
-
|
|
863
988
|
/** @public @react */
|
|
864
989
|
export declare const DefaultShapeWrapper: ForwardRefExoticComponent<TLShapeWrapperProps & RefAttributes<HTMLDivElement>>;
|
|
865
990
|
|
|
866
|
-
/** @public @react */
|
|
867
|
-
export declare function DefaultSnapIndicator({ className, line, zoom }: TLSnapIndicatorProps): JSX.Element;
|
|
868
|
-
|
|
869
991
|
/** @public @react */
|
|
870
992
|
export declare function DefaultSpinner(props: React.SVGProps<SVGSVGElement>): JSX.Element;
|
|
871
993
|
|
|
@@ -936,6 +1058,7 @@ export declare const defaultTldrawOptions: {
|
|
|
936
1058
|
readonly onBeforePasteFromClipboard: undefined;
|
|
937
1059
|
readonly onClipboardPasteRaw: undefined;
|
|
938
1060
|
readonly quickZoomPreservesScreenBounds: true;
|
|
1061
|
+
readonly rightClickPanning: true;
|
|
939
1062
|
readonly snapThreshold: 8;
|
|
940
1063
|
readonly spacebarPanning: true;
|
|
941
1064
|
readonly temporaryAssetPreviewLifetimeMs: 180000;
|
|
@@ -1043,7 +1166,7 @@ export declare class EdgeScrollManager {
|
|
|
1043
1166
|
/** @public */
|
|
1044
1167
|
export declare class Editor extends EventEmitter<TLEventMap> {
|
|
1045
1168
|
readonly id: string;
|
|
1046
|
-
constructor({ store, user, shapeUtils, bindingUtils, tools, getContainer, cameraOptions, initialState, autoFocus,
|
|
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);
|
|
1047
1170
|
private readonly _getShapeVisibility?;
|
|
1048
1171
|
private getIsShapeHiddenCache;
|
|
1049
1172
|
isShapeHidden(shapeOrId: TLShape | TLShapeId): boolean;
|
|
@@ -1106,7 +1229,13 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1106
1229
|
* @public
|
|
1107
1230
|
*/
|
|
1108
1231
|
readonly snaps: SnapManager;
|
|
1109
|
-
|
|
1232
|
+
/**
|
|
1233
|
+
* A manager for performance measurement hooks.
|
|
1234
|
+
*
|
|
1235
|
+
* @public
|
|
1236
|
+
*/
|
|
1237
|
+
readonly performance: PerformanceManager;
|
|
1238
|
+
/* Excluded from this release type: _spatialIndex */
|
|
1110
1239
|
/**
|
|
1111
1240
|
* A manager for the any asynchronous events and making sure they're
|
|
1112
1241
|
* cleaned up upon disposal.
|
|
@@ -1119,12 +1248,19 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1119
1248
|
setInterval: (handler: TimerHandler, timeout?: number | undefined, ...args: any[]) => number;
|
|
1120
1249
|
setTimeout: (handler: TimerHandler, timeout?: number | undefined, ...args: any[]) => number;
|
|
1121
1250
|
};
|
|
1251
|
+
/**
|
|
1252
|
+
* A manager for remote peer collaborators connected to this editor.
|
|
1253
|
+
*
|
|
1254
|
+
* @public
|
|
1255
|
+
*/
|
|
1256
|
+
readonly collaborators: CollaboratorsManager;
|
|
1122
1257
|
/**
|
|
1123
1258
|
* A manager for the user and their preferences.
|
|
1124
1259
|
*
|
|
1125
1260
|
* @public
|
|
1126
1261
|
*/
|
|
1127
1262
|
readonly user: UserPreferencesManager;
|
|
1263
|
+
/* Excluded from this release type: _themeManager */
|
|
1128
1264
|
/**
|
|
1129
1265
|
* A helper for measuring text.
|
|
1130
1266
|
*
|
|
@@ -1143,6 +1279,12 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1143
1279
|
* @public
|
|
1144
1280
|
*/
|
|
1145
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;
|
|
1146
1288
|
/**
|
|
1147
1289
|
* A manager for side effects and correct state enforcement. See {@link @tldraw/store#StoreSideEffects} for details.
|
|
1148
1290
|
*
|
|
@@ -1175,6 +1317,83 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1175
1317
|
* @public
|
|
1176
1318
|
*/
|
|
1177
1319
|
dispose(): void;
|
|
1320
|
+
/**
|
|
1321
|
+
* Get the current color mode (`'light'` or `'dark'`), based on the user's dark mode preference.
|
|
1322
|
+
*
|
|
1323
|
+
* @public
|
|
1324
|
+
*/
|
|
1325
|
+
getColorMode(): 'dark' | 'light';
|
|
1326
|
+
/**
|
|
1327
|
+
* Set the color mode. Note that this is a convenience method that passes the mode to
|
|
1328
|
+
* `user.updateUserPreferences`, which is the source of truth for the user's color mode preference.
|
|
1329
|
+
*
|
|
1330
|
+
* @public
|
|
1331
|
+
*/
|
|
1332
|
+
setColorMode(mode: 'dark' | 'light'): this;
|
|
1333
|
+
/**
|
|
1334
|
+
* Get the id of the current theme.
|
|
1335
|
+
*
|
|
1336
|
+
* @public
|
|
1337
|
+
*/
|
|
1338
|
+
getCurrentThemeId(): TLThemeId;
|
|
1339
|
+
/**
|
|
1340
|
+
* Get the current theme definition.
|
|
1341
|
+
*
|
|
1342
|
+
* @public
|
|
1343
|
+
*/
|
|
1344
|
+
getCurrentTheme(): TLTheme;
|
|
1345
|
+
/**
|
|
1346
|
+
* Set the current theme by id.
|
|
1347
|
+
*
|
|
1348
|
+
* @public
|
|
1349
|
+
*/
|
|
1350
|
+
setCurrentTheme(id: TLThemeId): this;
|
|
1351
|
+
/**
|
|
1352
|
+
* Get all registered theme definitions.
|
|
1353
|
+
*
|
|
1354
|
+
* @public
|
|
1355
|
+
*/
|
|
1356
|
+
getThemes(): TLThemes;
|
|
1357
|
+
/**
|
|
1358
|
+
* Get a single theme definition by id.
|
|
1359
|
+
*
|
|
1360
|
+
* @public
|
|
1361
|
+
*/
|
|
1362
|
+
getTheme(id: TLThemeId): TLTheme | undefined;
|
|
1363
|
+
/**
|
|
1364
|
+
* Replace all theme definitions, or update them via a callback that receives a deep copy.
|
|
1365
|
+
* The `'default'` theme must always be present in the result.
|
|
1366
|
+
*
|
|
1367
|
+
* @example
|
|
1368
|
+
* ```ts
|
|
1369
|
+
* // Replace all themes
|
|
1370
|
+
* editor.updateThemes({ default: myDefaultTheme, ocean: myOceanTheme })
|
|
1371
|
+
*
|
|
1372
|
+
* // Update via callback
|
|
1373
|
+
* editor.updateThemes((themes) => {
|
|
1374
|
+
* delete themes.ocean
|
|
1375
|
+
* return themes
|
|
1376
|
+
* })
|
|
1377
|
+
* ```
|
|
1378
|
+
*
|
|
1379
|
+
* @public
|
|
1380
|
+
*/
|
|
1381
|
+
updateThemes(themes: ((themes: TLThemes) => TLThemes) | TLThemes): this;
|
|
1382
|
+
/**
|
|
1383
|
+
* Register or update a single theme definition. The theme is keyed by its `id` property.
|
|
1384
|
+
*
|
|
1385
|
+
* @example
|
|
1386
|
+
* ```ts
|
|
1387
|
+
* // Override a property on the default theme
|
|
1388
|
+
* editor.updateTheme({ ...editor.getTheme('default')!, fontSize: 24 })
|
|
1389
|
+
*
|
|
1390
|
+
* // Register a new theme
|
|
1391
|
+
* editor.updateTheme({ id: 'ocean', ...myOceanTheme })
|
|
1392
|
+
* ```
|
|
1393
|
+
*
|
|
1394
|
+
* @public
|
|
1395
|
+
*/
|
|
1396
|
+
updateTheme(theme: TLTheme): this;
|
|
1178
1397
|
/**
|
|
1179
1398
|
* A map of shape utility classes (TLShapeUtils) by shape type.
|
|
1180
1399
|
*
|
|
@@ -1183,6 +1402,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1183
1402
|
shapeUtils: {
|
|
1184
1403
|
readonly [K in string]?: ShapeUtil<TLShape>;
|
|
1185
1404
|
};
|
|
1405
|
+
/* Excluded from this release type: _shapeUtilsByAssetType */
|
|
1186
1406
|
styleProps: {
|
|
1187
1407
|
[key: string]: Map<StyleProp<any>, string>;
|
|
1188
1408
|
};
|
|
@@ -1214,6 +1434,15 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1214
1434
|
hasShapeUtil(shape: TLShape | TLShapePartial<TLShape>): boolean;
|
|
1215
1435
|
hasShapeUtil(type: TLShape['type']): boolean;
|
|
1216
1436
|
hasShapeUtil<T extends ShapeUtil>(type: T extends ShapeUtil<infer R> ? R['type'] : string): boolean;
|
|
1437
|
+
/**
|
|
1438
|
+
* Get the shape util that handles the given asset type.
|
|
1439
|
+
* Returns the shape util whose {@link ShapeUtil.handledAssetTypes} includes
|
|
1440
|
+
* the given asset type, or undefined if none matches.
|
|
1441
|
+
*
|
|
1442
|
+
* @param assetType - The asset type string.
|
|
1443
|
+
* @public
|
|
1444
|
+
*/
|
|
1445
|
+
getShapeUtilForAssetType(assetType: string): ShapeUtil | undefined;
|
|
1217
1446
|
/**
|
|
1218
1447
|
* A map of shape utility classes (TLShapeUtils) by shape type.
|
|
1219
1448
|
*
|
|
@@ -1244,6 +1473,40 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1244
1473
|
type: S['type'];
|
|
1245
1474
|
} | S): BindingUtil<S>;
|
|
1246
1475
|
getBindingUtil<T extends BindingUtil>(type: T extends BindingUtil<infer R> ? R['type'] : string): T;
|
|
1476
|
+
/**
|
|
1477
|
+
* A map of asset utility classes by asset type.
|
|
1478
|
+
*
|
|
1479
|
+
* @public
|
|
1480
|
+
*/
|
|
1481
|
+
assetUtils: {
|
|
1482
|
+
readonly [K in string]?: AssetUtil<TLAsset>;
|
|
1483
|
+
};
|
|
1484
|
+
/**
|
|
1485
|
+
* Get an asset util from an asset or asset type.
|
|
1486
|
+
*
|
|
1487
|
+
* @param arg - An asset, asset type string, or object with type.
|
|
1488
|
+
*
|
|
1489
|
+
* @public
|
|
1490
|
+
*/
|
|
1491
|
+
getAssetUtil<S extends TLAsset>(asset: {
|
|
1492
|
+
type: S['type'];
|
|
1493
|
+
} | S): AssetUtil<S>;
|
|
1494
|
+
getAssetUtil(type: string): AssetUtil;
|
|
1495
|
+
/**
|
|
1496
|
+
* Returns true if the editor has an asset util for the given asset type.
|
|
1497
|
+
*
|
|
1498
|
+
* @public
|
|
1499
|
+
*/
|
|
1500
|
+
hasAssetUtil(arg: {
|
|
1501
|
+
type: string;
|
|
1502
|
+
} | string): boolean;
|
|
1503
|
+
/**
|
|
1504
|
+
* Get the asset util that accepts the given MIME type.
|
|
1505
|
+
* Returns null if no registered asset util accepts the MIME type.
|
|
1506
|
+
*
|
|
1507
|
+
* @public
|
|
1508
|
+
*/
|
|
1509
|
+
getAssetUtilForMimeType(mimeType: string): AssetUtil | null;
|
|
1247
1510
|
/**
|
|
1248
1511
|
* A manager for the editor's history.
|
|
1249
1512
|
*
|
|
@@ -1500,6 +1763,11 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
1500
1763
|
/**
|
|
1501
1764
|
* Set the cursor.
|
|
1502
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
|
+
*
|
|
1503
1771
|
* @param cursor - The cursor to set.
|
|
1504
1772
|
* @public
|
|
1505
1773
|
*/
|
|
@@ -2259,11 +2527,12 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
2259
2527
|
* @public
|
|
2260
2528
|
*/
|
|
2261
2529
|
pageToViewport(point: VecLike): Vec;
|
|
2262
|
-
private _getCollaboratorsQuery;
|
|
2263
2530
|
/**
|
|
2264
2531
|
* Returns a list of presence records for all peer collaborators.
|
|
2265
2532
|
* This will return the latest presence record for each connected user.
|
|
2266
2533
|
*
|
|
2534
|
+
* Convenience wrapper for {@link CollaboratorsManager.getCollaborators}.
|
|
2535
|
+
*
|
|
2267
2536
|
* @public
|
|
2268
2537
|
*/
|
|
2269
2538
|
getCollaborators(): TLInstancePresence[];
|
|
@@ -2271,9 +2540,32 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
2271
2540
|
* Returns a list of presence records for all peer collaborators on the current page.
|
|
2272
2541
|
* This will return the latest presence record for each connected user.
|
|
2273
2542
|
*
|
|
2543
|
+
* Convenience wrapper for {@link CollaboratorsManager.getCollaboratorsOnCurrentPage}.
|
|
2544
|
+
*
|
|
2274
2545
|
* @public
|
|
2275
2546
|
*/
|
|
2276
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[];
|
|
2277
2569
|
/**
|
|
2278
2570
|
* Get the current user's ID for attribution purposes.
|
|
2279
2571
|
* Also ensures a `user:` record exists in the store for the current user.
|
|
@@ -2934,6 +3226,20 @@ export declare class Editor extends EventEmitter<TLEventMap> {
|
|
|
2934
3226
|
type: T['type'];
|
|
2935
3227
|
}>;
|
|
2936
3228
|
isShapeOfType<T extends TLShape = TLShape>(shapeId: TLShapeId, type: T['type']): boolean;
|
|
3229
|
+
/**
|
|
3230
|
+
* Get whether a shape behaves like a frame — a container that has child
|
|
3231
|
+
* shapes, requires full-brush selection, blocks erasure from inside, etc.
|
|
3232
|
+
*
|
|
3233
|
+
* @example
|
|
3234
|
+
* ```ts
|
|
3235
|
+
* const isFrameLike = editor.isShapeFrameLike(someShape)
|
|
3236
|
+
* ```
|
|
3237
|
+
*
|
|
3238
|
+
* @param shape - The shape (or shape id) to test.
|
|
3239
|
+
*
|
|
3240
|
+
* @public
|
|
3241
|
+
*/
|
|
3242
|
+
isShapeFrameLike(shape: TLShape | TLShapeId): boolean;
|
|
2937
3243
|
/**
|
|
2938
3244
|
* Get a shape by its id.
|
|
2939
3245
|
*
|
|
@@ -4394,6 +4700,35 @@ export declare interface Geometry2dOptions extends TransformedGeometry2dOptions
|
|
|
4394
4700
|
*/
|
|
4395
4701
|
export declare function getArcMeasure(A: number, B: number, sweepFlag: number, largeArcFlag: number): number;
|
|
4396
4702
|
|
|
4703
|
+
/**
|
|
4704
|
+
* Resolves a color style value to its actual CSS color string for a given theme and variant.
|
|
4705
|
+
* If the color is not a default theme color, returns the color value as-is.
|
|
4706
|
+
*
|
|
4707
|
+
* @param colors - The color palette for the current color mode (e.g. `theme.colors[colorMode]`)
|
|
4708
|
+
* @param color - The color style value to resolve
|
|
4709
|
+
* @param variant - Which variant of the color to return (solid, fill, pattern, etc.)
|
|
4710
|
+
* @returns The CSS color string for the specified color and variant
|
|
4711
|
+
*
|
|
4712
|
+
* @example
|
|
4713
|
+
* ```ts
|
|
4714
|
+
* import { getColorValue } from 'tldraw'
|
|
4715
|
+
*
|
|
4716
|
+
* const colors = editor.getCurrentTheme().colors[editor.getColorMode()]
|
|
4717
|
+
*
|
|
4718
|
+
* // Get the solid variant of red
|
|
4719
|
+
* const redSolid = getColorValue(colors, 'red', 'solid') // '#e03131'
|
|
4720
|
+
*
|
|
4721
|
+
* // Get the fill variant of blue
|
|
4722
|
+
* const blueFill = getColorValue(colors, 'blue', 'fill') // '#4465e9'
|
|
4723
|
+
*
|
|
4724
|
+
* // Custom color passes through unchanged
|
|
4725
|
+
* const customColor = getColorValue(colors, '#ff0000', 'solid') // '#ff0000'
|
|
4726
|
+
* ```
|
|
4727
|
+
*
|
|
4728
|
+
* @public
|
|
4729
|
+
*/
|
|
4730
|
+
export declare function getColorValue(colors: TLThemeColors, color: string | TLDefaultColorStyle, variant: keyof TLDefaultColor): string;
|
|
4731
|
+
|
|
4397
4732
|
/** @public */
|
|
4398
4733
|
export declare function getCursor(cursor: TLCursorType, rotation?: number, color?: string): string;
|
|
4399
4734
|
|
|
@@ -4564,14 +4899,14 @@ export declare class GroupShapeUtil extends ShapeUtil<TLGroupShape> {
|
|
|
4564
4899
|
static type: "group";
|
|
4565
4900
|
static props: RecordProps<TLGroupShape>;
|
|
4566
4901
|
static migrations: TLPropsMigrations;
|
|
4567
|
-
hideSelectionBoundsFg(): boolean;
|
|
4902
|
+
hideSelectionBoundsFg(shape: TLGroupShape): boolean;
|
|
4568
4903
|
canBind(): boolean;
|
|
4569
4904
|
canResize(): boolean;
|
|
4570
4905
|
canResizeChildren(): boolean;
|
|
4571
4906
|
getDefaultProps(): TLGroupShape['props'];
|
|
4572
4907
|
getGeometry(shape: TLGroupShape): Geometry2d;
|
|
4573
4908
|
component(shape: TLGroupShape): JSX.Element | null;
|
|
4574
|
-
|
|
4909
|
+
getIndicatorPath(shape: TLGroupShape): Path2D;
|
|
4575
4910
|
onChildrenChange(group: TLGroupShape): void;
|
|
4576
4911
|
}
|
|
4577
4912
|
|
|
@@ -4850,6 +5185,12 @@ export declare class InputsManager {
|
|
|
4850
5185
|
get isPointing(): boolean;
|
|
4851
5186
|
set isPointing(isPointing: boolean);
|
|
4852
5187
|
/* Excluded from this release type: setIsPointing */
|
|
5188
|
+
private _isRightPointing;
|
|
5189
|
+
/**
|
|
5190
|
+
* Whether the user is right-click pointing (before drag threshold).
|
|
5191
|
+
*/
|
|
5192
|
+
getIsRightPointing(): boolean;
|
|
5193
|
+
/* Excluded from this release type: setIsRightPointing */
|
|
4853
5194
|
private _isPinching;
|
|
4854
5195
|
/**
|
|
4855
5196
|
* Whether the user is pinching.
|
|
@@ -5193,19 +5534,280 @@ export declare function openWindow(url: string, target?: string, allowReferrer?:
|
|
|
5193
5534
|
/** @public */
|
|
5194
5535
|
export declare type OptionalKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
|
|
5195
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
|
+
|
|
5196
5616
|
/**
|
|
5197
|
-
*
|
|
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.).
|
|
5198
5619
|
*
|
|
5199
|
-
*
|
|
5200
|
-
*
|
|
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
|
|
5201
5626
|
*
|
|
5202
5627
|
* @public
|
|
5203
5628
|
*/
|
|
5204
|
-
export declare
|
|
5205
|
-
|
|
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
|
+
|
|
5710
|
+
/**
|
|
5711
|
+
* Parses a string created by {@link createDeepLinkString} back into a deep link descriptor.
|
|
5712
|
+
*
|
|
5713
|
+
* @param deepLinkString - the deep link string
|
|
5714
|
+
* @returns a deep link descriptor
|
|
5715
|
+
*
|
|
5716
|
+
* @public
|
|
5717
|
+
*/
|
|
5718
|
+
export declare function parseDeepLinkString(deepLinkString: string): TLDeepLink;
|
|
5719
|
+
|
|
5206
5720
|
/** @public */
|
|
5207
5721
|
export declare type PerfectDashTerminal = 'none' | 'outset' | 'skip';
|
|
5208
5722
|
|
|
5723
|
+
/**
|
|
5724
|
+
* Optional adapter that pipes PerformanceManager events into browser
|
|
5725
|
+
* `performance.mark()` / `performance.measure()` for DevTools integration.
|
|
5726
|
+
*
|
|
5727
|
+
* Tree-shakeable — only included if imported.
|
|
5728
|
+
*
|
|
5729
|
+
* @example
|
|
5730
|
+
* ```ts
|
|
5731
|
+
* const adapter = new PerformanceApiAdapter(editor.performance)
|
|
5732
|
+
* // ... later
|
|
5733
|
+
* adapter.dispose()
|
|
5734
|
+
* ```
|
|
5735
|
+
*
|
|
5736
|
+
* @public
|
|
5737
|
+
*/
|
|
5738
|
+
export declare class PerformanceApiAdapter {
|
|
5739
|
+
private cleanups;
|
|
5740
|
+
constructor(perfManager: PerformanceManager);
|
|
5741
|
+
/** Remove all listeners and stop piping events. @public */
|
|
5742
|
+
dispose(): void;
|
|
5743
|
+
}
|
|
5744
|
+
|
|
5745
|
+
/**
|
|
5746
|
+
* Manages performance event subscriptions for the editor. Available as `editor.performance`.
|
|
5747
|
+
*
|
|
5748
|
+
* Listeners are lazy — internal editor hooks (frame, shape events) are only attached while
|
|
5749
|
+
* at least one subscriber exists, so there is zero overhead when unused.
|
|
5750
|
+
*
|
|
5751
|
+
* @example
|
|
5752
|
+
* ```ts
|
|
5753
|
+
* const unsub = editor.performance.on('interaction-end', (event) => {
|
|
5754
|
+
* console.log(`${event.name}: ${event.fps.toFixed(1)} fps, p95=${event.p95FrameTime.toFixed(1)}ms`)
|
|
5755
|
+
* })
|
|
5756
|
+
* ```
|
|
5757
|
+
*
|
|
5758
|
+
* @public
|
|
5759
|
+
*/
|
|
5760
|
+
export declare class PerformanceManager {
|
|
5761
|
+
/* Excluded from this release type: emitter */
|
|
5762
|
+
private editor;
|
|
5763
|
+
private activeInteraction;
|
|
5764
|
+
private activeCamera;
|
|
5765
|
+
private frameCleanup;
|
|
5766
|
+
private shapeCreatedCleanup;
|
|
5767
|
+
private shapeEditedCleanup;
|
|
5768
|
+
private shapeDeletedCleanup;
|
|
5769
|
+
private loafObserver;
|
|
5770
|
+
constructor(editor: Editor);
|
|
5771
|
+
/**
|
|
5772
|
+
* Subscribe to a performance event. Returns an unsubscribe function.
|
|
5773
|
+
*
|
|
5774
|
+
* @example
|
|
5775
|
+
* ```ts
|
|
5776
|
+
* const unsub = editor.performance.on('interaction-end', (event) => {
|
|
5777
|
+
* sendToAnalytics({ name: event.name, fps: event.fps, p95: event.p95FrameTime })
|
|
5778
|
+
* })
|
|
5779
|
+
* // later: unsub()
|
|
5780
|
+
* ```
|
|
5781
|
+
*
|
|
5782
|
+
* @public
|
|
5783
|
+
*/
|
|
5784
|
+
on<K extends keyof TLPerfEventMap>(event: K, fn: (...args: TLPerfEventMap[K]) => void): () => void;
|
|
5785
|
+
/**
|
|
5786
|
+
* Subscribe to a performance event once. The listener is removed after the first invocation.
|
|
5787
|
+
* Returns an unsubscribe function for early removal.
|
|
5788
|
+
*
|
|
5789
|
+
* @public
|
|
5790
|
+
*/
|
|
5791
|
+
once<K extends keyof TLPerfEventMap>(event: K, fn: (...args: TLPerfEventMap[K]) => void): () => void;
|
|
5792
|
+
/* Excluded from this release type: dispose */
|
|
5793
|
+
/* Excluded from this release type: _notifyInteractionStart */
|
|
5794
|
+
/* Excluded from this release type: _notifyInteractionEnd */
|
|
5795
|
+
/* Excluded from this release type: _notifyCameraOperation */
|
|
5796
|
+
/* Excluded from this release type: _notifyUndoRedo */
|
|
5797
|
+
private _startCameraSession;
|
|
5798
|
+
private _endCameraSession;
|
|
5799
|
+
private _onFrame;
|
|
5800
|
+
private _onShapesCreated;
|
|
5801
|
+
private _onShapesEdited;
|
|
5802
|
+
private _onShapesDeleted;
|
|
5803
|
+
private _startLoafObserver;
|
|
5804
|
+
private _stopLoafObserver;
|
|
5805
|
+
private _needsFrameListener;
|
|
5806
|
+
private _needsLoafObserver;
|
|
5807
|
+
private _maybeAttachLazyListeners;
|
|
5808
|
+
private _maybeDetachLazyListeners;
|
|
5809
|
+
}
|
|
5810
|
+
|
|
5209
5811
|
/**
|
|
5210
5812
|
* Find the approximate perimeter of an ellipse.
|
|
5211
5813
|
*
|
|
@@ -5400,6 +6002,16 @@ export declare function resizeScaled(shape: TLBaseShape<any, {
|
|
|
5400
6002
|
y: number;
|
|
5401
6003
|
};
|
|
5402
6004
|
|
|
6005
|
+
/**
|
|
6006
|
+
* Resolve a partial set of user-provided themes into a complete `TLThemes`
|
|
6007
|
+
* record by merging with `DEFAULT_THEME`. The result is suitable for passing to
|
|
6008
|
+
* `registerColorsFromThemes`, `registerFontsFromThemes`, and the
|
|
6009
|
+
* `ThemeManager` constructor.
|
|
6010
|
+
*
|
|
6011
|
+
* @public
|
|
6012
|
+
*/
|
|
6013
|
+
export declare function resolveThemes(themes?: Partial<TLThemes>): TLThemes;
|
|
6014
|
+
|
|
5403
6015
|
/** @public */
|
|
5404
6016
|
export declare type RichTextFontVisitor = (node: TiptapNode, state: RichTextFontVisitorState, addFont: (font: TLFontFace) => void) => RichTextFontVisitorState;
|
|
5405
6017
|
|
|
@@ -5627,6 +6239,32 @@ export declare function setRuntimeOverrides(input: Partial<typeof runtime>): voi
|
|
|
5627
6239
|
/** @public */
|
|
5628
6240
|
export declare function setUserPreferences(user: TLUserPreferences): void;
|
|
5629
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
|
+
|
|
5630
6268
|
/** @public */
|
|
5631
6269
|
export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
5632
6270
|
editor: Editor;
|
|
@@ -5681,12 +6319,32 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5681
6319
|
* @public
|
|
5682
6320
|
*/
|
|
5683
6321
|
static type: string;
|
|
6322
|
+
/**
|
|
6323
|
+
* The asset types that this shape can be created from.
|
|
6324
|
+
* When a file is dropped on the canvas, the editor finds the shape util
|
|
6325
|
+
* whose `handledAssetTypes` includes the asset's type and calls
|
|
6326
|
+
* {@link ShapeUtil.createShapeForAsset} to produce the shape.
|
|
6327
|
+
*
|
|
6328
|
+
* @public
|
|
6329
|
+
*/
|
|
6330
|
+
static handledAssetTypes?: readonly string[];
|
|
5684
6331
|
/**
|
|
5685
6332
|
* Get the default props for a shape.
|
|
5686
6333
|
*
|
|
5687
6334
|
* @public
|
|
5688
6335
|
*/
|
|
5689
6336
|
abstract getDefaultProps(): Shape['props'];
|
|
6337
|
+
/**
|
|
6338
|
+
* Create a shape partial for placing an asset on the canvas.
|
|
6339
|
+
* Only called for shapes whose constructor declares matching
|
|
6340
|
+
* {@link ShapeUtil.handledAssetTypes | `handledAssetTypes`}.
|
|
6341
|
+
*
|
|
6342
|
+
* @param asset - The asset to create a shape for.
|
|
6343
|
+
* @param position - Where to place the shape.
|
|
6344
|
+
* @returns A shape partial, or null if this shape can't be created for the asset.
|
|
6345
|
+
* @public
|
|
6346
|
+
*/
|
|
6347
|
+
createShapeForAsset?(asset: TLAsset, position: VecModel): null | TLShapePartial;
|
|
5690
6348
|
/**
|
|
5691
6349
|
* Get the shape's geometry.
|
|
5692
6350
|
*
|
|
@@ -5703,37 +6361,30 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5703
6361
|
*/
|
|
5704
6362
|
abstract component(shape: Shape): any;
|
|
5705
6363
|
/**
|
|
5706
|
-
* Get
|
|
5707
|
-
*
|
|
5708
|
-
*
|
|
5709
|
-
* @public
|
|
5710
|
-
*/
|
|
5711
|
-
abstract indicator(shape: Shape): any;
|
|
5712
|
-
/**
|
|
5713
|
-
* Whether to use the legacy React-based indicator rendering.
|
|
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.
|
|
5714
6367
|
*
|
|
5715
|
-
*
|
|
5716
|
-
*
|
|
6368
|
+
* For complex indicators that need clipping (e.g., arrows with labels), return an
|
|
6369
|
+
* object with `path`, `clipPath`, and `additionalPaths` properties.
|
|
5717
6370
|
*
|
|
5718
|
-
* @
|
|
6371
|
+
* @param shape - The shape.
|
|
6372
|
+
* @returns A Path2D to stroke, or an object with clipping info, or undefined to skip.
|
|
5719
6373
|
* @public
|
|
5720
6374
|
*/
|
|
5721
|
-
|
|
6375
|
+
abstract getIndicatorPath(shape: Shape): TLIndicatorPath | undefined;
|
|
5722
6376
|
/**
|
|
5723
|
-
* Get
|
|
5724
|
-
*
|
|
5725
|
-
* When implemented, this is used instead of {@link ShapeUtil.indicator} for more
|
|
5726
|
-
* efficient canvas-based indicator rendering. Shapes that return `undefined` will
|
|
5727
|
-
* fall back to SVG-based rendering via {@link ShapeUtil.indicator}.
|
|
6377
|
+
* Get JSX describing the shape's indicator (as an SVG element).
|
|
5728
6378
|
*
|
|
5729
|
-
*
|
|
5730
|
-
*
|
|
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.
|
|
5731
6383
|
*
|
|
5732
6384
|
* @param shape - The shape.
|
|
5733
|
-
* @returns A Path2D to stroke, or an object with clipping info, or undefined to use SVG fallback.
|
|
5734
6385
|
* @public
|
|
5735
6386
|
*/
|
|
5736
|
-
|
|
6387
|
+
indicator(_shape: Shape): any;
|
|
5737
6388
|
/**
|
|
5738
6389
|
* Get the font faces that should be rendered in the document in order for this shape to render
|
|
5739
6390
|
* correctly.
|
|
@@ -5767,7 +6418,7 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5767
6418
|
*
|
|
5768
6419
|
* @public
|
|
5769
6420
|
*/
|
|
5770
|
-
canBind(
|
|
6421
|
+
canBind(opts: TLShapeUtilCanBindOpts): boolean;
|
|
5771
6422
|
/**
|
|
5772
6423
|
* Whether the shape can be double clicked to edit.
|
|
5773
6424
|
*
|
|
@@ -5901,6 +6552,14 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5901
6552
|
* @public
|
|
5902
6553
|
*/
|
|
5903
6554
|
isAspectRatioLocked(shape: Shape): boolean;
|
|
6555
|
+
/**
|
|
6556
|
+
* Whether the shape behaves like a frame — a container that has child shapes,
|
|
6557
|
+
* requires full-brush selection, blocks erasure from inside, etc.
|
|
6558
|
+
*
|
|
6559
|
+
* @param shape - The shape.
|
|
6560
|
+
* @public
|
|
6561
|
+
*/
|
|
6562
|
+
isFrameLike(_shape: Shape): boolean;
|
|
5904
6563
|
/**
|
|
5905
6564
|
* By default, the bounds of an image export are the bounds of all the shapes it contains, plus
|
|
5906
6565
|
* some padding. If an export includes a shape where `isExportBoundsContainer` is true, then the
|
|
@@ -5948,7 +6607,7 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
|
|
|
5948
6607
|
* @param type - The shape type.
|
|
5949
6608
|
* @public
|
|
5950
6609
|
*/
|
|
5951
|
-
canReceiveNewChildrenOfType(shape: Shape,
|
|
6610
|
+
canReceiveNewChildrenOfType(shape: Shape, type: TLShape['type']): boolean;
|
|
5952
6611
|
/**
|
|
5953
6612
|
* Get the shape as an SVG object.
|
|
5954
6613
|
*
|
|
@@ -6391,6 +7050,8 @@ export declare abstract class StateNode implements Partial<TLEventHandlers> {
|
|
|
6391
7050
|
static children?: () => TLStateNodeConstructor[];
|
|
6392
7051
|
static isLockable: boolean;
|
|
6393
7052
|
static useCoalescedEvents: boolean;
|
|
7053
|
+
/** Set to `true` in subclasses to emit interaction-start/end performance events when this state is entered/exited. */
|
|
7054
|
+
static trackPerformance: boolean;
|
|
6394
7055
|
id: string;
|
|
6395
7056
|
type: 'branch' | 'leaf' | 'root';
|
|
6396
7057
|
shapeType?: string;
|
|
@@ -6490,6 +7151,19 @@ export declare const stopEventPropagation: (e: any) => any;
|
|
|
6490
7151
|
|
|
6491
7152
|
/* Excluded from this release type: StoreName */
|
|
6492
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
|
+
|
|
6493
7167
|
/** @public */
|
|
6494
7168
|
export declare function suffixSafeId(id: SafeId, suffix: string): SafeId;
|
|
6495
7169
|
|
|
@@ -6525,6 +7199,10 @@ export declare interface SvgExportContext {
|
|
|
6525
7199
|
* Whether the export should be in dark mode.
|
|
6526
7200
|
*/
|
|
6527
7201
|
readonly isDarkMode: boolean;
|
|
7202
|
+
/**
|
|
7203
|
+
* The color mode to use for this export.
|
|
7204
|
+
*/
|
|
7205
|
+
readonly colorMode: 'dark' | 'light';
|
|
6528
7206
|
/**
|
|
6529
7207
|
* The scale of the export - how much CSS pixels will be scaled up/down by.
|
|
6530
7208
|
*/
|
|
@@ -6595,6 +7273,47 @@ export declare class TextManager {
|
|
|
6595
7273
|
}[];
|
|
6596
7274
|
}
|
|
6597
7275
|
|
|
7276
|
+
/**
|
|
7277
|
+
* Manages the editor's color themes.
|
|
7278
|
+
*
|
|
7279
|
+
* Stores named theme definitions (each containing light and dark color palettes
|
|
7280
|
+
* alongside shared properties like font size). The current theme is resolved by
|
|
7281
|
+
* combining the current theme name with the user's color mode preference.
|
|
7282
|
+
*
|
|
7283
|
+
* **Terminology:**
|
|
7284
|
+
* - **Theme** (`TLTheme`): A named set of colors and typographic values for both light and dark modes.
|
|
7285
|
+
* - **Color mode** (`'light' | 'dark'`): The resolved appearance mode, derived from the user's
|
|
7286
|
+
* `colorScheme` preference (`'light' | 'dark' | 'system'`). Access via `getColorMode()`.
|
|
7287
|
+
*
|
|
7288
|
+
* @public
|
|
7289
|
+
*/
|
|
7290
|
+
export declare class ThemeManager {
|
|
7291
|
+
private readonly editor;
|
|
7292
|
+
private readonly _themes;
|
|
7293
|
+
private readonly _currentThemeId;
|
|
7294
|
+
constructor(editor: Editor, options: {
|
|
7295
|
+
initial: TLThemeId;
|
|
7296
|
+
themes: TLThemes;
|
|
7297
|
+
});
|
|
7298
|
+
/** Get the current color mode based on the user's dark mode preference. */
|
|
7299
|
+
getColorMode(): 'dark' | 'light';
|
|
7300
|
+
/** Get all registered theme definitions. */
|
|
7301
|
+
getThemes(): TLThemes;
|
|
7302
|
+
/** Get a single theme definition by id. */
|
|
7303
|
+
getTheme(id: TLThemeId): TLTheme | undefined;
|
|
7304
|
+
/** Get the id of the current theme. */
|
|
7305
|
+
getCurrentThemeId(): TLThemeId;
|
|
7306
|
+
getCurrentTheme(): TLTheme;
|
|
7307
|
+
/** Set the current theme by id. The theme must have been previously registered. */
|
|
7308
|
+
setCurrentTheme(id: TLThemeId): void;
|
|
7309
|
+
/** Replace all theme definitions, or update them via a callback that receives a deep copy. */
|
|
7310
|
+
updateThemes(themes: ((themes: TLThemes) => TLThemes) | TLThemes): void;
|
|
7311
|
+
/** Register or update a named theme definition. */
|
|
7312
|
+
updateTheme(theme: TLTheme): void;
|
|
7313
|
+
/** Clean up any resources held by the manager. */
|
|
7314
|
+
dispose(): void;
|
|
7315
|
+
}
|
|
7316
|
+
|
|
6598
7317
|
/* Excluded from this release type: TickManager */
|
|
6599
7318
|
|
|
6600
7319
|
/**
|
|
@@ -6613,12 +7332,26 @@ export declare type TiptapNode = Node_2;
|
|
|
6613
7332
|
/** @public */
|
|
6614
7333
|
export declare type TLAdjacentDirection = 'down' | 'left' | 'next' | 'prev' | 'right' | 'up';
|
|
6615
7334
|
|
|
7335
|
+
/** @public */
|
|
7336
|
+
export declare type TLAnyAssetUtilConstructor = TLAssetUtilConstructor<any>;
|
|
7337
|
+
|
|
6616
7338
|
/** @public */
|
|
6617
7339
|
export declare type TLAnyBindingUtilConstructor = TLBindingUtilConstructor<any>;
|
|
6618
7340
|
|
|
7341
|
+
/** @public */
|
|
7342
|
+
export declare type TLAnyOverlayUtilConstructor = TLOverlayUtilConstructor<any>;
|
|
7343
|
+
|
|
6619
7344
|
/** @public */
|
|
6620
7345
|
export declare type TLAnyShapeUtilConstructor = TLShapeUtilConstructor<any>;
|
|
6621
7346
|
|
|
7347
|
+
/** @public */
|
|
7348
|
+
export declare interface TLAssetUtilConstructor<T extends TLAsset = TLAsset, U extends AssetUtil<T> = AssetUtil<T>> {
|
|
7349
|
+
new (editor: Editor): U;
|
|
7350
|
+
type: T['type'];
|
|
7351
|
+
props?: RecordProps<T>;
|
|
7352
|
+
migrations?: LegacyMigrations | MigrationSequence | TLPropsMigrations;
|
|
7353
|
+
}
|
|
7354
|
+
|
|
6622
7355
|
/** @public */
|
|
6623
7356
|
export declare type TLBaseBoxShape = ExtractShapeByProps<{
|
|
6624
7357
|
h: number;
|
|
@@ -6651,15 +7384,6 @@ export declare interface TLBindingUtilConstructor<T extends TLBinding, U extends
|
|
|
6651
7384
|
migrations?: TLPropsMigrations;
|
|
6652
7385
|
}
|
|
6653
7386
|
|
|
6654
|
-
/** @public */
|
|
6655
|
-
export declare interface TLBrushProps {
|
|
6656
|
-
userId?: string;
|
|
6657
|
-
brush: BoxModel;
|
|
6658
|
-
color?: string;
|
|
6659
|
-
opacity?: number;
|
|
6660
|
-
className?: string;
|
|
6661
|
-
}
|
|
6662
|
-
|
|
6663
7387
|
/** @public */
|
|
6664
7388
|
export declare interface TLCameraConstraints {
|
|
6665
7389
|
/** The bounds (in page space) of the constrained space */
|
|
@@ -6708,6 +7432,29 @@ export declare interface TLCameraConstraints {
|
|
|
6708
7432
|
};
|
|
6709
7433
|
}
|
|
6710
7434
|
|
|
7435
|
+
/**
|
|
7436
|
+
* Emitted when a camera operation ends (after a 50ms debounce), with aggregated frame time stats.
|
|
7437
|
+
* @public
|
|
7438
|
+
*/
|
|
7439
|
+
export declare interface TLCameraEndPerfEvent extends TLPerfFrameTimeStats {
|
|
7440
|
+
/** Whether this was a pan or zoom operation. */
|
|
7441
|
+
type: 'panning' | 'zooming';
|
|
7442
|
+
/** Total shapes on the current page. */
|
|
7443
|
+
shapeCount: number;
|
|
7444
|
+
/** Number of shapes visible (not culled) in the viewport. */
|
|
7445
|
+
visibleShapeCount: number;
|
|
7446
|
+
/** Number of shapes culled (off-screen) from rendering. */
|
|
7447
|
+
culledShapeCount: number;
|
|
7448
|
+
/** Viewport width in screen pixels. */
|
|
7449
|
+
viewportWidth: number;
|
|
7450
|
+
/** Viewport height in screen pixels. */
|
|
7451
|
+
viewportHeight: number;
|
|
7452
|
+
/** Camera zoom level (`camera.z`) at session end. */
|
|
7453
|
+
zoomLevel: number;
|
|
7454
|
+
/** `performance.now()` when the camera session ended. */
|
|
7455
|
+
timestamp: number;
|
|
7456
|
+
}
|
|
7457
|
+
|
|
6711
7458
|
/** @public */
|
|
6712
7459
|
export declare interface TLCameraMoveOptions {
|
|
6713
7460
|
/** Whether to move the camera immediately, rather than on the next tick. */
|
|
@@ -6746,6 +7493,17 @@ export declare interface TLCameraOptions {
|
|
|
6746
7493
|
constraints?: TLCameraConstraints;
|
|
6747
7494
|
}
|
|
6748
7495
|
|
|
7496
|
+
/**
|
|
7497
|
+
* Emitted when a camera operation (pan or zoom) begins.
|
|
7498
|
+
* @public
|
|
7499
|
+
*/
|
|
7500
|
+
export declare interface TLCameraStartPerfEvent {
|
|
7501
|
+
/** Whether this is a pan or zoom operation. */
|
|
7502
|
+
type: 'panning' | 'zooming';
|
|
7503
|
+
/** `performance.now()` when the camera session started. */
|
|
7504
|
+
timestamp: number;
|
|
7505
|
+
}
|
|
7506
|
+
|
|
6749
7507
|
/** @public */
|
|
6750
7508
|
export declare type TLCancelEvent = (info: TLCancelEventInfo) => void;
|
|
6751
7509
|
|
|
@@ -6813,17 +7571,6 @@ export declare interface TLClipboardWriteInfo {
|
|
|
6813
7571
|
readonly source: 'menu' | 'native';
|
|
6814
7572
|
}
|
|
6815
7573
|
|
|
6816
|
-
/** @public */
|
|
6817
|
-
export declare interface TLCollaboratorHintProps {
|
|
6818
|
-
userId: string;
|
|
6819
|
-
className?: string;
|
|
6820
|
-
point: VecModel;
|
|
6821
|
-
viewport: Box;
|
|
6822
|
-
zoom: number;
|
|
6823
|
-
opacity?: number;
|
|
6824
|
-
color: string;
|
|
6825
|
-
}
|
|
6826
|
-
|
|
6827
7574
|
/** @public */
|
|
6828
7575
|
export declare type TLCompleteEvent = (info: TLCompleteEventInfo) => void;
|
|
6829
7576
|
|
|
@@ -6868,17 +7615,6 @@ export declare interface TLCurrentUser {
|
|
|
6868
7615
|
readonly setUserPreferences: (userPreferences: TLUserPreferences) => void;
|
|
6869
7616
|
}
|
|
6870
7617
|
|
|
6871
|
-
/** @public */
|
|
6872
|
-
export declare interface TLCursorProps {
|
|
6873
|
-
userId: string;
|
|
6874
|
-
className?: string;
|
|
6875
|
-
point: null | VecModel;
|
|
6876
|
-
zoom: number;
|
|
6877
|
-
color?: string;
|
|
6878
|
-
name: null | string;
|
|
6879
|
-
chatMessage: string;
|
|
6880
|
-
}
|
|
6881
|
-
|
|
6882
7618
|
/** @public */
|
|
6883
7619
|
export declare type TLDeepLink = {
|
|
6884
7620
|
bounds: BoxModel;
|
|
@@ -6968,6 +7704,14 @@ export declare interface TldrawEditorBaseProps {
|
|
|
6968
7704
|
* An array of binding utils to use in the editor.
|
|
6969
7705
|
*/
|
|
6970
7706
|
bindingUtils?: readonly TLAnyBindingUtilConstructor[];
|
|
7707
|
+
/**
|
|
7708
|
+
* An array of asset utils to use in the editor.
|
|
7709
|
+
*/
|
|
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[];
|
|
6971
7715
|
/**
|
|
6972
7716
|
* An array of tools to add to the editor's state chart.
|
|
6973
7717
|
*/
|
|
@@ -6997,9 +7741,21 @@ export declare interface TldrawEditorBaseProps {
|
|
|
6997
7741
|
*/
|
|
6998
7742
|
user?: TLCurrentUser;
|
|
6999
7743
|
/**
|
|
7000
|
-
*
|
|
7744
|
+
* The editor's color scheme. Defaults to `'light'`.
|
|
7745
|
+
*
|
|
7746
|
+
* - `'light'` - Always use light mode.
|
|
7747
|
+
* - `'dark'` - Always use dark mode.
|
|
7748
|
+
* - `'system'` - Follow the OS color scheme preference.
|
|
7749
|
+
*/
|
|
7750
|
+
colorScheme?: 'dark' | 'light' | 'system';
|
|
7751
|
+
/**
|
|
7752
|
+
* Named themes for the editor.
|
|
7001
7753
|
*/
|
|
7002
|
-
|
|
7754
|
+
themes?: Partial<TLThemes>;
|
|
7755
|
+
/**
|
|
7756
|
+
* The id of the initially active theme. Defaults to `'default'`.
|
|
7757
|
+
*/
|
|
7758
|
+
initialTheme?: TLThemeId;
|
|
7003
7759
|
/**
|
|
7004
7760
|
* Camera options for the editor.
|
|
7005
7761
|
*
|
|
@@ -7217,6 +7973,12 @@ export declare interface TldrawOptions {
|
|
|
7217
7973
|
* When false, the spacebar will not pan the camera.
|
|
7218
7974
|
*/
|
|
7219
7975
|
readonly spacebarPanning: boolean;
|
|
7976
|
+
/**
|
|
7977
|
+
* Whether to allow right-click + drag to pan the camera. When true, right-click + drag pans the
|
|
7978
|
+
* camera and a static right-click opens the context menu at the release position. When false,
|
|
7979
|
+
* right-click opens the context menu on press (no drag-to-pan).
|
|
7980
|
+
*/
|
|
7981
|
+
readonly rightClickPanning: boolean;
|
|
7220
7982
|
/**
|
|
7221
7983
|
* The default padding (in pixels) used when zooming to fit content in the viewport.
|
|
7222
7984
|
* This affects methods like `zoomToFit()`, `zoomToSelection()`, and `zoomToBounds()`.
|
|
@@ -7346,34 +8108,17 @@ export declare interface TLDropShapesOverInfo {
|
|
|
7346
8108
|
/** @public */
|
|
7347
8109
|
export declare interface TLEditorComponents {
|
|
7348
8110
|
Background?: ComponentType | null;
|
|
7349
|
-
Brush?: ComponentType<TLBrushProps> | null;
|
|
7350
8111
|
Canvas?: ComponentType<TLCanvasComponentProps> | null;
|
|
7351
|
-
CollaboratorBrush?: ComponentType<TLBrushProps> | null;
|
|
7352
|
-
CollaboratorCursor?: ComponentType<TLCursorProps> | null;
|
|
7353
|
-
CollaboratorHint?: ComponentType<TLCollaboratorHintProps> | null;
|
|
7354
|
-
CollaboratorScribble?: ComponentType<TLScribbleProps> | null;
|
|
7355
|
-
CollaboratorShapeIndicator?: ComponentType<TLShapeIndicatorProps> | null;
|
|
7356
|
-
Cursor?: ComponentType<TLCursorProps> | null;
|
|
7357
8112
|
Grid?: ComponentType<TLGridProps> | null;
|
|
7358
|
-
Handle?: ComponentType<TLHandleProps> | null;
|
|
7359
|
-
Handles?: ComponentType<TLHandlesProps> | null;
|
|
7360
8113
|
InFrontOfTheCanvas?: ComponentType | null;
|
|
7361
8114
|
LoadingScreen?: ComponentType | null;
|
|
7362
8115
|
OnTheCanvas?: ComponentType | null;
|
|
7363
|
-
Overlays?: ComponentType | null;
|
|
7364
|
-
Scribble?: ComponentType<TLScribbleProps> | null;
|
|
7365
8116
|
SelectionBackground?: ComponentType<TLSelectionBackgroundProps> | null;
|
|
7366
|
-
SelectionForeground?: ComponentType<TLSelectionForegroundProps> | null;
|
|
7367
|
-
ShapeIndicator?: ComponentType<TLShapeIndicatorProps> | null;
|
|
7368
|
-
ShapeIndicators?: ComponentType | null;
|
|
7369
8117
|
ShapeWrapper?: ComponentType<TLShapeWrapperProps & RefAttributes<HTMLDivElement>> | null;
|
|
7370
|
-
SnapIndicator?: ComponentType<TLSnapIndicatorProps> | null;
|
|
7371
8118
|
Spinner?: ComponentType<React.SVGProps<SVGSVGElement>> | null;
|
|
7372
8119
|
SvgDefs?: ComponentType | null;
|
|
7373
|
-
ZoomBrush?: ComponentType<TLBrushProps> | null;
|
|
7374
8120
|
ErrorFallback?: TLErrorFallbackComponent;
|
|
7375
8121
|
ShapeErrorFallback?: TLShapeErrorFallbackComponent;
|
|
7376
|
-
ShapeIndicatorErrorFallback?: TLShapeIndicatorErrorFallbackComponent;
|
|
7377
8122
|
}
|
|
7378
8123
|
|
|
7379
8124
|
/** @public */
|
|
@@ -7392,14 +8137,18 @@ export declare interface TLEditorOptions {
|
|
|
7392
8137
|
*/
|
|
7393
8138
|
bindingUtils: readonly TLAnyBindingUtilConstructor[];
|
|
7394
8139
|
/**
|
|
7395
|
-
* An array of
|
|
8140
|
+
* An array of asset utils to use in the editor. These will be used to handle asset-type-specific behavior.
|
|
7396
8141
|
*/
|
|
7397
|
-
|
|
8142
|
+
assetUtils?: readonly TLAnyAssetUtilConstructor[];
|
|
7398
8143
|
/**
|
|
7399
|
-
*
|
|
7400
|
-
*
|
|
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.
|
|
7401
8146
|
*/
|
|
7402
|
-
|
|
8147
|
+
overlayUtils?: readonly TLAnyOverlayUtilConstructor[];
|
|
8148
|
+
/**
|
|
8149
|
+
* An array of tools to use in the editor. These will be used to handle events and manage user interactions in the editor.
|
|
8150
|
+
*/
|
|
8151
|
+
tools: readonly TLStateNodeConstructor[];
|
|
7403
8152
|
/**
|
|
7404
8153
|
* A user defined externally to replace the default user.
|
|
7405
8154
|
*/
|
|
@@ -7412,27 +8161,15 @@ export declare interface TLEditorOptions {
|
|
|
7412
8161
|
* Whether to automatically focus the editor when it mounts.
|
|
7413
8162
|
*/
|
|
7414
8163
|
autoFocus?: boolean;
|
|
7415
|
-
/**
|
|
7416
|
-
* Whether to infer dark mode from the user's system preferences. Defaults to false.
|
|
7417
|
-
*/
|
|
7418
|
-
inferDarkMode?: boolean;
|
|
7419
|
-
/**
|
|
7420
|
-
* Options for the editor's camera.
|
|
7421
|
-
*
|
|
7422
|
-
* @deprecated Use `options.cameraOptions` instead. This will be removed in a future release.
|
|
7423
|
-
*/
|
|
7424
|
-
cameraOptions?: Partial<TLCameraOptions>;
|
|
7425
|
-
options?: Partial<TldrawOptions>;
|
|
7426
|
-
/**
|
|
7427
|
-
* Text options for the editor.
|
|
7428
|
-
*
|
|
7429
|
-
* @deprecated Use `options.text` instead. This prop will be removed in a future release.
|
|
7430
|
-
*/
|
|
7431
|
-
textOptions?: TLTextOptions;
|
|
7432
8164
|
licenseKey?: string;
|
|
7433
8165
|
fontAssetUrls?: {
|
|
7434
8166
|
[key: string]: string | undefined;
|
|
7435
8167
|
};
|
|
8168
|
+
/**
|
|
8169
|
+
* Should return a containing html element which has all the styles applied to the editor. If not
|
|
8170
|
+
* given, the body element will be used.
|
|
8171
|
+
*/
|
|
8172
|
+
getContainer(): HTMLElement;
|
|
7436
8173
|
/**
|
|
7437
8174
|
* Provides a way to hide shapes.
|
|
7438
8175
|
*
|
|
@@ -7449,6 +8186,40 @@ export declare interface TLEditorOptions {
|
|
|
7449
8186
|
* @param editor - The editor instance.
|
|
7450
8187
|
*/
|
|
7451
8188
|
getShapeVisibility?(shape: TLShape, editor: Editor): 'hidden' | 'inherit' | 'visible' | null | undefined;
|
|
8189
|
+
/**
|
|
8190
|
+
* Named theme definitions for the editor. Each theme contains shared
|
|
8191
|
+
* properties (font size, line height, stroke width) and color palettes
|
|
8192
|
+
* for both light and dark modes.
|
|
8193
|
+
*/
|
|
8194
|
+
themes?: Partial<TLThemes>;
|
|
8195
|
+
/**
|
|
8196
|
+
* The id of the initially active theme. Defaults to `'default'`.
|
|
8197
|
+
*/
|
|
8198
|
+
initialTheme?: TLThemeId;
|
|
8199
|
+
/**
|
|
8200
|
+
* The editor's color scheme preference, controls the default color mode. Defaults to `'light'`.
|
|
8201
|
+
*
|
|
8202
|
+
* - `'light'` - Always use light mode.
|
|
8203
|
+
* - `'dark'` - Always use dark mode.
|
|
8204
|
+
* - `'system'` - Follow the OS color scheme preference.
|
|
8205
|
+
*/
|
|
8206
|
+
colorScheme?: 'dark' | 'light' | 'system';
|
|
8207
|
+
/**
|
|
8208
|
+
* Additional configuration options for the tldraw editor.
|
|
8209
|
+
*/
|
|
8210
|
+
options?: Partial<TldrawOptions>;
|
|
8211
|
+
/**
|
|
8212
|
+
* Options for the editor's camera.
|
|
8213
|
+
*
|
|
8214
|
+
* @deprecated Use `options.cameraOptions` instead. This will be removed in a future release.
|
|
8215
|
+
*/
|
|
8216
|
+
cameraOptions?: Partial<TLCameraOptions>;
|
|
8217
|
+
/**
|
|
8218
|
+
* Text options for the editor.
|
|
8219
|
+
*
|
|
8220
|
+
* @deprecated Use `options.text` instead. This prop will be removed in a future release.
|
|
8221
|
+
*/
|
|
8222
|
+
textOptions?: TLTextOptions;
|
|
7452
8223
|
}
|
|
7453
8224
|
|
|
7454
8225
|
/**
|
|
@@ -7507,6 +8278,7 @@ export declare const tlenv: {
|
|
|
7507
8278
|
*/
|
|
7508
8279
|
export declare const tlenvReactive: Atom< {
|
|
7509
8280
|
isCoarsePointer: boolean;
|
|
8281
|
+
supportsP3ColorSpace: boolean;
|
|
7510
8282
|
}, unknown>;
|
|
7511
8283
|
|
|
7512
8284
|
/** @public */
|
|
@@ -7635,6 +8407,7 @@ export declare interface TLFileReplaceExternalContent extends TLBaseExternalCont
|
|
|
7635
8407
|
type: 'file-replace';
|
|
7636
8408
|
file: File;
|
|
7637
8409
|
shapeId: TLShapeId;
|
|
8410
|
+
/** @deprecated This field is no longer used by the default handler. It may be removed in a future version. */
|
|
7638
8411
|
isImage: boolean;
|
|
7639
8412
|
}
|
|
7640
8413
|
|
|
@@ -7646,69 +8419,18 @@ export declare interface TLFilesExternalContent extends TLBaseExternalContent {
|
|
|
7646
8419
|
}
|
|
7647
8420
|
|
|
7648
8421
|
/**
|
|
7649
|
-
*
|
|
7650
|
-
* ones in the
|
|
7651
|
-
* {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face | css `@font-face` rule}.
|
|
7652
|
-
* @public
|
|
7653
|
-
*/
|
|
7654
|
-
export declare interface TLFontFace {
|
|
7655
|
-
/**
|
|
7656
|
-
* How this font can be referred to in CSS.
|
|
7657
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-family | `font-family`}.
|
|
7658
|
-
*/
|
|
7659
|
-
readonly family: string;
|
|
7660
|
-
/**
|
|
7661
|
-
* The source of the font. This
|
|
7662
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src | `src`}.
|
|
7663
|
-
*/
|
|
7664
|
-
readonly src: TLFontFaceSource;
|
|
7665
|
-
/**
|
|
7666
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/ascent-override | `ascent-override`}.
|
|
7667
|
-
*/
|
|
7668
|
-
readonly ascentOverride?: string;
|
|
7669
|
-
/**
|
|
7670
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/descent-override | `descent-override`}.
|
|
7671
|
-
*/
|
|
7672
|
-
readonly descentOverride?: string;
|
|
7673
|
-
/**
|
|
7674
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-stretch | `font-stretch`}.
|
|
7675
|
-
*/
|
|
7676
|
-
readonly stretch?: string;
|
|
7677
|
-
/**
|
|
7678
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-style | `font-style`}.
|
|
7679
|
-
*/
|
|
7680
|
-
readonly style?: string;
|
|
7681
|
-
/**
|
|
7682
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-weight | `font-weight`}.
|
|
7683
|
-
*/
|
|
7684
|
-
readonly weight?: string;
|
|
7685
|
-
/**
|
|
7686
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-feature-settings | `font-feature-settings`}.
|
|
7687
|
-
*/
|
|
7688
|
-
readonly featureSettings?: string;
|
|
7689
|
-
/**
|
|
7690
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/line-gap-override | `line-gap-override`}.
|
|
7691
|
-
*/
|
|
7692
|
-
readonly lineGapOverride?: string;
|
|
7693
|
-
/**
|
|
7694
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/unicode-range | `unicode-range`}.
|
|
7695
|
-
*/
|
|
7696
|
-
readonly unicodeRange?: string;
|
|
7697
|
-
}
|
|
7698
|
-
|
|
7699
|
-
/**
|
|
7700
|
-
* Represents the `src` property of a {@link TLFontFace}.
|
|
7701
|
-
* See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src | `src`} for details of the properties here.
|
|
8422
|
+
* Emitted every animation frame when at least one `'frame'` listener is registered.
|
|
7702
8423
|
* @public
|
|
7703
8424
|
*/
|
|
7704
|
-
export declare interface
|
|
7705
|
-
/**
|
|
7706
|
-
|
|
7707
|
-
|
|
7708
|
-
|
|
7709
|
-
|
|
7710
|
-
|
|
7711
|
-
|
|
8425
|
+
export declare interface TLFramePerfEvent {
|
|
8426
|
+
/** Time since the last frame in ms. */
|
|
8427
|
+
elapsed: number;
|
|
8428
|
+
/** Total shapes on the current page. */
|
|
8429
|
+
shapeCount: number;
|
|
8430
|
+
/** Number of shapes culled (off-screen) from rendering. */
|
|
8431
|
+
culledShapeCount: number;
|
|
8432
|
+
/** Number of shapes visible (not culled) in the viewport. */
|
|
8433
|
+
visibleShapeCount: number;
|
|
7712
8434
|
}
|
|
7713
8435
|
|
|
7714
8436
|
/** Additional options for the {@link ShapeUtil.getGeometry} method.
|
|
@@ -7789,20 +8511,6 @@ export declare interface TLHandleDragInfo<T extends TLShape> {
|
|
|
7789
8511
|
initial?: T | undefined;
|
|
7790
8512
|
}
|
|
7791
8513
|
|
|
7792
|
-
/** @public */
|
|
7793
|
-
export declare interface TLHandleProps {
|
|
7794
|
-
shapeId: TLShapeId;
|
|
7795
|
-
handle: TLHandle;
|
|
7796
|
-
zoom: number;
|
|
7797
|
-
isCoarse: boolean;
|
|
7798
|
-
className?: string;
|
|
7799
|
-
}
|
|
7800
|
-
|
|
7801
|
-
/** @public */
|
|
7802
|
-
export declare interface TLHandlesProps {
|
|
7803
|
-
children: ReactNode;
|
|
7804
|
-
}
|
|
7805
|
-
|
|
7806
8514
|
/** @public */
|
|
7807
8515
|
export declare interface TLHistoryBatchOptions {
|
|
7808
8516
|
/**
|
|
@@ -7853,6 +8561,38 @@ export declare type TLIndicatorPath = {
|
|
|
7853
8561
|
path: Path2D;
|
|
7854
8562
|
} | Path2D;
|
|
7855
8563
|
|
|
8564
|
+
/**
|
|
8565
|
+
* Emitted when an interaction state is exited, with aggregated frame time stats.
|
|
8566
|
+
* @public
|
|
8567
|
+
*/
|
|
8568
|
+
export declare interface TLInteractionEndPerfEvent extends TLPerfFrameTimeStats {
|
|
8569
|
+
/** The state node id (e.g. `'translating'`). */
|
|
8570
|
+
name: string;
|
|
8571
|
+
/** Full tool path (e.g. `'select.translating'`). */
|
|
8572
|
+
path: string;
|
|
8573
|
+
/** Total shapes on the current page. */
|
|
8574
|
+
shapeCount: number;
|
|
8575
|
+
/** Breakdown of selected shape types at interaction start (e.g. `{ geo: 2, draw: 1 }`). */
|
|
8576
|
+
selectedShapeTypes: Record<string, number>;
|
|
8577
|
+
/** Camera zoom level (`camera.z`) at interaction end. */
|
|
8578
|
+
zoomLevel: number;
|
|
8579
|
+
/** `performance.now()` when the interaction ended. */
|
|
8580
|
+
timestamp: number;
|
|
8581
|
+
}
|
|
8582
|
+
|
|
8583
|
+
/**
|
|
8584
|
+
* Emitted when an interaction state (e.g. translating, resizing) is entered.
|
|
8585
|
+
* @public
|
|
8586
|
+
*/
|
|
8587
|
+
export declare interface TLInteractionStartPerfEvent {
|
|
8588
|
+
/** The state node id (e.g. `'translating'`). */
|
|
8589
|
+
name: string;
|
|
8590
|
+
/** Full tool path (e.g. `'select.translating'`). */
|
|
8591
|
+
path: string;
|
|
8592
|
+
/** `performance.now()` when the interaction started. */
|
|
8593
|
+
timestamp: number;
|
|
8594
|
+
}
|
|
8595
|
+
|
|
7856
8596
|
/** @public */
|
|
7857
8597
|
export declare type TLInterruptEvent = (info: TLInterruptEventInfo) => void;
|
|
7858
8598
|
|
|
@@ -8100,6 +8840,130 @@ export declare const tlmenus: {
|
|
|
8100
8840
|
*/
|
|
8101
8841
|
export declare type TLOnMountHandler = (editor: Editor) => (() => undefined | void) | undefined | void;
|
|
8102
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
|
+
|
|
8879
|
+
/**
|
|
8880
|
+
* Map of all performance event names to their payload types.
|
|
8881
|
+
* Used with {@link PerformanceManager.on} and {@link PerformanceManager.once}.
|
|
8882
|
+
* @public
|
|
8883
|
+
*/
|
|
8884
|
+
export declare interface TLPerfEventMap {
|
|
8885
|
+
/** An interaction state was entered. */
|
|
8886
|
+
'interaction-start': [TLInteractionStartPerfEvent];
|
|
8887
|
+
/** An interaction state was exited, with aggregated frame time stats. */
|
|
8888
|
+
'interaction-end': [TLInteractionEndPerfEvent];
|
|
8889
|
+
/** A camera operation (pan/zoom) began. */
|
|
8890
|
+
'camera-start': [TLCameraStartPerfEvent];
|
|
8891
|
+
/** A camera operation ended (after debounce), with aggregated frame time stats. */
|
|
8892
|
+
'camera-end': [TLCameraEndPerfEvent];
|
|
8893
|
+
/** Shapes were created. */
|
|
8894
|
+
'shapes-created': [TLShapeOperationPerfEvent];
|
|
8895
|
+
/** Shapes were updated. */
|
|
8896
|
+
'shapes-updated': [TLShapeOperationPerfEvent];
|
|
8897
|
+
/** Shapes were deleted. */
|
|
8898
|
+
'shapes-deleted': [TLShapeOperationPerfEvent];
|
|
8899
|
+
/** An animation frame was rendered. Only fires when listeners are registered. */
|
|
8900
|
+
frame: [TLFramePerfEvent];
|
|
8901
|
+
/** An undo operation was performed. */
|
|
8902
|
+
undo: [TLUndoRedoPerfEvent];
|
|
8903
|
+
/** A redo operation was performed. */
|
|
8904
|
+
redo: [TLUndoRedoPerfEvent];
|
|
8905
|
+
}
|
|
8906
|
+
|
|
8907
|
+
/**
|
|
8908
|
+
* Common frame time statistics shared by interaction and camera end events.
|
|
8909
|
+
* @public
|
|
8910
|
+
*/
|
|
8911
|
+
export declare interface TLPerfFrameTimeStats {
|
|
8912
|
+
/** Total duration of the session in ms. */
|
|
8913
|
+
duration: number;
|
|
8914
|
+
/** Average frames per second during the session. */
|
|
8915
|
+
fps: number;
|
|
8916
|
+
/** Total number of frames recorded. */
|
|
8917
|
+
frameCount: number;
|
|
8918
|
+
/** Mean frame duration in ms. */
|
|
8919
|
+
avgFrameTime: number;
|
|
8920
|
+
/** Median (p50) frame duration in ms. */
|
|
8921
|
+
medianFrameTime: number;
|
|
8922
|
+
/** 95th percentile frame duration in ms. */
|
|
8923
|
+
p95FrameTime: number;
|
|
8924
|
+
/** 99th percentile frame duration in ms. */
|
|
8925
|
+
p99FrameTime: number;
|
|
8926
|
+
/** Shortest frame duration in ms. */
|
|
8927
|
+
minFrameTime: number;
|
|
8928
|
+
/** Longest frame duration in ms. */
|
|
8929
|
+
maxFrameTime: number;
|
|
8930
|
+
/** Raw frame durations for local analysis. Exclude when sending to analytics. */
|
|
8931
|
+
frameTimes: number[];
|
|
8932
|
+
/**
|
|
8933
|
+
* Long animation frames observed during this period (Chromium 123+).
|
|
8934
|
+
* Only present when the browser supports the Long Animation Frames API and
|
|
8935
|
+
* at least one long frame was observed.
|
|
8936
|
+
* Exclude when sending to analytics — entries are large and contain script URLs.
|
|
8937
|
+
*/
|
|
8938
|
+
longAnimationFrames?: TLPerfLongAnimationFrame[];
|
|
8939
|
+
}
|
|
8940
|
+
|
|
8941
|
+
/**
|
|
8942
|
+
* A long animation frame observed by the browser during an interaction.
|
|
8943
|
+
* Available only in browsers that support the Long Animation Frames API (Chromium 123+).
|
|
8944
|
+
* @public
|
|
8945
|
+
*/
|
|
8946
|
+
export declare interface TLPerfLongAnimationFrame {
|
|
8947
|
+
/** Frame start time (relative to timeOrigin). */
|
|
8948
|
+
startTime: number;
|
|
8949
|
+
/** Total frame duration in ms. */
|
|
8950
|
+
duration: number;
|
|
8951
|
+
/** Time the main thread was blocked in ms. */
|
|
8952
|
+
blockingDuration: number;
|
|
8953
|
+
/** Scripts that contributed to the long frame. */
|
|
8954
|
+
scripts: TLPerfLongAnimationFrameScript[];
|
|
8955
|
+
}
|
|
8956
|
+
|
|
8957
|
+
/** A script attribution entry from a long animation frame. @public */
|
|
8958
|
+
export declare interface TLPerfLongAnimationFrameScript {
|
|
8959
|
+
/** The script source URL (may be empty for inline scripts). */
|
|
8960
|
+
sourceURL: string;
|
|
8961
|
+
/** The function name or invoker description. */
|
|
8962
|
+
invoker: string;
|
|
8963
|
+
/** Time spent in this script in ms. */
|
|
8964
|
+
duration: number;
|
|
8965
|
+
}
|
|
8966
|
+
|
|
8103
8967
|
/** @public */
|
|
8104
8968
|
export declare type TLPinchEvent = (info: TLPinchEventInfo) => void;
|
|
8105
8969
|
|
|
@@ -8139,6 +9003,10 @@ export declare type TLPointerEventTarget = {
|
|
|
8139
9003
|
handle?: TLSelectionHandle;
|
|
8140
9004
|
shape?: undefined;
|
|
8141
9005
|
target: 'selection';
|
|
9006
|
+
} | {
|
|
9007
|
+
overlay: TLOverlay;
|
|
9008
|
+
shape?: undefined;
|
|
9009
|
+
target: 'overlay';
|
|
8142
9010
|
} | {
|
|
8143
9011
|
shape: TLShape;
|
|
8144
9012
|
target: 'shape';
|
|
@@ -8209,28 +9077,12 @@ export declare type TLResizeShapeOptions = Partial<{
|
|
|
8209
9077
|
|
|
8210
9078
|
/* Excluded from this release type: TLRotationSnapshot */
|
|
8211
9079
|
|
|
8212
|
-
/** @public */
|
|
8213
|
-
export declare interface TLScribbleProps {
|
|
8214
|
-
userId?: string;
|
|
8215
|
-
scribble: TLScribble;
|
|
8216
|
-
zoom: number;
|
|
8217
|
-
color?: string;
|
|
8218
|
-
opacity?: number;
|
|
8219
|
-
className?: string;
|
|
8220
|
-
}
|
|
8221
|
-
|
|
8222
9080
|
/** @public */
|
|
8223
9081
|
export declare interface TLSelectionBackgroundProps {
|
|
8224
9082
|
bounds: Box;
|
|
8225
9083
|
rotation: number;
|
|
8226
9084
|
}
|
|
8227
9085
|
|
|
8228
|
-
/** @public */
|
|
8229
|
-
export declare interface TLSelectionForegroundProps {
|
|
8230
|
-
bounds: Box;
|
|
8231
|
-
rotation: number;
|
|
8232
|
-
}
|
|
8233
|
-
|
|
8234
9086
|
/** @public */
|
|
8235
9087
|
export declare type TLSelectionHandle = RotateCorner | SelectionCorner | SelectionEdge;
|
|
8236
9088
|
|
|
@@ -8265,26 +9117,26 @@ export declare type TLShapeErrorFallbackComponent = ComponentType<{
|
|
|
8265
9117
|
}>;
|
|
8266
9118
|
|
|
8267
9119
|
/** @public */
|
|
8268
|
-
export declare
|
|
8269
|
-
|
|
8270
|
-
|
|
8271
|
-
|
|
8272
|
-
|
|
8273
|
-
export declare interface TLShapeIndicatorProps {
|
|
8274
|
-
userId?: string;
|
|
8275
|
-
shapeId: TLShapeId;
|
|
8276
|
-
color?: string | undefined;
|
|
8277
|
-
opacity?: number;
|
|
8278
|
-
className?: string;
|
|
8279
|
-
hidden?: boolean;
|
|
9120
|
+
export declare interface TLShapeIndicatorOverlay extends TLOverlay {
|
|
9121
|
+
props: {
|
|
9122
|
+
hintingShapeIds: TLShapeId[];
|
|
9123
|
+
idsToDisplay: TLShapeId[];
|
|
9124
|
+
};
|
|
8280
9125
|
}
|
|
8281
9126
|
|
|
8282
|
-
/**
|
|
8283
|
-
|
|
8284
|
-
|
|
8285
|
-
|
|
8286
|
-
|
|
8287
|
-
|
|
9127
|
+
/**
|
|
9128
|
+
* Emitted when shapes are created, updated, or deleted.
|
|
9129
|
+
* @public
|
|
9130
|
+
*/
|
|
9131
|
+
export declare interface TLShapeOperationPerfEvent {
|
|
9132
|
+
/** The operation type. */
|
|
9133
|
+
operation: 'create' | 'delete' | 'update';
|
|
9134
|
+
/** Number of shapes affected. */
|
|
9135
|
+
count: number;
|
|
9136
|
+
/** Breakdown by shape type (e.g. `{ geo: 2, draw: 1 }`). */
|
|
9137
|
+
shapeTypes: Record<string, number>;
|
|
9138
|
+
/** `performance.now()` when the operation occurred. */
|
|
9139
|
+
timestamp: number;
|
|
8288
9140
|
}
|
|
8289
9141
|
|
|
8290
9142
|
/**
|
|
@@ -8344,6 +9196,7 @@ export declare interface TLShapeUtilConstructor<T extends TLShape, U extends Sha
|
|
|
8344
9196
|
type: T['type'];
|
|
8345
9197
|
props?: RecordProps<T>;
|
|
8346
9198
|
migrations?: LegacyMigrations | MigrationSequence | TLPropsMigrations;
|
|
9199
|
+
handledAssetTypes?: readonly string[];
|
|
8347
9200
|
}
|
|
8348
9201
|
|
|
8349
9202
|
/** @public */
|
|
@@ -8356,13 +9209,6 @@ export declare interface TLShapeWrapperProps extends React.HTMLAttributes<HTMLDi
|
|
|
8356
9209
|
children: ReactNode;
|
|
8357
9210
|
}
|
|
8358
9211
|
|
|
8359
|
-
/** @public */
|
|
8360
|
-
export declare interface TLSnapIndicatorProps {
|
|
8361
|
-
className?: string;
|
|
8362
|
-
line: SnapIndicator;
|
|
8363
|
-
zoom: number;
|
|
8364
|
-
}
|
|
8365
|
-
|
|
8366
9212
|
/** @public */
|
|
8367
9213
|
export declare interface TLStateNodeConstructor {
|
|
8368
9214
|
new (editor: Editor, parent?: StateNode): StateNode;
|
|
@@ -8371,6 +9217,7 @@ export declare interface TLStateNodeConstructor {
|
|
|
8371
9217
|
children?(): TLStateNodeConstructor[];
|
|
8372
9218
|
isLockable: boolean;
|
|
8373
9219
|
useCoalescedEvents: boolean;
|
|
9220
|
+
trackPerformance: boolean;
|
|
8374
9221
|
}
|
|
8375
9222
|
|
|
8376
9223
|
/** @public */
|
|
@@ -8383,6 +9230,12 @@ export declare interface TLStoreBaseOptions {
|
|
|
8383
9230
|
defaultName?: string;
|
|
8384
9231
|
/** How should this store upload & resolve assets? */
|
|
8385
9232
|
assets?: TLAssetStore;
|
|
9233
|
+
/**
|
|
9234
|
+
* Named theme definitions. When provided, custom color names are automatically
|
|
9235
|
+
* registered before the store is constructed so persisted data with those
|
|
9236
|
+
* colors passes validation on load.
|
|
9237
|
+
*/
|
|
9238
|
+
themes?: Partial<TLThemes>;
|
|
8386
9239
|
/** How should this store resolve users for attribution? */
|
|
8387
9240
|
users?: TLUserStore;
|
|
8388
9241
|
/** Called when the store is connected to an {@link @tldraw/editor#Editor}. */
|
|
@@ -8404,6 +9257,7 @@ export declare type TLStoreOptions = TLStoreBaseOptions & {
|
|
|
8404
9257
|
|
|
8405
9258
|
/** @public */
|
|
8406
9259
|
export declare type TLStoreSchemaOptions = {
|
|
9260
|
+
assetUtils?: readonly TLAnyAssetUtilConstructor[];
|
|
8407
9261
|
bindingUtils?: readonly TLAnyBindingUtilConstructor[];
|
|
8408
9262
|
migrations?: readonly MigrationSequence[];
|
|
8409
9263
|
records?: Record<string, CustomRecordInfo>;
|
|
@@ -8541,6 +9395,19 @@ export declare interface TLTldrawExternalContentSource {
|
|
|
8541
9395
|
data: TLContent;
|
|
8542
9396
|
}
|
|
8543
9397
|
|
|
9398
|
+
/**
|
|
9399
|
+
* Emitted after an undo or redo operation.
|
|
9400
|
+
* @public
|
|
9401
|
+
*/
|
|
9402
|
+
export declare interface TLUndoRedoPerfEvent {
|
|
9403
|
+
/** Whether this was an undo or redo. */
|
|
9404
|
+
type: 'redo' | 'undo';
|
|
9405
|
+
/** Number of undo steps remaining. */
|
|
9406
|
+
undoDepth: number;
|
|
9407
|
+
/** Number of redo steps remaining. */
|
|
9408
|
+
redoDepth: number;
|
|
9409
|
+
}
|
|
9410
|
+
|
|
8544
9411
|
/** @public */
|
|
8545
9412
|
export declare interface TLUpdatePointerOptions {
|
|
8546
9413
|
/** Whether to update the pointer immediately, rather than on the next tick. */
|
|
@@ -8672,6 +9539,9 @@ export declare function uniq<T>(array: {
|
|
|
8672
9539
|
readonly length: number;
|
|
8673
9540
|
} | null | undefined): T[];
|
|
8674
9541
|
|
|
9542
|
+
/** @public */
|
|
9543
|
+
export declare function useColorMode(): 'dark' | 'light';
|
|
9544
|
+
|
|
8675
9545
|
/** @public */
|
|
8676
9546
|
export declare function useContainer(): HTMLElement;
|
|
8677
9547
|
|
|
@@ -8710,9 +9580,6 @@ export declare function useGlobalMenuIsOpen(id: string, onChange?: (isOpen: bool
|
|
|
8710
9580
|
/** @public */
|
|
8711
9581
|
export declare function useIsCropping(shapeId: TLShapeId): boolean;
|
|
8712
9582
|
|
|
8713
|
-
/** @public */
|
|
8714
|
-
export declare function useIsDarkMode(): boolean;
|
|
8715
|
-
|
|
8716
9583
|
/** @public */
|
|
8717
9584
|
export declare function useIsEditing(shapeId: TLShapeId): boolean;
|
|
8718
9585
|
|
|
@@ -8730,6 +9597,10 @@ export declare function usePassThroughMouseOverEvents(ref: RefObject<HTMLElement
|
|
|
8730
9597
|
export declare function usePassThroughWheelEvents(ref: RefObject<HTMLElement | null>): void;
|
|
8731
9598
|
|
|
8732
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
|
+
*
|
|
8733
9604
|
* @returns The list of peer UserIDs
|
|
8734
9605
|
* @public
|
|
8735
9606
|
*/
|
|
@@ -8750,11 +9621,11 @@ export declare function usePresence(userId: string): null | TLInstancePresence;
|
|
|
8750
9621
|
/** @public */
|
|
8751
9622
|
export declare class UserPreferencesManager {
|
|
8752
9623
|
private readonly user;
|
|
8753
|
-
private readonly
|
|
9624
|
+
private readonly colorScheme;
|
|
8754
9625
|
systemColorScheme: Atom<"dark" | "light", unknown>;
|
|
8755
9626
|
disposables: Set<() => void>;
|
|
8756
9627
|
dispose(): void;
|
|
8757
|
-
constructor(user: TLCurrentUser,
|
|
9628
|
+
constructor(user: TLCurrentUser, colorScheme: 'dark' | 'light' | 'system');
|
|
8758
9629
|
updateUserPreferences(userPreferences: Partial<TLUserPreferences>): void;
|
|
8759
9630
|
getUserPreferences(): {
|
|
8760
9631
|
animationSpeed: number;
|