@tldraw/editor 4.6.0-canary.f1cd46b631a4 → 4.6.0-canary.f43f2cd364c0

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.
Files changed (394) hide show
  1. package/dist-cjs/index.d.ts +1197 -284
  2. package/dist-cjs/index.js +31 -26
  3. package/dist-cjs/index.js.map +3 -3
  4. package/dist-cjs/lib/TldrawEditor.js +62 -14
  5. package/dist-cjs/lib/TldrawEditor.js.map +3 -3
  6. package/dist-cjs/lib/components/MenuClickCapture.js +99 -38
  7. package/dist-cjs/lib/components/MenuClickCapture.js.map +2 -2
  8. package/dist-cjs/lib/components/default-components/CanvasOverlays.js +180 -0
  9. package/dist-cjs/lib/components/default-components/CanvasOverlays.js.map +7 -0
  10. package/dist-cjs/lib/components/default-components/DefaultCanvas.js +33 -236
  11. package/dist-cjs/lib/components/default-components/DefaultCanvas.js.map +3 -3
  12. package/dist-cjs/lib/config/{createTLUser.js → createTLCurrentUser.js} +9 -9
  13. package/dist-cjs/lib/config/createTLCurrentUser.js.map +7 -0
  14. package/dist-cjs/lib/config/createTLStore.js +30 -0
  15. package/dist-cjs/lib/config/createTLStore.js.map +2 -2
  16. package/dist-cjs/lib/{components/default-components/DefaultShapeIndicatorErrorFallback.js → config/defaultAssets.js} +17 -9
  17. package/dist-cjs/lib/config/defaultAssets.js.map +7 -0
  18. package/dist-cjs/lib/editor/Editor.js +467 -41
  19. package/dist-cjs/lib/editor/Editor.js.map +3 -3
  20. package/dist-cjs/lib/editor/assets/AssetUtil.js +67 -0
  21. package/dist-cjs/lib/editor/assets/AssetUtil.js.map +7 -0
  22. package/dist-cjs/lib/editor/bindings/BindingUtil.js +1 -0
  23. package/dist-cjs/lib/editor/bindings/BindingUtil.js.map +1 -1
  24. package/dist-cjs/lib/editor/managers/ClickManager/ClickManager.js +1 -0
  25. package/dist-cjs/lib/editor/managers/ClickManager/ClickManager.js.map +1 -1
  26. package/dist-cjs/lib/editor/managers/CollaboratorsManager/CollaboratorsManager.js +98 -0
  27. package/dist-cjs/lib/editor/managers/CollaboratorsManager/CollaboratorsManager.js.map +7 -0
  28. package/dist-cjs/lib/editor/managers/EdgeScrollManager/EdgeScrollManager.js +1 -0
  29. package/dist-cjs/lib/editor/managers/EdgeScrollManager/EdgeScrollManager.js.map +1 -1
  30. package/dist-cjs/lib/editor/managers/FocusManager/FocusManager.js +1 -0
  31. package/dist-cjs/lib/editor/managers/FocusManager/FocusManager.js.map +1 -1
  32. package/dist-cjs/lib/editor/managers/FontManager/FontManager.js +2 -0
  33. package/dist-cjs/lib/editor/managers/FontManager/FontManager.js.map +2 -2
  34. package/dist-cjs/lib/editor/managers/HistoryManager/HistoryManager.js +2 -0
  35. package/dist-cjs/lib/editor/managers/HistoryManager/HistoryManager.js.map +1 -1
  36. package/dist-cjs/lib/editor/managers/InputsManager/InputsManager.js +12 -0
  37. package/dist-cjs/lib/editor/managers/InputsManager/InputsManager.js.map +2 -2
  38. package/dist-cjs/lib/editor/managers/PerformanceManager/PerformanceApiAdapter.js +80 -0
  39. package/dist-cjs/lib/editor/managers/PerformanceManager/PerformanceApiAdapter.js.map +7 -0
  40. package/dist-cjs/lib/editor/managers/PerformanceManager/PerformanceManager.js +466 -0
  41. package/dist-cjs/lib/editor/managers/PerformanceManager/PerformanceManager.js.map +7 -0
  42. package/dist-cjs/lib/{components/default-components/DefaultHandles.js → editor/managers/PerformanceManager/perf-types.js} +3 -14
  43. package/dist-cjs/lib/editor/managers/PerformanceManager/perf-types.js.map +7 -0
  44. package/dist-cjs/lib/editor/managers/ScribbleManager/ScribbleManager.js +1 -0
  45. package/dist-cjs/lib/editor/managers/ScribbleManager/ScribbleManager.js.map +1 -1
  46. package/dist-cjs/lib/editor/managers/SnapManager/BoundsSnaps.js +1 -0
  47. package/dist-cjs/lib/editor/managers/SnapManager/BoundsSnaps.js.map +1 -1
  48. package/dist-cjs/lib/editor/managers/SnapManager/HandleSnaps.js +1 -0
  49. package/dist-cjs/lib/editor/managers/SnapManager/HandleSnaps.js.map +1 -1
  50. package/dist-cjs/lib/editor/managers/SnapManager/SnapManager.js +2 -1
  51. package/dist-cjs/lib/editor/managers/SnapManager/SnapManager.js.map +2 -2
  52. package/dist-cjs/lib/editor/managers/SpatialIndexManager/SpatialIndexManager.js +5 -4
  53. package/dist-cjs/lib/editor/managers/SpatialIndexManager/SpatialIndexManager.js.map +2 -2
  54. package/dist-cjs/lib/editor/managers/TextManager/TextManager.js +1 -0
  55. package/dist-cjs/lib/editor/managers/TextManager/TextManager.js.map +1 -1
  56. package/dist-cjs/lib/editor/managers/ThemeManager/ThemeManager.js +107 -0
  57. package/dist-cjs/lib/editor/managers/ThemeManager/ThemeManager.js.map +7 -0
  58. package/dist-cjs/lib/editor/managers/ThemeManager/defaultThemes.js +600 -0
  59. package/dist-cjs/lib/editor/managers/ThemeManager/defaultThemes.js.map +7 -0
  60. package/dist-cjs/lib/editor/managers/TickManager/TickManager.js +1 -0
  61. package/dist-cjs/lib/editor/managers/TickManager/TickManager.js.map +1 -1
  62. package/dist-cjs/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.js +8 -4
  63. package/dist-cjs/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.js.map +2 -2
  64. package/dist-cjs/lib/editor/overlays/OverlayManager.js +154 -0
  65. package/dist-cjs/lib/editor/overlays/OverlayManager.js.map +7 -0
  66. package/dist-cjs/lib/editor/overlays/OverlayUtil.js +92 -0
  67. package/dist-cjs/lib/editor/overlays/OverlayUtil.js.map +7 -0
  68. package/dist-cjs/lib/editor/overlays/ShapeIndicatorOverlayUtil.js +161 -0
  69. package/dist-cjs/lib/editor/overlays/ShapeIndicatorOverlayUtil.js.map +7 -0
  70. package/dist-cjs/lib/editor/shapes/BaseFrameLikeShapeUtil.js +76 -0
  71. package/dist-cjs/lib/editor/shapes/BaseFrameLikeShapeUtil.js.map +7 -0
  72. package/dist-cjs/lib/editor/shapes/ShapeUtil.js +35 -20
  73. package/dist-cjs/lib/editor/shapes/ShapeUtil.js.map +2 -2
  74. package/dist-cjs/lib/editor/shapes/group/GroupShapeUtil.js +33 -3
  75. package/dist-cjs/lib/editor/shapes/group/GroupShapeUtil.js.map +2 -2
  76. package/dist-cjs/lib/editor/shapes/shared/getPerfectDashProps.js +6 -0
  77. package/dist-cjs/lib/editor/shapes/shared/getPerfectDashProps.js.map +2 -2
  78. package/dist-cjs/lib/editor/tools/StateNode.js +15 -17
  79. package/dist-cjs/lib/editor/tools/StateNode.js.map +2 -2
  80. package/dist-cjs/lib/editor/types/SvgExportContext.js.map +2 -2
  81. package/dist-cjs/lib/editor/types/clipboard-types.js.map +1 -1
  82. package/dist-cjs/lib/editor/types/event-types.js.map +2 -2
  83. package/dist-cjs/lib/editor/types/external-content.js.map +1 -1
  84. package/dist-cjs/lib/exports/ExportDelay.js +1 -0
  85. package/dist-cjs/lib/exports/ExportDelay.js.map +1 -1
  86. package/dist-cjs/lib/exports/StyleEmbedder.js +1 -0
  87. package/dist-cjs/lib/exports/StyleEmbedder.js.map +1 -1
  88. package/dist-cjs/lib/exports/fetchCache.js +1 -1
  89. package/dist-cjs/lib/exports/fetchCache.js.map +2 -2
  90. package/dist-cjs/lib/exports/getSvgJsx.js +14 -8
  91. package/dist-cjs/lib/exports/getSvgJsx.js.map +2 -2
  92. package/dist-cjs/lib/globals/environment.js +18 -1
  93. package/dist-cjs/lib/globals/environment.js.map +2 -2
  94. package/dist-cjs/lib/hooks/EditorComponentsContext.js.map +2 -2
  95. package/dist-cjs/lib/hooks/useCanvasEvents.js +25 -4
  96. package/dist-cjs/lib/hooks/useCanvasEvents.js.map +2 -2
  97. package/dist-cjs/lib/hooks/{useIsDarkMode.js → useColorMode.js} +14 -10
  98. package/dist-cjs/lib/hooks/useColorMode.js.map +7 -0
  99. package/dist-cjs/lib/hooks/useCursor.js +3 -7
  100. package/dist-cjs/lib/hooks/useCursor.js.map +2 -2
  101. package/dist-cjs/lib/hooks/useDarkMode.js +4 -4
  102. package/dist-cjs/lib/hooks/useDarkMode.js.map +2 -2
  103. package/dist-cjs/lib/hooks/useEditorComponents.js +0 -28
  104. package/dist-cjs/lib/hooks/useEditorComponents.js.map +2 -2
  105. package/dist-cjs/lib/hooks/useGestureEvents.js +171 -127
  106. package/dist-cjs/lib/hooks/useGestureEvents.js.map +3 -3
  107. package/dist-cjs/lib/hooks/usePeerIds.js +1 -36
  108. package/dist-cjs/lib/hooks/usePeerIds.js.map +2 -2
  109. package/dist-cjs/lib/hooks/useShapeCulling.js +2 -1
  110. package/dist-cjs/lib/hooks/useShapeCulling.js.map +2 -2
  111. package/dist-cjs/lib/options.js +1 -0
  112. package/dist-cjs/lib/options.js.map +2 -2
  113. package/dist-cjs/lib/primitives/Vec.js +3 -0
  114. package/dist-cjs/lib/primitives/Vec.js.map +1 -1
  115. package/dist-cjs/lib/primitives/geometry/Circle2d.js +1 -0
  116. package/dist-cjs/lib/primitives/geometry/Circle2d.js.map +1 -1
  117. package/dist-cjs/lib/primitives/geometry/Ellipse2d.js +1 -0
  118. package/dist-cjs/lib/primitives/geometry/Ellipse2d.js.map +1 -1
  119. package/dist-cjs/lib/primitives/geometry/Geometry2d.js +4 -1
  120. package/dist-cjs/lib/primitives/geometry/Geometry2d.js.map +2 -2
  121. package/dist-cjs/lib/primitives/geometry/Stadium2d.js +1 -0
  122. package/dist-cjs/lib/primitives/geometry/Stadium2d.js.map +1 -1
  123. package/dist-cjs/lib/utils/EditorAtom.js +2 -0
  124. package/dist-cjs/lib/utils/EditorAtom.js.map +1 -1
  125. package/dist-cjs/lib/utils/reparenting.js +2 -1
  126. package/dist-cjs/lib/utils/reparenting.js.map +2 -2
  127. package/dist-cjs/lib/utils/richText.js.map +2 -2
  128. package/dist-cjs/lib/utils/runtime.js +2 -1
  129. package/dist-cjs/lib/utils/runtime.js.map +2 -2
  130. package/dist-cjs/lib/utils/sync/TLLocalSyncClient.js +5 -0
  131. package/dist-cjs/lib/utils/sync/TLLocalSyncClient.js.map +2 -2
  132. package/dist-cjs/lib/utils/sync/hardReset.js +0 -8
  133. package/dist-cjs/lib/utils/sync/hardReset.js.map +2 -2
  134. package/dist-cjs/version.js +3 -3
  135. package/dist-cjs/version.js.map +1 -1
  136. package/dist-esm/index.d.mts +1197 -284
  137. package/dist-esm/index.mjs +41 -47
  138. package/dist-esm/index.mjs.map +2 -2
  139. package/dist-esm/lib/TldrawEditor.mjs +65 -14
  140. package/dist-esm/lib/TldrawEditor.mjs.map +3 -3
  141. package/dist-esm/lib/components/MenuClickCapture.mjs +100 -39
  142. package/dist-esm/lib/components/MenuClickCapture.mjs.map +2 -2
  143. package/dist-esm/lib/components/default-components/CanvasOverlays.mjs +160 -0
  144. package/dist-esm/lib/components/default-components/CanvasOverlays.mjs.map +7 -0
  145. package/dist-esm/lib/components/default-components/DefaultCanvas.mjs +34 -237
  146. package/dist-esm/lib/components/default-components/DefaultCanvas.mjs.map +3 -3
  147. package/dist-esm/lib/config/{createTLUser.mjs → createTLCurrentUser.mjs} +6 -6
  148. package/dist-esm/lib/config/createTLCurrentUser.mjs.map +7 -0
  149. package/dist-esm/lib/config/createTLStore.mjs +36 -1
  150. package/dist-esm/lib/config/createTLStore.mjs.map +2 -2
  151. package/dist-esm/lib/config/defaultAssets.mjs +16 -0
  152. package/dist-esm/lib/config/defaultAssets.mjs.map +7 -0
  153. package/dist-esm/lib/editor/Editor.mjs +469 -42
  154. package/dist-esm/lib/editor/Editor.mjs.map +3 -3
  155. package/dist-esm/lib/editor/assets/AssetUtil.mjs +47 -0
  156. package/dist-esm/lib/editor/assets/AssetUtil.mjs.map +7 -0
  157. package/dist-esm/lib/editor/bindings/BindingUtil.mjs +1 -0
  158. package/dist-esm/lib/editor/bindings/BindingUtil.mjs.map +1 -1
  159. package/dist-esm/lib/editor/managers/ClickManager/ClickManager.mjs +1 -0
  160. package/dist-esm/lib/editor/managers/ClickManager/ClickManager.mjs.map +1 -1
  161. package/dist-esm/lib/editor/managers/CollaboratorsManager/CollaboratorsManager.mjs +83 -0
  162. package/dist-esm/lib/editor/managers/CollaboratorsManager/CollaboratorsManager.mjs.map +7 -0
  163. package/dist-esm/lib/editor/managers/EdgeScrollManager/EdgeScrollManager.mjs +1 -0
  164. package/dist-esm/lib/editor/managers/EdgeScrollManager/EdgeScrollManager.mjs.map +1 -1
  165. package/dist-esm/lib/editor/managers/FocusManager/FocusManager.mjs +1 -0
  166. package/dist-esm/lib/editor/managers/FocusManager/FocusManager.mjs.map +1 -1
  167. package/dist-esm/lib/editor/managers/FontManager/FontManager.mjs +2 -0
  168. package/dist-esm/lib/editor/managers/FontManager/FontManager.mjs.map +2 -2
  169. package/dist-esm/lib/editor/managers/HistoryManager/HistoryManager.mjs +2 -0
  170. package/dist-esm/lib/editor/managers/HistoryManager/HistoryManager.mjs.map +1 -1
  171. package/dist-esm/lib/editor/managers/InputsManager/InputsManager.mjs +12 -0
  172. package/dist-esm/lib/editor/managers/InputsManager/InputsManager.mjs.map +2 -2
  173. package/dist-esm/lib/editor/managers/PerformanceManager/PerformanceApiAdapter.mjs +60 -0
  174. package/dist-esm/lib/editor/managers/PerformanceManager/PerformanceApiAdapter.mjs.map +7 -0
  175. package/dist-esm/lib/editor/managers/PerformanceManager/PerformanceManager.mjs +438 -0
  176. package/dist-esm/lib/editor/managers/PerformanceManager/PerformanceManager.mjs.map +7 -0
  177. package/dist-esm/lib/editor/managers/PerformanceManager/perf-types.mjs +1 -0
  178. package/dist-esm/lib/editor/managers/PerformanceManager/perf-types.mjs.map +7 -0
  179. package/dist-esm/lib/editor/managers/ScribbleManager/ScribbleManager.mjs +1 -0
  180. package/dist-esm/lib/editor/managers/ScribbleManager/ScribbleManager.mjs.map +1 -1
  181. package/dist-esm/lib/editor/managers/SnapManager/BoundsSnaps.mjs +1 -0
  182. package/dist-esm/lib/editor/managers/SnapManager/BoundsSnaps.mjs.map +1 -1
  183. package/dist-esm/lib/editor/managers/SnapManager/HandleSnaps.mjs +1 -0
  184. package/dist-esm/lib/editor/managers/SnapManager/HandleSnaps.mjs.map +1 -1
  185. package/dist-esm/lib/editor/managers/SnapManager/SnapManager.mjs +2 -1
  186. package/dist-esm/lib/editor/managers/SnapManager/SnapManager.mjs.map +2 -2
  187. package/dist-esm/lib/editor/managers/SpatialIndexManager/SpatialIndexManager.mjs +5 -4
  188. package/dist-esm/lib/editor/managers/SpatialIndexManager/SpatialIndexManager.mjs.map +2 -2
  189. package/dist-esm/lib/editor/managers/TextManager/TextManager.mjs +1 -0
  190. package/dist-esm/lib/editor/managers/TextManager/TextManager.mjs.map +1 -1
  191. package/dist-esm/lib/editor/managers/ThemeManager/ThemeManager.mjs +89 -0
  192. package/dist-esm/lib/editor/managers/ThemeManager/ThemeManager.mjs.map +7 -0
  193. package/dist-esm/lib/editor/managers/ThemeManager/defaultThemes.mjs +582 -0
  194. package/dist-esm/lib/editor/managers/ThemeManager/defaultThemes.mjs.map +7 -0
  195. package/dist-esm/lib/editor/managers/TickManager/TickManager.mjs +1 -0
  196. package/dist-esm/lib/editor/managers/TickManager/TickManager.mjs.map +1 -1
  197. package/dist-esm/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.mjs +8 -4
  198. package/dist-esm/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.mjs.map +2 -2
  199. package/dist-esm/lib/editor/overlays/OverlayManager.mjs +136 -0
  200. package/dist-esm/lib/editor/overlays/OverlayManager.mjs.map +7 -0
  201. package/dist-esm/lib/editor/overlays/OverlayUtil.mjs +72 -0
  202. package/dist-esm/lib/editor/overlays/OverlayUtil.mjs.map +7 -0
  203. package/dist-esm/lib/editor/overlays/ShapeIndicatorOverlayUtil.mjs +141 -0
  204. package/dist-esm/lib/editor/overlays/ShapeIndicatorOverlayUtil.mjs.map +7 -0
  205. package/dist-esm/lib/editor/shapes/BaseFrameLikeShapeUtil.mjs +56 -0
  206. package/dist-esm/lib/editor/shapes/BaseFrameLikeShapeUtil.mjs.map +7 -0
  207. package/dist-esm/lib/editor/shapes/ShapeUtil.mjs +35 -20
  208. package/dist-esm/lib/editor/shapes/ShapeUtil.mjs.map +2 -2
  209. package/dist-esm/lib/editor/shapes/group/GroupShapeUtil.mjs +33 -3
  210. package/dist-esm/lib/editor/shapes/group/GroupShapeUtil.mjs.map +2 -2
  211. package/dist-esm/lib/editor/shapes/shared/getPerfectDashProps.mjs +6 -0
  212. package/dist-esm/lib/editor/shapes/shared/getPerfectDashProps.mjs.map +2 -2
  213. package/dist-esm/lib/editor/tools/StateNode.mjs +15 -17
  214. package/dist-esm/lib/editor/tools/StateNode.mjs.map +2 -2
  215. package/dist-esm/lib/editor/types/SvgExportContext.mjs.map +2 -2
  216. package/dist-esm/lib/editor/types/event-types.mjs.map +2 -2
  217. package/dist-esm/lib/exports/ExportDelay.mjs +1 -0
  218. package/dist-esm/lib/exports/ExportDelay.mjs.map +1 -1
  219. package/dist-esm/lib/exports/StyleEmbedder.mjs +1 -0
  220. package/dist-esm/lib/exports/StyleEmbedder.mjs.map +1 -1
  221. package/dist-esm/lib/exports/fetchCache.mjs +2 -2
  222. package/dist-esm/lib/exports/fetchCache.mjs.map +2 -2
  223. package/dist-esm/lib/exports/getSvgJsx.mjs +14 -11
  224. package/dist-esm/lib/exports/getSvgJsx.mjs.map +2 -2
  225. package/dist-esm/lib/globals/environment.mjs +18 -1
  226. package/dist-esm/lib/globals/environment.mjs.map +2 -2
  227. package/dist-esm/lib/hooks/EditorComponentsContext.mjs.map +2 -2
  228. package/dist-esm/lib/hooks/useCanvasEvents.mjs +25 -4
  229. package/dist-esm/lib/hooks/useCanvasEvents.mjs.map +2 -2
  230. package/dist-esm/lib/hooks/useColorMode.mjs +19 -0
  231. package/dist-esm/lib/hooks/useColorMode.mjs.map +7 -0
  232. package/dist-esm/lib/hooks/useCursor.mjs +3 -7
  233. package/dist-esm/lib/hooks/useCursor.mjs.map +2 -2
  234. package/dist-esm/lib/hooks/useDarkMode.mjs +4 -4
  235. package/dist-esm/lib/hooks/useDarkMode.mjs.map +2 -2
  236. package/dist-esm/lib/hooks/useEditorComponents.mjs +0 -28
  237. package/dist-esm/lib/hooks/useEditorComponents.mjs.map +2 -2
  238. package/dist-esm/lib/hooks/useGestureEvents.mjs +171 -127
  239. package/dist-esm/lib/hooks/useGestureEvents.mjs.map +3 -3
  240. package/dist-esm/lib/hooks/usePeerIds.mjs +2 -40
  241. package/dist-esm/lib/hooks/usePeerIds.mjs.map +2 -2
  242. package/dist-esm/lib/hooks/useShapeCulling.mjs +2 -1
  243. package/dist-esm/lib/hooks/useShapeCulling.mjs.map +2 -2
  244. package/dist-esm/lib/options.mjs +1 -0
  245. package/dist-esm/lib/options.mjs.map +2 -2
  246. package/dist-esm/lib/primitives/Vec.mjs +3 -0
  247. package/dist-esm/lib/primitives/Vec.mjs.map +1 -1
  248. package/dist-esm/lib/primitives/geometry/Circle2d.mjs +1 -0
  249. package/dist-esm/lib/primitives/geometry/Circle2d.mjs.map +1 -1
  250. package/dist-esm/lib/primitives/geometry/Ellipse2d.mjs +1 -0
  251. package/dist-esm/lib/primitives/geometry/Ellipse2d.mjs.map +1 -1
  252. package/dist-esm/lib/primitives/geometry/Geometry2d.mjs +4 -1
  253. package/dist-esm/lib/primitives/geometry/Geometry2d.mjs.map +2 -2
  254. package/dist-esm/lib/primitives/geometry/Stadium2d.mjs +1 -0
  255. package/dist-esm/lib/primitives/geometry/Stadium2d.mjs.map +1 -1
  256. package/dist-esm/lib/utils/EditorAtom.mjs +2 -0
  257. package/dist-esm/lib/utils/EditorAtom.mjs.map +1 -1
  258. package/dist-esm/lib/utils/reparenting.mjs +2 -1
  259. package/dist-esm/lib/utils/reparenting.mjs.map +2 -2
  260. package/dist-esm/lib/utils/richText.mjs.map +2 -2
  261. package/dist-esm/lib/utils/runtime.mjs +2 -1
  262. package/dist-esm/lib/utils/runtime.mjs.map +2 -2
  263. package/dist-esm/lib/utils/sync/TLLocalSyncClient.mjs +5 -0
  264. package/dist-esm/lib/utils/sync/TLLocalSyncClient.mjs.map +2 -2
  265. package/dist-esm/lib/utils/sync/hardReset.mjs +0 -8
  266. package/dist-esm/lib/utils/sync/hardReset.mjs.map +2 -2
  267. package/dist-esm/version.mjs +3 -3
  268. package/dist-esm/version.mjs.map +1 -1
  269. package/editor.css +16 -256
  270. package/package.json +8 -9
  271. package/src/index.ts +43 -45
  272. package/src/lib/TldrawEditor.tsx +107 -19
  273. package/src/lib/components/MenuClickCapture.tsx +129 -49
  274. package/src/lib/components/default-components/CanvasOverlays.tsx +208 -0
  275. package/src/lib/components/default-components/DefaultCanvas.tsx +38 -310
  276. package/src/lib/config/{createTLUser.ts → createTLCurrentUser.ts} +6 -6
  277. package/src/lib/config/createTLStore.ts +57 -2
  278. package/src/lib/config/defaultAssets.ts +19 -0
  279. package/src/lib/editor/Editor.test.ts +3 -1
  280. package/src/lib/editor/Editor.ts +606 -66
  281. package/src/lib/editor/assets/AssetUtil.ts +85 -0
  282. package/src/lib/editor/managers/CollaboratorsManager/CollaboratorsManager.ts +98 -0
  283. package/src/lib/editor/managers/FontManager/FontManager.test.ts +9 -2
  284. package/src/lib/editor/managers/FontManager/FontManager.ts +1 -67
  285. package/src/lib/editor/managers/InputsManager/InputsManager.ts +12 -0
  286. package/src/lib/editor/managers/PerformanceManager/PerformanceApiAdapter.ts +82 -0
  287. package/src/lib/editor/managers/PerformanceManager/PerformanceManager.test.ts +522 -0
  288. package/src/lib/editor/managers/PerformanceManager/PerformanceManager.ts +583 -0
  289. package/src/lib/editor/managers/PerformanceManager/perf-types.ts +196 -0
  290. package/src/lib/editor/managers/SnapManager/SnapManager.test.ts +13 -2
  291. package/src/lib/editor/managers/SnapManager/SnapManager.ts +1 -1
  292. package/src/lib/editor/managers/SpatialIndexManager/SpatialIndexManager.ts +4 -4
  293. package/src/lib/editor/managers/ThemeManager/ThemeManager.ts +116 -0
  294. package/src/lib/editor/managers/ThemeManager/defaultThemes.ts +619 -0
  295. package/src/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.test.ts +25 -31
  296. package/src/lib/editor/managers/UserPreferencesManager/UserPreferencesManager.ts +7 -5
  297. package/src/lib/editor/overlays/OverlayManager.ts +183 -0
  298. package/src/lib/editor/overlays/OverlayUtil.ts +143 -0
  299. package/src/lib/editor/overlays/ShapeIndicatorOverlayUtil.ts +216 -0
  300. package/src/lib/editor/shapes/BaseFrameLikeShapeUtil.tsx +123 -0
  301. package/src/lib/editor/shapes/ShapeUtil.ts +65 -28
  302. package/src/lib/editor/shapes/group/GroupShapeUtil.tsx +41 -4
  303. package/src/lib/editor/shapes/shared/getPerfectDashProps.ts +7 -0
  304. package/src/lib/editor/tools/StateNode.ts +16 -18
  305. package/src/lib/editor/types/SvgExportContext.tsx +5 -0
  306. package/src/lib/editor/types/clipboard-types.ts +2 -1
  307. package/src/lib/editor/types/event-types.ts +2 -0
  308. package/src/lib/editor/types/external-content.ts +1 -0
  309. package/src/lib/exports/fetchCache.ts +2 -4
  310. package/src/lib/exports/getSvgJsx.test.ts +3 -1
  311. package/src/lib/exports/getSvgJsx.tsx +23 -16
  312. package/src/lib/globals/environment.ts +18 -0
  313. package/src/lib/hooks/EditorComponentsContext.tsx +0 -27
  314. package/src/lib/hooks/useCanvasEvents.ts +40 -3
  315. package/src/lib/hooks/{useIsDarkMode.ts → useColorMode.ts} +9 -5
  316. package/src/lib/hooks/useCursor.ts +3 -7
  317. package/src/lib/hooks/useDarkMode.ts +4 -4
  318. package/src/lib/hooks/useEditorComponents.tsx +0 -28
  319. package/src/lib/hooks/useGestureEvents.ts +240 -168
  320. package/src/lib/hooks/usePeerIds.ts +6 -55
  321. package/src/lib/hooks/useShapeCulling.tsx +3 -1
  322. package/src/lib/options.ts +7 -0
  323. package/src/lib/primitives/Box.test.ts +30 -0
  324. package/src/lib/primitives/geometry/Geometry2d.test.ts +21 -0
  325. package/src/lib/primitives/geometry/Geometry2d.ts +2 -1
  326. package/src/lib/utils/reparenting.ts +6 -2
  327. package/src/lib/utils/richText.ts +1 -1
  328. package/src/lib/utils/runtime.ts +3 -1
  329. package/src/lib/utils/sync/TLLocalSyncClient.ts +3 -0
  330. package/src/lib/utils/sync/hardReset.ts +0 -8
  331. package/src/version.ts +3 -3
  332. package/dist-cjs/lib/components/LiveCollaborators.js +0 -151
  333. package/dist-cjs/lib/components/LiveCollaborators.js.map +0 -7
  334. package/dist-cjs/lib/components/default-components/CanvasShapeIndicators.js +0 -227
  335. package/dist-cjs/lib/components/default-components/CanvasShapeIndicators.js.map +0 -7
  336. package/dist-cjs/lib/components/default-components/DefaultBrush.js +0 -38
  337. package/dist-cjs/lib/components/default-components/DefaultBrush.js.map +0 -7
  338. package/dist-cjs/lib/components/default-components/DefaultCollaboratorHint.js +0 -71
  339. package/dist-cjs/lib/components/default-components/DefaultCollaboratorHint.js.map +0 -7
  340. package/dist-cjs/lib/components/default-components/DefaultHandle.js +0 -56
  341. package/dist-cjs/lib/components/default-components/DefaultHandle.js.map +0 -7
  342. package/dist-cjs/lib/components/default-components/DefaultHandles.js.map +0 -7
  343. package/dist-cjs/lib/components/default-components/DefaultScribble.js +0 -51
  344. package/dist-cjs/lib/components/default-components/DefaultScribble.js.map +0 -7
  345. package/dist-cjs/lib/components/default-components/DefaultSelectionForeground.js +0 -69
  346. package/dist-cjs/lib/components/default-components/DefaultSelectionForeground.js.map +0 -7
  347. package/dist-cjs/lib/components/default-components/DefaultShapeIndicator.js +0 -107
  348. package/dist-cjs/lib/components/default-components/DefaultShapeIndicator.js.map +0 -7
  349. package/dist-cjs/lib/components/default-components/DefaultShapeIndicatorErrorFallback.js.map +0 -7
  350. package/dist-cjs/lib/components/default-components/DefaultShapeIndicators.js +0 -101
  351. package/dist-cjs/lib/components/default-components/DefaultShapeIndicators.js.map +0 -7
  352. package/dist-cjs/lib/components/default-components/DefaultSnapIndictor.js +0 -170
  353. package/dist-cjs/lib/components/default-components/DefaultSnapIndictor.js.map +0 -7
  354. package/dist-cjs/lib/config/createTLUser.js.map +0 -7
  355. package/dist-cjs/lib/hooks/useIsDarkMode.js.map +0 -7
  356. package/dist-esm/lib/components/LiveCollaborators.mjs +0 -134
  357. package/dist-esm/lib/components/LiveCollaborators.mjs.map +0 -7
  358. package/dist-esm/lib/components/default-components/CanvasShapeIndicators.mjs +0 -207
  359. package/dist-esm/lib/components/default-components/CanvasShapeIndicators.mjs.map +0 -7
  360. package/dist-esm/lib/components/default-components/DefaultBrush.mjs +0 -18
  361. package/dist-esm/lib/components/default-components/DefaultBrush.mjs.map +0 -7
  362. package/dist-esm/lib/components/default-components/DefaultCollaboratorHint.mjs +0 -41
  363. package/dist-esm/lib/components/default-components/DefaultCollaboratorHint.mjs.map +0 -7
  364. package/dist-esm/lib/components/default-components/DefaultHandle.mjs +0 -26
  365. package/dist-esm/lib/components/default-components/DefaultHandle.mjs.map +0 -7
  366. package/dist-esm/lib/components/default-components/DefaultHandles.mjs +0 -8
  367. package/dist-esm/lib/components/default-components/DefaultHandles.mjs.map +0 -7
  368. package/dist-esm/lib/components/default-components/DefaultScribble.mjs +0 -21
  369. package/dist-esm/lib/components/default-components/DefaultScribble.mjs.map +0 -7
  370. package/dist-esm/lib/components/default-components/DefaultSelectionForeground.mjs +0 -39
  371. package/dist-esm/lib/components/default-components/DefaultSelectionForeground.mjs.map +0 -7
  372. package/dist-esm/lib/components/default-components/DefaultShapeIndicator.mjs +0 -77
  373. package/dist-esm/lib/components/default-components/DefaultShapeIndicator.mjs.map +0 -7
  374. package/dist-esm/lib/components/default-components/DefaultShapeIndicatorErrorFallback.mjs +0 -8
  375. package/dist-esm/lib/components/default-components/DefaultShapeIndicatorErrorFallback.mjs.map +0 -7
  376. package/dist-esm/lib/components/default-components/DefaultShapeIndicators.mjs +0 -81
  377. package/dist-esm/lib/components/default-components/DefaultShapeIndicators.mjs.map +0 -7
  378. package/dist-esm/lib/components/default-components/DefaultSnapIndictor.mjs +0 -142
  379. package/dist-esm/lib/components/default-components/DefaultSnapIndictor.mjs.map +0 -7
  380. package/dist-esm/lib/config/createTLUser.mjs.map +0 -7
  381. package/dist-esm/lib/hooks/useIsDarkMode.mjs +0 -15
  382. package/dist-esm/lib/hooks/useIsDarkMode.mjs.map +0 -7
  383. package/src/lib/components/LiveCollaborators.tsx +0 -174
  384. package/src/lib/components/default-components/CanvasShapeIndicators.tsx +0 -289
  385. package/src/lib/components/default-components/DefaultBrush.tsx +0 -35
  386. package/src/lib/components/default-components/DefaultCollaboratorHint.tsx +0 -52
  387. package/src/lib/components/default-components/DefaultHandle.tsx +0 -42
  388. package/src/lib/components/default-components/DefaultHandles.tsx +0 -15
  389. package/src/lib/components/default-components/DefaultScribble.tsx +0 -31
  390. package/src/lib/components/default-components/DefaultSelectionForeground.tsx +0 -50
  391. package/src/lib/components/default-components/DefaultShapeIndicator.tsx +0 -104
  392. package/src/lib/components/default-components/DefaultShapeIndicatorErrorFallback.tsx +0 -9
  393. package/src/lib/components/default-components/DefaultShapeIndicators.tsx +0 -116
  394. package/src/lib/components/default-components/DefaultSnapIndictor.tsx +0 -174
@@ -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,8 +83,15 @@ 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';
93
+ import { TLUser } from '@tldraw/tlschema';
94
+ import { TLUserStore } from '@tldraw/tlschema';
86
95
  import { TLVideoAsset } from '@tldraw/tlschema';
87
96
  import { UnknownRecord } from '@tldraw/store';
88
97
  import { VecModel } from '@tldraw/tlschema';
@@ -145,6 +154,51 @@ export declare class Arc2d extends Geometry2d {
145
154
  */
146
155
  export declare function areAnglesCompatible(a: number, b: number): boolean;
147
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
+
148
202
  /** @public */
149
203
  export declare function average(A: VecLike, B: VecLike): string;
150
204
 
@@ -165,6 +219,56 @@ export declare abstract class BaseBoxShapeUtil<Shape extends TLBaseBoxShape> ext
165
219
  getInterpolatedProps(startShape: Shape, endShape: Shape, t: number): Shape['props'];
166
220
  }
167
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
+
168
272
  /** @public */
169
273
  export declare interface BatchMeasurementRequest {
170
274
  html: string;
@@ -664,6 +768,49 @@ export declare class ClickManager {
664
768
  */
665
769
  export declare function clockwiseAngleDist(a0: number, a1: number): number;
666
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
+
667
814
  /**
668
815
  * @public
669
816
  * @react
@@ -718,6 +865,12 @@ export declare function createDeepLinkString(deepLink: TLDeepLink): string;
718
865
  */
719
866
  export declare function createSessionStateSnapshotSignal(store: TLStore): Signal<null | TLSessionStateSnapshot>;
720
867
 
868
+ /** @public */
869
+ export declare function createTLCurrentUser(opts?: {
870
+ setUserPreferences?: ((userPreferences: TLUserPreferences) => void) | undefined;
871
+ userPreferences?: Signal<TLUserPreferences, unknown> | undefined;
872
+ }): TLCurrentUser;
873
+
721
874
  /**
722
875
  * A helper for creating a TLStore schema from either an object with shapeUtils, bindingUtils, and
723
876
  * migrations, or a schema.
@@ -735,13 +888,7 @@ export declare function createTLSchemaFromUtils(opts: TLStoreSchemaOptions): Sto
735
888
  *
736
889
  * @public
737
890
  */
738
- export declare function createTLStore({ initialData, defaultName, id, assets, onMount, collaboration, ...rest }?: TLStoreOptions): TLStore;
739
-
740
- /** @public */
741
- export declare function createTLUser(opts?: {
742
- setUserPreferences?: ((userPreferences: TLUserPreferences) => void) | undefined;
743
- userPreferences?: Signal<TLUserPreferences, unknown> | undefined;
744
- }): TLUser;
891
+ export declare function createTLStore({ initialData, defaultName, id, assets, users, onMount, collaboration, themes, ...rest }?: TLStoreOptions): TLStore;
745
892
 
746
893
  /** @public */
747
894
  export declare class CubicBezier2d extends Polyline2d {
@@ -816,54 +963,31 @@ export declare interface DebugFlagDefaults<T> {
816
963
 
817
964
  /* Excluded from this release type: DEFAULT_CAMERA_OPTIONS */
818
965
 
819
- /** @public @react */
820
- export declare function DefaultBackground(): JSX.Element;
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;
821
972
 
822
973
  /** @public @react */
823
- export declare const DefaultBrush: ({ brush, color, opacity, className }: TLBrushProps) => JSX.Element;
974
+ export declare function DefaultBackground(): JSX.Element;
824
975
 
825
976
  /** @public @react */
826
977
  export declare function DefaultCanvas({ className }: TLCanvasComponentProps): JSX.Element;
827
978
 
828
- /** @public @react */
829
- export declare function DefaultCollaboratorHint({ className, zoom, point, color, viewport, opacity }: TLCollaboratorHintProps): JSX.Element;
830
-
831
- /** @public @react */
832
- export declare const DefaultCursor: NamedExoticComponent<TLCursorProps>;
833
-
834
979
  /** @public @react */
835
980
  export declare const DefaultErrorFallback: TLErrorFallbackComponent;
836
981
 
837
982
  /** @public @react */
838
983
  export declare function DefaultGrid({ x, y, z, size }: TLGridProps): JSX.Element;
839
984
 
840
- /** @public @react */
841
- export declare function DefaultHandle({ handle, isCoarse, className, zoom }: TLHandleProps): JSX.Element;
842
-
843
- /** @public @react */
844
- export declare const DefaultHandles: ({ children }: TLHandlesProps) => JSX.Element;
845
-
846
- /** @public @react */
847
- export declare function DefaultScribble({ scribble, zoom, color, opacity, className }: TLScribbleProps): JSX.Element | null;
848
-
849
985
  /** @public @react */
850
986
  export declare function DefaultSelectionBackground({ bounds, rotation }: TLSelectionBackgroundProps): JSX.Element;
851
987
 
852
- /** @public @react */
853
- export declare function DefaultSelectionForeground({ bounds, rotation }: TLSelectionForegroundProps): JSX.Element;
854
-
855
- /** @public @react */
856
- export declare const DefaultShapeIndicator: NamedExoticComponent<TLShapeIndicatorProps>;
857
-
858
- /** @public @react */
859
- export declare const DefaultShapeIndicators: NamedExoticComponent<TLShapeIndicatorsProps>;
860
-
861
988
  /** @public @react */
862
989
  export declare const DefaultShapeWrapper: ForwardRefExoticComponent<TLShapeWrapperProps & RefAttributes<HTMLDivElement>>;
863
990
 
864
- /** @public @react */
865
- export declare function DefaultSnapIndicator({ className, line, zoom }: TLSnapIndicatorProps): JSX.Element;
866
-
867
991
  /** @public @react */
868
992
  export declare function DefaultSpinner(props: React.SVGProps<SVGSVGElement>): JSX.Element;
869
993
 
@@ -934,6 +1058,7 @@ export declare const defaultTldrawOptions: {
934
1058
  readonly onBeforePasteFromClipboard: undefined;
935
1059
  readonly onClipboardPasteRaw: undefined;
936
1060
  readonly quickZoomPreservesScreenBounds: true;
1061
+ readonly rightClickPanning: true;
937
1062
  readonly snapThreshold: 8;
938
1063
  readonly spacebarPanning: true;
939
1064
  readonly temporaryAssetPreviewLifetimeMs: 180000;
@@ -963,6 +1088,9 @@ export declare const defaultUserPreferences: Readonly<{
963
1088
  name: "";
964
1089
  }>;
965
1090
 
1091
+ /** @public */
1092
+ export declare const defaultUserStore: TLUserStore;
1093
+
966
1094
  /**
967
1095
  * Convert degrees to radians.
968
1096
  *
@@ -1038,7 +1166,7 @@ export declare class EdgeScrollManager {
1038
1166
  /** @public */
1039
1167
  export declare class Editor extends EventEmitter<TLEventMap> {
1040
1168
  readonly id: string;
1041
- constructor({ store, user, shapeUtils, bindingUtils, tools, getContainer, cameraOptions, initialState, autoFocus, inferDarkMode, options: _options, textOptions: _textOptions, getShapeVisibility, fontAssetUrls }: TLEditorOptions);
1169
+ constructor({ store, user, shapeUtils, bindingUtils, assetUtils: assetUtilConstructors, overlayUtils: overlayUtilConstructors, tools, getContainer, cameraOptions, initialState, autoFocus, options: _options, textOptions: _textOptions, getShapeVisibility, colorScheme, fontAssetUrls, themes, initialTheme }: TLEditorOptions);
1042
1170
  private readonly _getShapeVisibility?;
1043
1171
  private getIsShapeHiddenCache;
1044
1172
  isShapeHidden(shapeOrId: TLShape | TLShapeId): boolean;
@@ -1101,7 +1229,13 @@ export declare class Editor extends EventEmitter<TLEventMap> {
1101
1229
  * @public
1102
1230
  */
1103
1231
  readonly snaps: SnapManager;
1104
- private readonly _spatialIndex;
1232
+ /**
1233
+ * A manager for performance measurement hooks.
1234
+ *
1235
+ * @public
1236
+ */
1237
+ readonly performance: PerformanceManager;
1238
+ /* Excluded from this release type: _spatialIndex */
1105
1239
  /**
1106
1240
  * A manager for the any asynchronous events and making sure they're
1107
1241
  * cleaned up upon disposal.
@@ -1114,12 +1248,19 @@ export declare class Editor extends EventEmitter<TLEventMap> {
1114
1248
  setInterval: (handler: TimerHandler, timeout?: number | undefined, ...args: any[]) => number;
1115
1249
  setTimeout: (handler: TimerHandler, timeout?: number | undefined, ...args: any[]) => number;
1116
1250
  };
1251
+ /**
1252
+ * A manager for remote peer collaborators connected to this editor.
1253
+ *
1254
+ * @public
1255
+ */
1256
+ readonly collaborators: CollaboratorsManager;
1117
1257
  /**
1118
1258
  * A manager for the user and their preferences.
1119
1259
  *
1120
1260
  * @public
1121
1261
  */
1122
1262
  readonly user: UserPreferencesManager;
1263
+ /* Excluded from this release type: _themeManager */
1123
1264
  /**
1124
1265
  * A helper for measuring text.
1125
1266
  *
@@ -1138,6 +1279,12 @@ export declare class Editor extends EventEmitter<TLEventMap> {
1138
1279
  * @public
1139
1280
  */
1140
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;
1141
1288
  /**
1142
1289
  * A manager for side effects and correct state enforcement. See {@link @tldraw/store#StoreSideEffects} for details.
1143
1290
  *
@@ -1170,6 +1317,83 @@ export declare class Editor extends EventEmitter<TLEventMap> {
1170
1317
  * @public
1171
1318
  */
1172
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;
1173
1397
  /**
1174
1398
  * A map of shape utility classes (TLShapeUtils) by shape type.
1175
1399
  *
@@ -1178,6 +1402,7 @@ export declare class Editor extends EventEmitter<TLEventMap> {
1178
1402
  shapeUtils: {
1179
1403
  readonly [K in string]?: ShapeUtil<TLShape>;
1180
1404
  };
1405
+ /* Excluded from this release type: _shapeUtilsByAssetType */
1181
1406
  styleProps: {
1182
1407
  [key: string]: Map<StyleProp<any>, string>;
1183
1408
  };
@@ -1209,6 +1434,15 @@ export declare class Editor extends EventEmitter<TLEventMap> {
1209
1434
  hasShapeUtil(shape: TLShape | TLShapePartial<TLShape>): boolean;
1210
1435
  hasShapeUtil(type: TLShape['type']): boolean;
1211
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;
1212
1446
  /**
1213
1447
  * A map of shape utility classes (TLShapeUtils) by shape type.
1214
1448
  *
@@ -1239,6 +1473,40 @@ export declare class Editor extends EventEmitter<TLEventMap> {
1239
1473
  type: S['type'];
1240
1474
  } | S): BindingUtil<S>;
1241
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;
1242
1510
  /**
1243
1511
  * A manager for the editor's history.
1244
1512
  *
@@ -1495,6 +1763,11 @@ export declare class Editor extends EventEmitter<TLEventMap> {
1495
1763
  /**
1496
1764
  * Set the cursor.
1497
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
+ *
1498
1771
  * @param cursor - The cursor to set.
1499
1772
  * @public
1500
1773
  */
@@ -2254,11 +2527,12 @@ export declare class Editor extends EventEmitter<TLEventMap> {
2254
2527
  * @public
2255
2528
  */
2256
2529
  pageToViewport(point: VecLike): Vec;
2257
- private _getCollaboratorsQuery;
2258
2530
  /**
2259
2531
  * Returns a list of presence records for all peer collaborators.
2260
2532
  * This will return the latest presence record for each connected user.
2261
2533
  *
2534
+ * Convenience wrapper for {@link CollaboratorsManager.getCollaborators}.
2535
+ *
2262
2536
  * @public
2263
2537
  */
2264
2538
  getCollaborators(): TLInstancePresence[];
@@ -2266,9 +2540,58 @@ export declare class Editor extends EventEmitter<TLEventMap> {
2266
2540
  * Returns a list of presence records for all peer collaborators on the current page.
2267
2541
  * This will return the latest presence record for each connected user.
2268
2542
  *
2543
+ * Convenience wrapper for {@link CollaboratorsManager.getCollaboratorsOnCurrentPage}.
2544
+ *
2269
2545
  * @public
2270
2546
  */
2271
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[];
2569
+ /**
2570
+ * Get the current user's ID for attribution purposes.
2571
+ * Also ensures a `user:` record exists in the store for the current user.
2572
+ * Returns `null` when the user store has no current user.
2573
+ *
2574
+ * @public
2575
+ */
2576
+ getAttributionUserId(): null | string;
2577
+ /* Excluded from this release type: _ensureUserRecord */
2578
+ /**
2579
+ * Resolve a display name for a user ID. Asks the
2580
+ * {@link @tldraw/tlschema#TLUserStore} first (the app's source of truth),
2581
+ * falling back to the `user:` record in the store.
2582
+ *
2583
+ * @public
2584
+ */
2585
+ getAttributionDisplayName(userId: null | string): null | string;
2586
+ /**
2587
+ * Resolve a user record by ID. Asks the
2588
+ * {@link @tldraw/tlschema#TLUserStore} first (the app's source of truth),
2589
+ * falling back to the `user:` record in the store.
2590
+ *
2591
+ * @public
2592
+ */
2593
+ getAttributionUser(userId: null | string): null | TLUser;
2594
+ /* Excluded from this release type: _getReferencedUserIds */
2272
2595
  private _isLockedOnFollowingUser;
2273
2596
  /**
2274
2597
  * Start viewport-following a user.
@@ -2903,6 +3226,20 @@ export declare class Editor extends EventEmitter<TLEventMap> {
2903
3226
  type: T['type'];
2904
3227
  }>;
2905
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;
2906
3243
  /**
2907
3244
  * Get a shape by its id.
2908
3245
  *
@@ -4363,6 +4700,35 @@ export declare interface Geometry2dOptions extends TransformedGeometry2dOptions
4363
4700
  */
4364
4701
  export declare function getArcMeasure(A: number, B: number, sweepFlag: number, largeArcFlag: number): number;
4365
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
+
4366
4732
  /** @public */
4367
4733
  export declare function getCursor(cursor: TLCursorType, rotation?: number, color?: string): string;
4368
4734
 
@@ -4533,14 +4899,14 @@ export declare class GroupShapeUtil extends ShapeUtil<TLGroupShape> {
4533
4899
  static type: "group";
4534
4900
  static props: RecordProps<TLGroupShape>;
4535
4901
  static migrations: TLPropsMigrations;
4536
- hideSelectionBoundsFg(): boolean;
4902
+ hideSelectionBoundsFg(shape: TLGroupShape): boolean;
4537
4903
  canBind(): boolean;
4538
4904
  canResize(): boolean;
4539
4905
  canResizeChildren(): boolean;
4540
4906
  getDefaultProps(): TLGroupShape['props'];
4541
4907
  getGeometry(shape: TLGroupShape): Geometry2d;
4542
4908
  component(shape: TLGroupShape): JSX.Element | null;
4543
- indicator(shape: TLGroupShape): JSX.Element;
4909
+ getIndicatorPath(shape: TLGroupShape): Path2D;
4544
4910
  onChildrenChange(group: TLGroupShape): void;
4545
4911
  }
4546
4912
 
@@ -4819,6 +5185,12 @@ export declare class InputsManager {
4819
5185
  get isPointing(): boolean;
4820
5186
  set isPointing(isPointing: boolean);
4821
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 */
4822
5194
  private _isPinching;
4823
5195
  /**
4824
5196
  * Whether the user is pinching.
@@ -5162,25 +5534,286 @@ export declare function openWindow(url: string, target?: string, allowReferrer?:
5162
5534
  /** @public */
5163
5535
  export declare type OptionalKeys<T, K extends keyof T> = Omit<T, K> & Partial<Pick<T, K>>;
5164
5536
 
5165
- /**
5166
- * Parses a string created by {@link createDeepLinkString} back into a deep link descriptor.
5167
- *
5168
- * @param deepLinkString - the deep link string
5169
- * @returns a deep link descriptor
5170
- *
5171
- * @public
5172
- */
5173
- export declare function parseDeepLinkString(deepLinkString: string): TLDeepLink;
5174
-
5175
5537
  /** @public */
5176
- export declare type PerfectDashTerminal = 'none' | 'outset' | 'skip';
5177
-
5178
- /**
5179
- * Find the approximate perimeter of an ellipse.
5180
- *
5181
- * @param rx - The ellipse's x radius.
5182
- * @param ry - The ellipse's y radius.
5183
- * @public
5538
+ export declare class OverlayManager {
5539
+ readonly editor: Editor;
5540
+ constructor(editor: Editor);
5541
+ /* Excluded from this release type: _overlayUtils */
5542
+ /* Excluded from this release type: registerUtil */
5543
+ /**
5544
+ * Get an overlay util by type string, overlay instance, or by passing
5545
+ * a util class as a generic parameter for type-safe lookup.
5546
+ *
5547
+ * @example
5548
+ * ```ts
5549
+ * const util = editor.overlays.getOverlayUtil('brush')
5550
+ * const util = editor.overlays.getOverlayUtil<BrushOverlayUtil>('brush')
5551
+ * const util = editor.overlays.getOverlayUtil(myOverlay)
5552
+ * ```
5553
+ *
5554
+ * @public
5555
+ */
5556
+ getOverlayUtil<T extends OverlayUtil>(type: T extends OverlayUtil<infer O> ? O['type'] : string): T;
5557
+ getOverlayUtil<O extends TLOverlay>(overlay: O): OverlayUtil<O>;
5558
+ /**
5559
+ * Returns all registered overlay utils in paint order (ascending zIndex).
5560
+ * Utils with the same zIndex preserve their registration order.
5561
+ *
5562
+ * @public
5563
+ */
5564
+ getOverlayUtilsInZOrder(): OverlayUtil[];
5565
+ /**
5566
+ * Reactive list of active overlay utils paired with the overlays they
5567
+ * produced for the current editor state, in paint order (ascending
5568
+ * zIndex). Both the hit-test and render paths read from this single
5569
+ * cached scan instead of each re-deriving the active set. Active utils
5570
+ * are included even when their `getOverlays()` returns an empty array,
5571
+ * since `render()` may still draw non-interactive UI (e.g. the selection
5572
+ * bounding box during brushing).
5573
+ *
5574
+ * @public
5575
+ */
5576
+ getActiveOverlayEntries(): TLOverlayEntry[];
5577
+ /**
5578
+ * Reactively computed list of all currently active overlays, in paint order.
5579
+ * @public
5580
+ */
5581
+ getCurrentOverlays(): TLOverlay[];
5582
+ private _geometryCache;
5583
+ /**
5584
+ * Get hit-test geometry for an overlay, cached by overlay identity. Lets
5585
+ * hit-testing on a pointermove storm skip the per-overlay geometry
5586
+ * allocation that {@link OverlayUtil.getGeometry} would otherwise do on
5587
+ * every call.
5588
+ *
5589
+ * @public
5590
+ */
5591
+ getOverlayGeometry(overlay: TLOverlay): Geometry2d | null;
5592
+ /**
5593
+ * The currently hovered overlay id.
5594
+ * @public
5595
+ */
5596
+ private _hoveredOverlayId;
5597
+ getHoveredOverlayId(): null | string;
5598
+ getHoveredOverlay(): null | TLOverlay;
5599
+ setHoveredOverlay(id: null | string): void;
5600
+ /**
5601
+ * Hit test all active overlays at a given page point.
5602
+ * Returns the topmost overlay whose geometry contains the point, or null.
5603
+ * Utils are walked from highest zIndex to lowest so the overlay painted on
5604
+ * top also wins the hit test. Within a util, overlays are walked in
5605
+ * array order: the first overlay whose geometry contains the point wins,
5606
+ * so utils should place highest-priority overlays first in `getOverlays`.
5607
+ * Interactive overlays (those with geometry) are checked; non-interactive are skipped.
5608
+ *
5609
+ * @param point - Point in page coordinates
5610
+ * @param margin - Hit test margin
5611
+ * @public
5612
+ */
5613
+ getOverlayAtPoint(point: VecLike, margin?: number): null | TLOverlay;
5614
+ }
5615
+
5616
+ /**
5617
+ * Base class for overlay utilities. Overlays are ephemeral UI elements rendered
5618
+ * on top of the canvas (selection handles, rotation corners, shape handles, etc.).
5619
+ *
5620
+ * Each OverlayUtil defines a type of overlay and knows how to:
5621
+ * - Determine when its overlays should be active (predicate)
5622
+ * - Produce overlay instances from current editor state
5623
+ * - Provide hit-test geometry for interactive overlays
5624
+ * - Provide cursor style on hover
5625
+ * - Render into a canvas 2D context
5626
+ *
5627
+ * @public
5628
+ */
5629
+ export declare abstract class OverlayUtil<T extends TLOverlay = TLOverlay> {
5630
+ editor: Editor;
5631
+ constructor(editor: Editor);
5632
+ static type: string;
5633
+ /**
5634
+ * Options for this overlay util. Override this to provide customization options.
5635
+ * Use {@link OverlayUtil.configure} to customize existing overlay utils.
5636
+ *
5637
+ * `zIndex` controls paint and hit-test order across utils — higher numbers
5638
+ * paint on top and are hit-tested first. Ties resolve by registration order.
5639
+ * Defaults to `0`; built-in utils use larger integers (100, 200, …) with
5640
+ * gaps so custom utils can slot between.
5641
+ *
5642
+ * @public
5643
+ */
5644
+ options: {
5645
+ zIndex?: number;
5646
+ };
5647
+ /**
5648
+ * Create a new overlay util class with the given options merged in.
5649
+ *
5650
+ * @example
5651
+ * ```ts
5652
+ * const MyBrush = BrushOverlayUtil.configure({ fill: 'rgba(0,0,255,0.1)' })
5653
+ * ```
5654
+ *
5655
+ * @public
5656
+ */
5657
+ static configure<T extends TLOverlayUtilConstructor<any>>(this: T, options: T extends new (...args: any[]) => {
5658
+ options: infer Options;
5659
+ } ? Partial<Options> : never): T;
5660
+ /**
5661
+ * Whether this overlay util's overlays should currently be active.
5662
+ * Checked reactively to determine which overlays exist at any given time.
5663
+ */
5664
+ abstract isActive(): boolean;
5665
+ /**
5666
+ * Returns the overlay instances that currently exist.
5667
+ * Called only when `isActive()` returns true.
5668
+ */
5669
+ abstract getOverlays(): T[];
5670
+ /**
5671
+ * Returns hit-test geometry for an overlay instance, in page coordinates.
5672
+ * Return null for non-interactive overlays (e.g. snap indicators, scribbles).
5673
+ */
5674
+ getGeometry(_overlay: T): Geometry2d | null;
5675
+ /**
5676
+ * Returns the cursor type to show when hovering this overlay.
5677
+ */
5678
+ getCursor(_overlay: T): TLCursorType | undefined;
5679
+ /**
5680
+ * Called when the user points down on this overlay, before the default
5681
+ * routing runs. Acts as an interrupt: define it to take over the event.
5682
+ *
5683
+ * Return `false` to continue with the default behavior (e.g. the
5684
+ * built-in rotate/resize handle transitions or shape-handle dispatch).
5685
+ * Return `true` — or nothing at all — to skip the default. In other
5686
+ * words, once you override this method you own the event unless you
5687
+ * explicitly opt back in by returning `false`.
5688
+ */
5689
+ onPointerDown?(overlay: T, info: TLPointerEventInfo): boolean | void;
5690
+ /**
5691
+ * Render all active overlays into the canvas context.
5692
+ * The context is already transformed to page space (camera transform applied).
5693
+ * Called reactively when overlays or editor state changes.
5694
+ */
5695
+ render(_ctx: CanvasRenderingContext2D, _overlays: T[]): void;
5696
+ /**
5697
+ * Optional: render all active overlays into the minimap canvas.
5698
+ * The context is already transformed to page space (minimap camera applied),
5699
+ * so overlays can use the same page-space coordinates as in {@link OverlayUtil.render}.
5700
+ *
5701
+ * `zoom` is the minimap's screen-pixels-per-page-unit, analogous to
5702
+ * `editor.getCamera().z`; use `1 / zoom` for one-minimap-pixel line widths.
5703
+ *
5704
+ * Most overlays should leave this blank — only overlays that are meaningful
5705
+ * at minimap scale (e.g. brushes, collaborator cursors) should opt in.
5706
+ */
5707
+ renderMinimap(_ctx: CanvasRenderingContext2D, _overlays: T[], _zoom: number): void;
5708
+ }
5709
+
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
+
5720
+ /** @public */
5721
+ export declare type PerfectDashTerminal = 'none' | 'outset' | 'skip';
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
+
5811
+ /**
5812
+ * Find the approximate perimeter of an ellipse.
5813
+ *
5814
+ * @param rx - The ellipse's x radius.
5815
+ * @param ry - The ellipse's y radius.
5816
+ * @public
5184
5817
  */
5185
5818
  export declare function perimeterOfEllipse(rx: number, ry: number): number;
5186
5819
 
@@ -5369,6 +6002,16 @@ export declare function resizeScaled(shape: TLBaseShape<any, {
5369
6002
  y: number;
5370
6003
  };
5371
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
+
5372
6015
  /** @public */
5373
6016
  export declare type RichTextFontVisitor = (node: TiptapNode, state: RichTextFontVisitorState, addFont: (font: TLFontFace) => void) => RichTextFontVisitorState;
5374
6017
 
@@ -5596,6 +6239,32 @@ export declare function setRuntimeOverrides(input: Partial<typeof runtime>): voi
5596
6239
  /** @public */
5597
6240
  export declare function setUserPreferences(user: TLUserPreferences): void;
5598
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
+
5599
6268
  /** @public */
5600
6269
  export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
5601
6270
  editor: Editor;
@@ -5650,12 +6319,32 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
5650
6319
  * @public
5651
6320
  */
5652
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[];
5653
6331
  /**
5654
6332
  * Get the default props for a shape.
5655
6333
  *
5656
6334
  * @public
5657
6335
  */
5658
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;
5659
6348
  /**
5660
6349
  * Get the shape's geometry.
5661
6350
  *
@@ -5672,37 +6361,30 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
5672
6361
  */
5673
6362
  abstract component(shape: Shape): any;
5674
6363
  /**
5675
- * Get JSX describing the shape's indicator (as an SVG element).
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.
5676
6367
  *
5677
- * @param shape - The shape.
5678
- * @public
5679
- */
5680
- abstract indicator(shape: Shape): any;
5681
- /**
5682
- * Whether to use the legacy React-based indicator rendering.
5683
- *
5684
- * Override this to return `false` if your shape implements {@link ShapeUtil.getIndicatorPath}
5685
- * for canvas-based indicator rendering.
6368
+ * For complex indicators that need clipping (e.g., arrows with labels), return an
6369
+ * object with `path`, `clipPath`, and `additionalPaths` properties.
5686
6370
  *
5687
- * @returns `true` to use SVG indicators (default), `false` to use canvas indicators.
6371
+ * @param shape - The shape.
6372
+ * @returns A Path2D to stroke, or an object with clipping info, or undefined to skip.
5688
6373
  * @public
5689
6374
  */
5690
- useLegacyIndicator(): boolean;
6375
+ abstract getIndicatorPath(shape: Shape): TLIndicatorPath | undefined;
5691
6376
  /**
5692
- * Get a Path2D for rendering the shape's indicator on the canvas.
5693
- *
5694
- * When implemented, this is used instead of {@link ShapeUtil.indicator} for more
5695
- * efficient canvas-based indicator rendering. Shapes that return `undefined` will
5696
- * fall back to SVG-based rendering via {@link ShapeUtil.indicator}.
6377
+ * Get JSX describing the shape's indicator (as an SVG element).
5697
6378
  *
5698
- * For complex indicators that need clipping (e.g., arrows with labels), return an
5699
- * object with `path`, `clipPath`, and `additionalPaths` properties.
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.
5700
6383
  *
5701
6384
  * @param shape - The shape.
5702
- * @returns A Path2D to stroke, or an object with clipping info, or undefined to use SVG fallback.
5703
6385
  * @public
5704
6386
  */
5705
- getIndicatorPath(shape: Shape): TLIndicatorPath | undefined;
6387
+ indicator(_shape: Shape): any;
5706
6388
  /**
5707
6389
  * Get the font faces that should be rendered in the document in order for this shape to render
5708
6390
  * correctly.
@@ -5736,7 +6418,7 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
5736
6418
  *
5737
6419
  * @public
5738
6420
  */
5739
- canBind(_opts: TLShapeUtilCanBindOpts): boolean;
6421
+ canBind(opts: TLShapeUtilCanBindOpts): boolean;
5740
6422
  /**
5741
6423
  * Whether the shape can be double clicked to edit.
5742
6424
  *
@@ -5870,6 +6552,14 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
5870
6552
  * @public
5871
6553
  */
5872
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;
5873
6563
  /**
5874
6564
  * By default, the bounds of an image export are the bounds of all the shapes it contains, plus
5875
6565
  * some padding. If an export includes a shape where `isExportBoundsContainer` is true, then the
@@ -5917,7 +6607,7 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
5917
6607
  * @param type - The shape type.
5918
6608
  * @public
5919
6609
  */
5920
- canReceiveNewChildrenOfType(shape: Shape, _type: TLShape['type']): boolean;
6610
+ canReceiveNewChildrenOfType(shape: Shape, type: TLShape['type']): boolean;
5921
6611
  /**
5922
6612
  * Get the shape as an SVG object.
5923
6613
  *
@@ -5957,6 +6647,14 @@ export declare abstract class ShapeUtil<Shape extends TLShape = TLShape> {
5957
6647
  */
5958
6648
  getHandleSnapGeometry(shape: Shape): HandleSnapGeometry;
5959
6649
  getText(shape: Shape): string | undefined;
6650
+ /**
6651
+ * Return user IDs referenced in shape-specific props.
6652
+ * Used when copying shapes to include referenced users on the clipboard.
6653
+ * Override this if your shape stores user IDs in custom props.
6654
+ *
6655
+ * @public
6656
+ */
6657
+ getReferencedUserIds(shape: Shape): string[];
5960
6658
  getAriaDescriptor(shape: Shape): string | undefined;
5961
6659
  /**
5962
6660
  * A callback called just before a shape is created. This method provides a last chance to modify
@@ -6352,6 +7050,8 @@ export declare abstract class StateNode implements Partial<TLEventHandlers> {
6352
7050
  static children?: () => TLStateNodeConstructor[];
6353
7051
  static isLockable: boolean;
6354
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;
6355
7055
  id: string;
6356
7056
  type: 'branch' | 'leaf' | 'root';
6357
7057
  shapeType?: string;
@@ -6451,6 +7151,19 @@ export declare const stopEventPropagation: (e: any) => any;
6451
7151
 
6452
7152
  /* Excluded from this release type: StoreName */
6453
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
+
6454
7167
  /** @public */
6455
7168
  export declare function suffixSafeId(id: SafeId, suffix: string): SafeId;
6456
7169
 
@@ -6486,6 +7199,10 @@ export declare interface SvgExportContext {
6486
7199
  * Whether the export should be in dark mode.
6487
7200
  */
6488
7201
  readonly isDarkMode: boolean;
7202
+ /**
7203
+ * The color mode to use for this export.
7204
+ */
7205
+ readonly colorMode: 'dark' | 'light';
6489
7206
  /**
6490
7207
  * The scale of the export - how much CSS pixels will be scaled up/down by.
6491
7208
  */
@@ -6556,6 +7273,47 @@ export declare class TextManager {
6556
7273
  }[];
6557
7274
  }
6558
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
+
6559
7317
  /* Excluded from this release type: TickManager */
6560
7318
 
6561
7319
  /**
@@ -6574,12 +7332,26 @@ export declare type TiptapNode = Node_2;
6574
7332
  /** @public */
6575
7333
  export declare type TLAdjacentDirection = 'down' | 'left' | 'next' | 'prev' | 'right' | 'up';
6576
7334
 
7335
+ /** @public */
7336
+ export declare type TLAnyAssetUtilConstructor = TLAssetUtilConstructor<any>;
7337
+
6577
7338
  /** @public */
6578
7339
  export declare type TLAnyBindingUtilConstructor = TLBindingUtilConstructor<any>;
6579
7340
 
7341
+ /** @public */
7342
+ export declare type TLAnyOverlayUtilConstructor = TLOverlayUtilConstructor<any>;
7343
+
6580
7344
  /** @public */
6581
7345
  export declare type TLAnyShapeUtilConstructor = TLShapeUtilConstructor<any>;
6582
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
+
6583
7355
  /** @public */
6584
7356
  export declare type TLBaseBoxShape = ExtractShapeByProps<{
6585
7357
  h: number;
@@ -6612,15 +7384,6 @@ export declare interface TLBindingUtilConstructor<T extends TLBinding, U extends
6612
7384
  migrations?: TLPropsMigrations;
6613
7385
  }
6614
7386
 
6615
- /** @public */
6616
- export declare interface TLBrushProps {
6617
- userId?: string;
6618
- brush: BoxModel;
6619
- color?: string;
6620
- opacity?: number;
6621
- className?: string;
6622
- }
6623
-
6624
7387
  /** @public */
6625
7388
  export declare interface TLCameraConstraints {
6626
7389
  /** The bounds (in page space) of the constrained space */
@@ -6669,6 +7432,29 @@ export declare interface TLCameraConstraints {
6669
7432
  };
6670
7433
  }
6671
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
+
6672
7458
  /** @public */
6673
7459
  export declare interface TLCameraMoveOptions {
6674
7460
  /** Whether to move the camera immediately, rather than on the next tick. */
@@ -6707,6 +7493,17 @@ export declare interface TLCameraOptions {
6707
7493
  constraints?: TLCameraConstraints;
6708
7494
  }
6709
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
+
6710
7507
  /** @public */
6711
7508
  export declare type TLCancelEvent = (info: TLCancelEventInfo) => void;
6712
7509
 
@@ -6774,17 +7571,6 @@ export declare interface TLClipboardWriteInfo {
6774
7571
  readonly source: 'menu' | 'native';
6775
7572
  }
6776
7573
 
6777
- /** @public */
6778
- export declare interface TLCollaboratorHintProps {
6779
- userId: string;
6780
- className?: string;
6781
- point: VecModel;
6782
- viewport: Box;
6783
- zoom: number;
6784
- opacity?: number;
6785
- color: string;
6786
- }
6787
-
6788
7574
  /** @public */
6789
7575
  export declare type TLCompleteEvent = (info: TLCompleteEventInfo) => void;
6790
7576
 
@@ -6801,6 +7587,7 @@ export declare interface TLContent {
6801
7587
  rootShapeIds: TLShapeId[];
6802
7588
  assets: TLAsset[];
6803
7589
  schema: SerializedSchema;
7590
+ users?: TLUser[];
6804
7591
  }
6805
7592
 
6806
7593
  /**
@@ -6823,14 +7610,9 @@ export declare interface TLCropInfo<T extends TLShape> {
6823
7610
  }
6824
7611
 
6825
7612
  /** @public */
6826
- export declare interface TLCursorProps {
6827
- userId: string;
6828
- className?: string;
6829
- point: null | VecModel;
6830
- zoom: number;
6831
- color?: string;
6832
- name: null | string;
6833
- chatMessage: string;
7613
+ export declare interface TLCurrentUser {
7614
+ readonly userPreferences: Signal<TLUserPreferences>;
7615
+ readonly setUserPreferences: (userPreferences: TLUserPreferences) => void;
6834
7616
  }
6835
7617
 
6836
7618
  /** @public */
@@ -6922,6 +7704,14 @@ export declare interface TldrawEditorBaseProps {
6922
7704
  * An array of binding utils to use in the editor.
6923
7705
  */
6924
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[];
6925
7715
  /**
6926
7716
  * An array of tools to add to the editor's state chart.
6927
7717
  */
@@ -6949,11 +7739,23 @@ export declare interface TldrawEditorBaseProps {
6949
7739
  /**
6950
7740
  * The user interacting with the editor.
6951
7741
  */
6952
- user?: TLUser;
7742
+ user?: TLCurrentUser;
7743
+ /**
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.
7753
+ */
7754
+ themes?: Partial<TLThemes>;
6953
7755
  /**
6954
- * Whether to infer dark mode from the user's OS. Defaults to false.
7756
+ * The id of the initially active theme. Defaults to `'default'`.
6955
7757
  */
6956
- inferDarkMode?: boolean;
7758
+ initialTheme?: TLThemeId;
6957
7759
  /**
6958
7760
  * Camera options for the editor.
6959
7761
  *
@@ -7171,6 +7973,12 @@ export declare interface TldrawOptions {
7171
7973
  * When false, the spacebar will not pan the camera.
7172
7974
  */
7173
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;
7174
7982
  /**
7175
7983
  * The default padding (in pixels) used when zooming to fit content in the viewport.
7176
7984
  * This affects methods like `zoomToFit()`, `zoomToSelection()`, and `zoomToBounds()`.
@@ -7300,34 +8108,17 @@ export declare interface TLDropShapesOverInfo {
7300
8108
  /** @public */
7301
8109
  export declare interface TLEditorComponents {
7302
8110
  Background?: ComponentType | null;
7303
- Brush?: ComponentType<TLBrushProps> | null;
7304
8111
  Canvas?: ComponentType<TLCanvasComponentProps> | null;
7305
- CollaboratorBrush?: ComponentType<TLBrushProps> | null;
7306
- CollaboratorCursor?: ComponentType<TLCursorProps> | null;
7307
- CollaboratorHint?: ComponentType<TLCollaboratorHintProps> | null;
7308
- CollaboratorScribble?: ComponentType<TLScribbleProps> | null;
7309
- CollaboratorShapeIndicator?: ComponentType<TLShapeIndicatorProps> | null;
7310
- Cursor?: ComponentType<TLCursorProps> | null;
7311
8112
  Grid?: ComponentType<TLGridProps> | null;
7312
- Handle?: ComponentType<TLHandleProps> | null;
7313
- Handles?: ComponentType<TLHandlesProps> | null;
7314
8113
  InFrontOfTheCanvas?: ComponentType | null;
7315
8114
  LoadingScreen?: ComponentType | null;
7316
8115
  OnTheCanvas?: ComponentType | null;
7317
- Overlays?: ComponentType | null;
7318
- Scribble?: ComponentType<TLScribbleProps> | null;
7319
8116
  SelectionBackground?: ComponentType<TLSelectionBackgroundProps> | null;
7320
- SelectionForeground?: ComponentType<TLSelectionForegroundProps> | null;
7321
- ShapeIndicator?: ComponentType<TLShapeIndicatorProps> | null;
7322
- ShapeIndicators?: ComponentType | null;
7323
8117
  ShapeWrapper?: ComponentType<TLShapeWrapperProps & RefAttributes<HTMLDivElement>> | null;
7324
- SnapIndicator?: ComponentType<TLSnapIndicatorProps> | null;
7325
8118
  Spinner?: ComponentType<React.SVGProps<SVGSVGElement>> | null;
7326
8119
  SvgDefs?: ComponentType | null;
7327
- ZoomBrush?: ComponentType<TLBrushProps> | null;
7328
8120
  ErrorFallback?: TLErrorFallbackComponent;
7329
8121
  ShapeErrorFallback?: TLShapeErrorFallbackComponent;
7330
- ShapeIndicatorErrorFallback?: TLShapeIndicatorErrorFallbackComponent;
7331
8122
  }
7332
8123
 
7333
8124
  /** @public */
@@ -7346,18 +8137,22 @@ export declare interface TLEditorOptions {
7346
8137
  */
7347
8138
  bindingUtils: readonly TLAnyBindingUtilConstructor[];
7348
8139
  /**
7349
- * An array of tools to use in the editor. These will be used to handle events and manage user interactions in the editor.
8140
+ * An array of asset utils to use in the editor. These will be used to handle asset-type-specific behavior.
7350
8141
  */
7351
- tools: readonly TLStateNodeConstructor[];
8142
+ assetUtils?: readonly TLAnyAssetUtilConstructor[];
7352
8143
  /**
7353
- * Should return a containing html element which has all the styles applied to the editor. If not
7354
- * given, the body element will be used.
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.
7355
8146
  */
7356
- getContainer(): HTMLElement;
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[];
7357
8152
  /**
7358
8153
  * A user defined externally to replace the default user.
7359
8154
  */
7360
- user?: TLUser;
8155
+ user?: TLCurrentUser;
7361
8156
  /**
7362
8157
  * The editor's initial active tool (or other state node id).
7363
8158
  */
@@ -7366,27 +8161,15 @@ export declare interface TLEditorOptions {
7366
8161
  * Whether to automatically focus the editor when it mounts.
7367
8162
  */
7368
8163
  autoFocus?: boolean;
7369
- /**
7370
- * Whether to infer dark mode from the user's system preferences. Defaults to false.
7371
- */
7372
- inferDarkMode?: boolean;
7373
- /**
7374
- * Options for the editor's camera.
7375
- *
7376
- * @deprecated Use `options.cameraOptions` instead. This will be removed in a future release.
7377
- */
7378
- cameraOptions?: Partial<TLCameraOptions>;
7379
- options?: Partial<TldrawOptions>;
7380
- /**
7381
- * Text options for the editor.
7382
- *
7383
- * @deprecated Use `options.text` instead. This prop will be removed in a future release.
7384
- */
7385
- textOptions?: TLTextOptions;
7386
8164
  licenseKey?: string;
7387
8165
  fontAssetUrls?: {
7388
8166
  [key: string]: string | undefined;
7389
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;
7390
8173
  /**
7391
8174
  * Provides a way to hide shapes.
7392
8175
  *
@@ -7403,6 +8186,40 @@ export declare interface TLEditorOptions {
7403
8186
  * @param editor - The editor instance.
7404
8187
  */
7405
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;
7406
8223
  }
7407
8224
 
7408
8225
  /**
@@ -7461,6 +8278,7 @@ export declare const tlenv: {
7461
8278
  */
7462
8279
  export declare const tlenvReactive: Atom< {
7463
8280
  isCoarsePointer: boolean;
8281
+ supportsP3ColorSpace: boolean;
7464
8282
  }, unknown>;
7465
8283
 
7466
8284
  /** @public */
@@ -7589,6 +8407,7 @@ export declare interface TLFileReplaceExternalContent extends TLBaseExternalCont
7589
8407
  type: 'file-replace';
7590
8408
  file: File;
7591
8409
  shapeId: TLShapeId;
8410
+ /** @deprecated This field is no longer used by the default handler. It may be removed in a future version. */
7592
8411
  isImage: boolean;
7593
8412
  }
7594
8413
 
@@ -7600,69 +8419,18 @@ export declare interface TLFilesExternalContent extends TLBaseExternalContent {
7600
8419
  }
7601
8420
 
7602
8421
  /**
7603
- * A font face that can be used in the editor. The properties of this are largely the same as the
7604
- * ones in the
7605
- * {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face | css `@font-face` rule}.
7606
- * @public
7607
- */
7608
- export declare interface TLFontFace {
7609
- /**
7610
- * How this font can be referred to in CSS.
7611
- * See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-family | `font-family`}.
7612
- */
7613
- readonly family: string;
7614
- /**
7615
- * The source of the font. This
7616
- * See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src | `src`}.
7617
- */
7618
- readonly src: TLFontFaceSource;
7619
- /**
7620
- * See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/ascent-override | `ascent-override`}.
7621
- */
7622
- readonly ascentOverride?: string;
7623
- /**
7624
- * See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/descent-override | `descent-override`}.
7625
- */
7626
- readonly descentOverride?: string;
7627
- /**
7628
- * See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-stretch | `font-stretch`}.
7629
- */
7630
- readonly stretch?: string;
7631
- /**
7632
- * See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-style | `font-style`}.
7633
- */
7634
- readonly style?: string;
7635
- /**
7636
- * See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-weight | `font-weight`}.
7637
- */
7638
- readonly weight?: string;
7639
- /**
7640
- * See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/font-feature-settings | `font-feature-settings`}.
7641
- */
7642
- readonly featureSettings?: string;
7643
- /**
7644
- * See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/line-gap-override | `line-gap-override`}.
7645
- */
7646
- readonly lineGapOverride?: string;
7647
- /**
7648
- * See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/unicode-range | `unicode-range`}.
7649
- */
7650
- readonly unicodeRange?: string;
7651
- }
7652
-
7653
- /**
7654
- * Represents the `src` property of a {@link TLFontFace}.
7655
- * See {@link https://developer.mozilla.org/en-US/docs/Web/CSS/@font-face/src | `src`} for details of the properties here.
8422
+ * Emitted every animation frame when at least one `'frame'` listener is registered.
7656
8423
  * @public
7657
8424
  */
7658
- export declare interface TLFontFaceSource {
7659
- /**
7660
- * A URL from which to load the font. If the value here is a key in
7661
- * {@link tldraw#TLEditorAssetUrls.fonts}, the value from there will be used instead.
7662
- */
7663
- url: string;
7664
- format?: string;
7665
- tech?: string;
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;
7666
8434
  }
7667
8435
 
7668
8436
  /** Additional options for the {@link ShapeUtil.getGeometry} method.
@@ -7743,20 +8511,6 @@ export declare interface TLHandleDragInfo<T extends TLShape> {
7743
8511
  initial?: T | undefined;
7744
8512
  }
7745
8513
 
7746
- /** @public */
7747
- export declare interface TLHandleProps {
7748
- shapeId: TLShapeId;
7749
- handle: TLHandle;
7750
- zoom: number;
7751
- isCoarse: boolean;
7752
- className?: string;
7753
- }
7754
-
7755
- /** @public */
7756
- export declare interface TLHandlesProps {
7757
- children: ReactNode;
7758
- }
7759
-
7760
8514
  /** @public */
7761
8515
  export declare interface TLHistoryBatchOptions {
7762
8516
  /**
@@ -7807,6 +8561,38 @@ export declare type TLIndicatorPath = {
7807
8561
  path: Path2D;
7808
8562
  } | Path2D;
7809
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
+
7810
8596
  /** @public */
7811
8597
  export declare type TLInterruptEvent = (info: TLInterruptEventInfo) => void;
7812
8598
 
@@ -8054,6 +8840,130 @@ export declare const tlmenus: {
8054
8840
  */
8055
8841
  export declare type TLOnMountHandler = (editor: Editor) => (() => undefined | void) | undefined | void;
8056
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
+
8057
8967
  /** @public */
8058
8968
  export declare type TLPinchEvent = (info: TLPinchEventInfo) => void;
8059
8969
 
@@ -8093,6 +9003,10 @@ export declare type TLPointerEventTarget = {
8093
9003
  handle?: TLSelectionHandle;
8094
9004
  shape?: undefined;
8095
9005
  target: 'selection';
9006
+ } | {
9007
+ overlay: TLOverlay;
9008
+ shape?: undefined;
9009
+ target: 'overlay';
8096
9010
  } | {
8097
9011
  shape: TLShape;
8098
9012
  target: 'shape';
@@ -8163,28 +9077,12 @@ export declare type TLResizeShapeOptions = Partial<{
8163
9077
 
8164
9078
  /* Excluded from this release type: TLRotationSnapshot */
8165
9079
 
8166
- /** @public */
8167
- export declare interface TLScribbleProps {
8168
- userId?: string;
8169
- scribble: TLScribble;
8170
- zoom: number;
8171
- color?: string;
8172
- opacity?: number;
8173
- className?: string;
8174
- }
8175
-
8176
9080
  /** @public */
8177
9081
  export declare interface TLSelectionBackgroundProps {
8178
9082
  bounds: Box;
8179
9083
  rotation: number;
8180
9084
  }
8181
9085
 
8182
- /** @public */
8183
- export declare interface TLSelectionForegroundProps {
8184
- bounds: Box;
8185
- rotation: number;
8186
- }
8187
-
8188
9086
  /** @public */
8189
9087
  export declare type TLSelectionHandle = RotateCorner | SelectionCorner | SelectionEdge;
8190
9088
 
@@ -8219,26 +9117,26 @@ export declare type TLShapeErrorFallbackComponent = ComponentType<{
8219
9117
  }>;
8220
9118
 
8221
9119
  /** @public */
8222
- export declare type TLShapeIndicatorErrorFallbackComponent = ComponentType<{
8223
- error: unknown;
8224
- }>;
8225
-
8226
- /** @public */
8227
- export declare interface TLShapeIndicatorProps {
8228
- userId?: string;
8229
- shapeId: TLShapeId;
8230
- color?: string | undefined;
8231
- opacity?: number;
8232
- className?: string;
8233
- hidden?: boolean;
9120
+ export declare interface TLShapeIndicatorOverlay extends TLOverlay {
9121
+ props: {
9122
+ hintingShapeIds: TLShapeId[];
9123
+ idsToDisplay: TLShapeId[];
9124
+ };
8234
9125
  }
8235
9126
 
8236
- /** @public */
8237
- export declare interface TLShapeIndicatorsProps {
8238
- /** Whether to hide all of the indicators */
8239
- hideAll?: boolean;
8240
- /** Whether to show all of the indicators */
8241
- showAll?: boolean;
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;
8242
9140
  }
8243
9141
 
8244
9142
  /**
@@ -8298,6 +9196,7 @@ export declare interface TLShapeUtilConstructor<T extends TLShape, U extends Sha
8298
9196
  type: T['type'];
8299
9197
  props?: RecordProps<T>;
8300
9198
  migrations?: LegacyMigrations | MigrationSequence | TLPropsMigrations;
9199
+ handledAssetTypes?: readonly string[];
8301
9200
  }
8302
9201
 
8303
9202
  /** @public */
@@ -8310,13 +9209,6 @@ export declare interface TLShapeWrapperProps extends React.HTMLAttributes<HTMLDi
8310
9209
  children: ReactNode;
8311
9210
  }
8312
9211
 
8313
- /** @public */
8314
- export declare interface TLSnapIndicatorProps {
8315
- className?: string;
8316
- line: SnapIndicator;
8317
- zoom: number;
8318
- }
8319
-
8320
9212
  /** @public */
8321
9213
  export declare interface TLStateNodeConstructor {
8322
9214
  new (editor: Editor, parent?: StateNode): StateNode;
@@ -8325,6 +9217,7 @@ export declare interface TLStateNodeConstructor {
8325
9217
  children?(): TLStateNodeConstructor[];
8326
9218
  isLockable: boolean;
8327
9219
  useCoalescedEvents: boolean;
9220
+ trackPerformance: boolean;
8328
9221
  }
8329
9222
 
8330
9223
  /** @public */
@@ -8337,6 +9230,14 @@ export declare interface TLStoreBaseOptions {
8337
9230
  defaultName?: string;
8338
9231
  /** How should this store upload & resolve assets? */
8339
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>;
9239
+ /** How should this store resolve users for attribution? */
9240
+ users?: TLUserStore;
8340
9241
  /** Called when the store is connected to an {@link @tldraw/editor#Editor}. */
8341
9242
  onMount?(editor: Editor): (() => void) | void;
8342
9243
  }
@@ -8356,6 +9257,7 @@ export declare type TLStoreOptions = TLStoreBaseOptions & {
8356
9257
 
8357
9258
  /** @public */
8358
9259
  export declare type TLStoreSchemaOptions = {
9260
+ assetUtils?: readonly TLAnyAssetUtilConstructor[];
8359
9261
  bindingUtils?: readonly TLAnyBindingUtilConstructor[];
8360
9262
  migrations?: readonly MigrationSequence[];
8361
9263
  records?: Record<string, CustomRecordInfo>;
@@ -8493,6 +9395,19 @@ export declare interface TLTldrawExternalContentSource {
8493
9395
  data: TLContent;
8494
9396
  }
8495
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
+
8496
9411
  /** @public */
8497
9412
  export declare interface TLUpdatePointerOptions {
8498
9413
  /** Whether to update the pointer immediately, rather than on the next tick. */
@@ -8524,12 +9439,6 @@ export declare interface TLUrlExternalContent extends TLBaseExternalContent {
8524
9439
  url: string;
8525
9440
  }
8526
9441
 
8527
- /** @public */
8528
- export declare interface TLUser {
8529
- readonly userPreferences: Signal<TLUserPreferences>;
8530
- readonly setUserPreferences: (userPreferences: TLUserPreferences) => void;
8531
- }
8532
-
8533
9442
  /**
8534
9443
  * A user of tldraw
8535
9444
  *
@@ -8630,6 +9539,9 @@ export declare function uniq<T>(array: {
8630
9539
  readonly length: number;
8631
9540
  } | null | undefined): T[];
8632
9541
 
9542
+ /** @public */
9543
+ export declare function useColorMode(): 'dark' | 'light';
9544
+
8633
9545
  /** @public */
8634
9546
  export declare function useContainer(): HTMLElement;
8635
9547
 
@@ -8668,9 +9580,6 @@ export declare function useGlobalMenuIsOpen(id: string, onChange?: (isOpen: bool
8668
9580
  /** @public */
8669
9581
  export declare function useIsCropping(shapeId: TLShapeId): boolean;
8670
9582
 
8671
- /** @public */
8672
- export declare function useIsDarkMode(): boolean;
8673
-
8674
9583
  /** @public */
8675
9584
  export declare function useIsEditing(shapeId: TLShapeId): boolean;
8676
9585
 
@@ -8688,6 +9597,10 @@ export declare function usePassThroughMouseOverEvents(ref: RefObject<HTMLElement
8688
9597
  export declare function usePassThroughWheelEvents(ref: RefObject<HTMLElement | null>): void;
8689
9598
 
8690
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
+ *
8691
9604
  * @returns The list of peer UserIDs
8692
9605
  * @public
8693
9606
  */
@@ -8708,11 +9621,11 @@ export declare function usePresence(userId: string): null | TLInstancePresence;
8708
9621
  /** @public */
8709
9622
  export declare class UserPreferencesManager {
8710
9623
  private readonly user;
8711
- private readonly inferDarkMode;
9624
+ private readonly colorScheme;
8712
9625
  systemColorScheme: Atom<"dark" | "light", unknown>;
8713
9626
  disposables: Set<() => void>;
8714
9627
  dispose(): void;
8715
- constructor(user: TLUser, inferDarkMode: boolean);
9628
+ constructor(user: TLCurrentUser, colorScheme: 'dark' | 'light' | 'system');
8716
9629
  updateUserPreferences(userPreferences: Partial<TLUserPreferences>): void;
8717
9630
  getUserPreferences(): {
8718
9631
  animationSpeed: number;
@@ -8783,10 +9696,10 @@ export declare function useSvgExportContext(): null | SvgExportContext;
8783
9696
  /**
8784
9697
  * @public
8785
9698
  */
8786
- export declare function useTldrawUser(opts: {
9699
+ export declare function useTldrawCurrentUser(opts: {
8787
9700
  setUserPreferences?: (userPreferences: TLUserPreferences) => void;
8788
9701
  userPreferences?: Signal<TLUserPreferences> | TLUserPreferences;
8789
- }): TLUser;
9702
+ }): TLCurrentUser;
8790
9703
 
8791
9704
  /** @public */
8792
9705
  export declare function useTLSchemaFromUtils(opts: TLStoreSchemaOptions): StoreSchema<TLRecord, TLStoreProps>;