@tldraw/editor 3.12.0-internal.34d12af75e37 → 3.12.0

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 (100) hide show
  1. package/CHANGELOG.md +134 -0
  2. package/dist-cjs/index.d.ts +162 -17
  3. package/dist-cjs/index.js +3 -1
  4. package/dist-cjs/index.js.map +2 -2
  5. package/dist-cjs/lib/TldrawEditor.js +5 -0
  6. package/dist-cjs/lib/TldrawEditor.js.map +2 -2
  7. package/dist-cjs/lib/components/GeometryDebuggingView.js +2 -2
  8. package/dist-cjs/lib/components/GeometryDebuggingView.js.map +2 -2
  9. package/dist-cjs/lib/components/default-components/DefaultCanvas.js +10 -1
  10. package/dist-cjs/lib/components/default-components/DefaultCanvas.js.map +2 -2
  11. package/dist-cjs/lib/editor/Editor.js +208 -18
  12. package/dist-cjs/lib/editor/Editor.js.map +2 -2
  13. package/dist-cjs/lib/editor/managers/FocusManager.js +1 -1
  14. package/dist-cjs/lib/editor/managers/FocusManager.js.map +2 -2
  15. package/dist-cjs/lib/editor/shapes/ShapeUtil.js +12 -0
  16. package/dist-cjs/lib/editor/shapes/ShapeUtil.js.map +2 -2
  17. package/dist-cjs/lib/editor/shapes/group/GroupShapeUtil.js +4 -13
  18. package/dist-cjs/lib/editor/shapes/group/GroupShapeUtil.js.map +2 -2
  19. package/dist-cjs/lib/editor/types/selection-types.js.map +1 -1
  20. package/dist-cjs/lib/exports/StyleEmbedder.js +19 -61
  21. package/dist-cjs/lib/exports/StyleEmbedder.js.map +2 -2
  22. package/dist-cjs/lib/exports/cssRules.js.map +2 -2
  23. package/dist-cjs/lib/exports/exportToSvg.js +1 -4
  24. package/dist-cjs/lib/exports/exportToSvg.js.map +2 -2
  25. package/dist-cjs/lib/hooks/useCanvasEvents.js +2 -2
  26. package/dist-cjs/lib/hooks/useCanvasEvents.js.map +2 -2
  27. package/dist-cjs/lib/hooks/useDocumentEvents.js +16 -0
  28. package/dist-cjs/lib/hooks/useDocumentEvents.js.map +2 -2
  29. package/dist-cjs/lib/license/Watermark.js +10 -20
  30. package/dist-cjs/lib/license/Watermark.js.map +2 -2
  31. package/dist-cjs/lib/primitives/geometry/Geometry2d.js +128 -16
  32. package/dist-cjs/lib/primitives/geometry/Geometry2d.js.map +3 -3
  33. package/dist-cjs/lib/primitives/geometry/Group2d.js +54 -11
  34. package/dist-cjs/lib/primitives/geometry/Group2d.js.map +2 -2
  35. package/dist-cjs/lib/primitives/intersect.js +20 -0
  36. package/dist-cjs/lib/primitives/intersect.js.map +2 -2
  37. package/dist-cjs/lib/utils/reorderShapes.js +2 -8
  38. package/dist-cjs/lib/utils/reorderShapes.js.map +2 -2
  39. package/dist-cjs/version.js +3 -3
  40. package/dist-cjs/version.js.map +1 -1
  41. package/dist-esm/index.d.mts +162 -17
  42. package/dist-esm/index.mjs +8 -2
  43. package/dist-esm/index.mjs.map +2 -2
  44. package/dist-esm/lib/TldrawEditor.mjs +5 -0
  45. package/dist-esm/lib/TldrawEditor.mjs.map +2 -2
  46. package/dist-esm/lib/components/GeometryDebuggingView.mjs +3 -3
  47. package/dist-esm/lib/components/GeometryDebuggingView.mjs.map +2 -2
  48. package/dist-esm/lib/components/default-components/DefaultCanvas.mjs +10 -1
  49. package/dist-esm/lib/components/default-components/DefaultCanvas.mjs.map +2 -2
  50. package/dist-esm/lib/editor/Editor.mjs +209 -18
  51. package/dist-esm/lib/editor/Editor.mjs.map +2 -2
  52. package/dist-esm/lib/editor/managers/FocusManager.mjs +1 -1
  53. package/dist-esm/lib/editor/managers/FocusManager.mjs.map +2 -2
  54. package/dist-esm/lib/editor/shapes/ShapeUtil.mjs +12 -0
  55. package/dist-esm/lib/editor/shapes/ShapeUtil.mjs.map +2 -2
  56. package/dist-esm/lib/editor/shapes/group/GroupShapeUtil.mjs +4 -13
  57. package/dist-esm/lib/editor/shapes/group/GroupShapeUtil.mjs.map +2 -2
  58. package/dist-esm/lib/exports/StyleEmbedder.mjs +20 -62
  59. package/dist-esm/lib/exports/StyleEmbedder.mjs.map +2 -2
  60. package/dist-esm/lib/exports/cssRules.mjs.map +2 -2
  61. package/dist-esm/lib/exports/exportToSvg.mjs +1 -4
  62. package/dist-esm/lib/exports/exportToSvg.mjs.map +2 -2
  63. package/dist-esm/lib/hooks/useCanvasEvents.mjs +2 -2
  64. package/dist-esm/lib/hooks/useCanvasEvents.mjs.map +2 -2
  65. package/dist-esm/lib/hooks/useDocumentEvents.mjs +16 -0
  66. package/dist-esm/lib/hooks/useDocumentEvents.mjs.map +2 -2
  67. package/dist-esm/lib/license/Watermark.mjs +10 -20
  68. package/dist-esm/lib/license/Watermark.mjs.map +2 -2
  69. package/dist-esm/lib/primitives/geometry/Geometry2d.mjs +132 -14
  70. package/dist-esm/lib/primitives/geometry/Geometry2d.mjs.map +2 -2
  71. package/dist-esm/lib/primitives/geometry/Group2d.mjs +55 -12
  72. package/dist-esm/lib/primitives/geometry/Group2d.mjs.map +2 -2
  73. package/dist-esm/lib/primitives/intersect.mjs +20 -0
  74. package/dist-esm/lib/primitives/intersect.mjs.map +2 -2
  75. package/dist-esm/lib/utils/reorderShapes.mjs +2 -8
  76. package/dist-esm/lib/utils/reorderShapes.mjs.map +2 -2
  77. package/dist-esm/version.mjs +3 -3
  78. package/dist-esm/version.mjs.map +1 -1
  79. package/editor.css +34 -19
  80. package/package.json +7 -7
  81. package/src/index.ts +11 -2
  82. package/src/lib/TldrawEditor.tsx +30 -3
  83. package/src/lib/components/GeometryDebuggingView.tsx +3 -3
  84. package/src/lib/components/default-components/DefaultCanvas.tsx +6 -1
  85. package/src/lib/editor/Editor.ts +315 -24
  86. package/src/lib/editor/managers/FocusManager.ts +1 -1
  87. package/src/lib/editor/shapes/ShapeUtil.ts +14 -0
  88. package/src/lib/editor/shapes/group/GroupShapeUtil.tsx +7 -15
  89. package/src/lib/editor/types/selection-types.ts +3 -0
  90. package/src/lib/exports/StyleEmbedder.ts +22 -83
  91. package/src/lib/exports/cssRules.ts +1 -0
  92. package/src/lib/exports/exportToSvg.tsx +1 -5
  93. package/src/lib/hooks/useCanvasEvents.ts +6 -2
  94. package/src/lib/hooks/useDocumentEvents.ts +18 -0
  95. package/src/lib/license/Watermark.tsx +18 -29
  96. package/src/lib/primitives/geometry/Geometry2d.ts +196 -16
  97. package/src/lib/primitives/geometry/Group2d.ts +76 -13
  98. package/src/lib/primitives/intersect.ts +41 -0
  99. package/src/lib/utils/reorderShapes.ts +2 -9
  100. package/src/version.ts +3 -3
package/src/index.ts CHANGED
@@ -293,7 +293,11 @@ export {
293
293
  type TLSvgExportOptions,
294
294
  type TLSvgOptions,
295
295
  } from './lib/editor/types/misc-types'
296
- export { type TLResizeHandle, type TLSelectionHandle } from './lib/editor/types/selection-types'
296
+ export {
297
+ type TLAdjacentDirection,
298
+ type TLResizeHandle,
299
+ type TLSelectionHandle,
300
+ } from './lib/editor/types/selection-types'
297
301
  export { getSvgAsImage } from './lib/exports/getSvgAsImage'
298
302
  export { tlenv } from './lib/globals/environment'
299
303
  export { tlmenus } from './lib/globals/menus'
@@ -360,7 +364,12 @@ export { CubicBezier2d } from './lib/primitives/geometry/CubicBezier2d'
360
364
  export { CubicSpline2d } from './lib/primitives/geometry/CubicSpline2d'
361
365
  export { Edge2d } from './lib/primitives/geometry/Edge2d'
362
366
  export { Ellipse2d } from './lib/primitives/geometry/Ellipse2d'
363
- export { Geometry2d, type Geometry2dOptions } from './lib/primitives/geometry/Geometry2d'
367
+ export {
368
+ Geometry2d,
369
+ Geometry2dFilters,
370
+ TransformedGeometry2d,
371
+ type Geometry2dOptions,
372
+ } from './lib/primitives/geometry/Geometry2d'
364
373
  export { Group2d } from './lib/primitives/geometry/Group2d'
365
374
  export { Point2d } from './lib/primitives/geometry/Point2d'
366
375
  export { Polygon2d } from './lib/primitives/geometry/Polygon2d'
@@ -50,7 +50,7 @@ import { TLStoreWithStatus } from './utils/sync/StoreWithStatus'
50
50
 
51
51
  /**
52
52
  * Props for the {@link tldraw#Tldraw} and {@link TldrawEditor} components, when passing in a
53
- * {@link store#TLStore} directly. If you would like tldraw to create a store for you, use
53
+ * `TLStore` directly. If you would like tldraw to create a store for you, use
54
54
  * {@link TldrawEditorWithoutStoreProps}.
55
55
  *
56
56
  * @public
@@ -64,7 +64,7 @@ export interface TldrawEditorWithStoreProps {
64
64
 
65
65
  /**
66
66
  * Props for the {@link tldraw#Tldraw} and {@link TldrawEditor} components, when not passing in a
67
- * {@link store#TLStore} directly. If you would like to pass in a store directly, use
67
+ * `TLStore` directly. If you would like to pass in a store directly, use
68
68
  * {@link TldrawEditorWithStoreProps}.
69
69
  *
70
70
  * @public
@@ -191,11 +191,33 @@ export interface TldrawEditorBaseProps {
191
191
  /**
192
192
  * Predicate for whether or not a shape should be hidden.
193
193
  *
194
+ * @deprecated Use {@link TldrawEditorBaseProps#getShapeVisibility} instead.
195
+ */
196
+ isShapeHidden?(shape: TLShape, editor: Editor): boolean
197
+
198
+ /**
199
+ * Provides a way to hide shapes.
200
+ *
194
201
  * Hidden shapes will not render in the editor, and they will not be eligible for hit test via
195
202
  * {@link Editor#getShapeAtPoint} and {@link Editor#getShapesAtPoint}. But otherwise they will
196
203
  * remain in the store and participate in all other operations.
204
+ *
205
+ * @example
206
+ * ```ts
207
+ * getShapeVisibility={(shape, editor) => shape.meta.hidden ? 'hidden' : 'inherit'}
208
+ * ```
209
+ *
210
+ * - `'inherit' | undefined` - (default) The shape will be visible unless its parent is hidden.
211
+ * - `'hidden'` - The shape will be hidden.
212
+ * - `'visible'` - The shape will be visible.
213
+ *
214
+ * @param shape - The shape to check.
215
+ * @param editor - The editor instance.
197
216
  */
198
- isShapeHidden?(shape: TLShape, editor: Editor): boolean
217
+ getShapeVisibility?(
218
+ shape: TLShape,
219
+ editor: Editor
220
+ ): 'visible' | 'hidden' | 'inherit' | null | undefined
199
221
 
200
222
  /**
201
223
  * The URLs for the fonts to use in the editor.
@@ -262,6 +284,7 @@ export const TldrawEditor = memo(function TldrawEditor({
262
284
  className={classNames(`${TL_CONTAINER_CLASS} tl-theme__light`, className)}
263
285
  onPointerDown={stopEventPropagation}
264
286
  tabIndex={-1}
287
+ role="application"
265
288
  >
266
289
  <OptionalErrorBoundary
267
290
  fallback={ErrorFallback}
@@ -387,7 +410,9 @@ function TldrawEditorWithReadyStore({
387
410
  options,
388
411
  licenseKey,
389
412
  deepLinks: _deepLinks,
413
+ // eslint-disable-next-line @typescript-eslint/no-deprecated
390
414
  isShapeHidden,
415
+ getShapeVisibility,
391
416
  assetUrls,
392
417
  }: Required<
393
418
  TldrawEditorProps & {
@@ -447,6 +472,7 @@ function TldrawEditorWithReadyStore({
447
472
  options,
448
473
  licenseKey,
449
474
  isShapeHidden,
475
+ getShapeVisibility,
450
476
  fontAssetUrls: assetUrls?.fonts,
451
477
  })
452
478
 
@@ -482,6 +508,7 @@ function TldrawEditorWithReadyStore({
482
508
  setEditor,
483
509
  licenseKey,
484
510
  isShapeHidden,
511
+ getShapeVisibility,
485
512
  textOptions,
486
513
  assetUrls,
487
514
  ]
@@ -114,13 +114,13 @@ export const GeometryDebuggingView = track(function GeometryDebuggingView({
114
114
  function GeometryStroke({ geometry }: { geometry: Geometry2d }) {
115
115
  if (geometry instanceof Group2d) {
116
116
  return (
117
- <>
117
+ <g stroke={geometry.debugColor}>
118
118
  {[...geometry.children, ...geometry.ignoredChildren].map((child, i) => (
119
119
  <GeometryStroke geometry={child} key={i} />
120
120
  ))}
121
- </>
121
+ </g>
122
122
  )
123
123
  }
124
124
 
125
- return <path d={geometry.toSimpleSvgPath()} />
125
+ return <path d={geometry.toSimpleSvgPath()} stroke={geometry.debugColor} />
126
126
  }
@@ -361,7 +361,12 @@ function HandleWrapper({
361
361
  if (!Handle) return null
362
362
 
363
363
  return (
364
- <g aria-label="handle" transform={`translate(${handle.x}, ${handle.y})`} {...events}>
364
+ <g
365
+ role="button"
366
+ aria-label="handle"
367
+ transform={`translate(${handle.x}, ${handle.y})`}
368
+ {...events}
369
+ >
365
370
  <Handle shapeId={shapeId} handle={handle} zoom={zoom} isCoarse={isCoarse} />
366
371
  </g>
367
372
  )
@@ -87,6 +87,7 @@ import {
87
87
  last,
88
88
  lerp,
89
89
  maxBy,
90
+ minBy,
90
91
  sortById,
91
92
  sortByIndex,
92
93
  structuredClone,
@@ -176,7 +177,7 @@ import {
176
177
  TLImageExportOptions,
177
178
  TLSvgExportOptions,
178
179
  } from './types/misc-types'
179
- import { TLResizeHandle } from './types/selection-types'
180
+ import { TLAdjacentDirection, TLResizeHandle } from './types/selection-types'
180
181
 
181
182
  /** @public */
182
183
  export type TLResizeShapeOptions = Partial<{
@@ -241,10 +242,33 @@ export interface TLEditorOptions {
241
242
  fontAssetUrls?: { [key: string]: string | undefined }
242
243
  /**
243
244
  * A predicate that should return true if the given shape should be hidden.
245
+ *
246
+ * @deprecated Use {@link Editor#getShapeVisibility} instead.
247
+ *
244
248
  * @param shape - The shape to check.
245
249
  * @param editor - The editor instance.
246
250
  */
247
251
  isShapeHidden?(shape: TLShape, editor: Editor): boolean
252
+
253
+ /**
254
+ * Provides a way to hide shapes.
255
+ *
256
+ * @example
257
+ * ```ts
258
+ * getShapeVisibility={(shape, editor) => shape.meta.hidden ? 'hidden' : 'inherit'}
259
+ * ```
260
+ *
261
+ * - `'inherit' | undefined` - (default) The shape will be visible unless its parent is hidden.
262
+ * - `'hidden'` - The shape will be hidden.
263
+ * - `'visible'` - The shape will be visible.
264
+ *
265
+ * @param shape - The shape to check.
266
+ * @param editor - The editor instance.
267
+ */
268
+ getShapeVisibility?(
269
+ shape: TLShape,
270
+ editor: Editor
271
+ ): 'visible' | 'hidden' | 'inherit' | null | undefined
248
272
  }
249
273
 
250
274
  /**
@@ -281,12 +305,21 @@ export class Editor extends EventEmitter<TLEventMap> {
281
305
  autoFocus,
282
306
  inferDarkMode,
283
307
  options,
308
+ // eslint-disable-next-line @typescript-eslint/no-deprecated
284
309
  isShapeHidden,
310
+ getShapeVisibility,
285
311
  fontAssetUrls,
286
312
  }: TLEditorOptions) {
287
313
  super()
314
+ assert(
315
+ !(isShapeHidden && getShapeVisibility),
316
+ 'Cannot use both isShapeHidden and getShapeVisibility'
317
+ )
288
318
 
289
- this._isShapeHiddenPredicate = isShapeHidden
319
+ this._getShapeVisibility = isShapeHidden
320
+ ? // eslint-disable-next-line @typescript-eslint/no-deprecated
321
+ (shape: TLShape, editor: Editor) => (isShapeHidden(shape, editor) ? 'hidden' : 'inherit')
322
+ : getShapeVisibility
290
323
 
291
324
  this.options = { ...defaultTldrawOptions, ...options }
292
325
 
@@ -773,18 +806,22 @@ export class Editor extends EventEmitter<TLEventMap> {
773
806
  }
774
807
  }
775
808
 
776
- private readonly _isShapeHiddenPredicate?: (shape: TLShape, editor: Editor) => boolean
809
+ private readonly _getShapeVisibility?: TLEditorOptions['getShapeVisibility']
777
810
  @computed
778
811
  private getIsShapeHiddenCache() {
779
- if (!this._isShapeHiddenPredicate) return null
812
+ if (!this._getShapeVisibility) return null
780
813
  return this.store.createComputedCache<boolean, TLShape>('isShapeHidden', (shape: TLShape) => {
781
- const hiddenParent = this.findShapeAncestor(shape, (p) => this.isShapeHidden(p))
782
- if (hiddenParent) return true
783
- return this._isShapeHiddenPredicate!(shape, this) ?? false
814
+ const visibility = this._getShapeVisibility!(shape, this)
815
+ const isParentHidden = PageRecordType.isId(shape.parentId)
816
+ ? false
817
+ : this.isShapeHidden(shape.parentId)
818
+
819
+ if (isParentHidden) return visibility !== 'visible'
820
+ return visibility === 'hidden'
784
821
  })
785
822
  }
786
823
  isShapeHidden(shapeOrId: TLShape | TLShapeId): boolean {
787
- if (!this._isShapeHiddenPredicate) return false
824
+ if (!this._getShapeVisibility) return false
788
825
  return !!this.getIsShapeHiddenCache!()!.get(
789
826
  typeof shapeOrId === 'string' ? shapeOrId : shapeOrId.id
790
827
  )
@@ -1777,6 +1814,195 @@ export class Editor extends EventEmitter<TLEventMap> {
1777
1814
  return this
1778
1815
  }
1779
1816
 
1817
+ selectAdjacentShape(direction: TLAdjacentDirection) {
1818
+ const readingOrderShapes = this.getCurrentPageShapesInReadingOrder()
1819
+ const selectedShapeIds = this.getSelectedShapeIds()
1820
+ const currentShapeId: TLShapeId | undefined =
1821
+ selectedShapeIds.length === 1
1822
+ ? selectedShapeIds[0]
1823
+ : readingOrderShapes.find((shape) => selectedShapeIds.includes(shape.id))?.id
1824
+
1825
+ let adjacentShapeId: TLShapeId
1826
+ if (direction === 'next' || direction === 'prev') {
1827
+ const shapeIds = readingOrderShapes.map((shape) => shape.id)
1828
+
1829
+ const currentIndex = currentShapeId ? shapeIds.indexOf(currentShapeId) : -1
1830
+ const adjacentIndex =
1831
+ (currentIndex + (direction === 'next' ? 1 : -1) + shapeIds.length) % shapeIds.length
1832
+ adjacentShapeId = shapeIds[adjacentIndex]
1833
+ } else {
1834
+ if (!currentShapeId) return
1835
+ adjacentShapeId = this.getNearestAdjacentShape(currentShapeId, direction)
1836
+ }
1837
+
1838
+ const shape = this.getShape(adjacentShapeId)
1839
+ if (!shape) return
1840
+
1841
+ this.setSelectedShapes([shape.id])
1842
+ this.zoomToSelectionIfOffscreen(256, {
1843
+ animation: {
1844
+ duration: this.options.animationMediumMs,
1845
+ },
1846
+ inset: 0,
1847
+ })
1848
+ }
1849
+
1850
+ /**
1851
+ * Generates a reading order for shapes based on rows grouping.
1852
+ * Tries to keep a natural reading order (left-to-right, top-to-bottom).
1853
+ *
1854
+ * @public
1855
+ */
1856
+ @computed getCurrentPageShapesInReadingOrder(): TLShape[] {
1857
+ const SHALLOW_ANGLE = 20
1858
+ const ROW_THRESHOLD = 100
1859
+
1860
+ const shapes = this.getCurrentPageShapes()
1861
+ const tabbableShapes = shapes.filter((shape) => this.getShapeUtil(shape).canTabTo(shape))
1862
+
1863
+ if (tabbableShapes.length <= 1) return tabbableShapes
1864
+
1865
+ const shapesWithCenters = tabbableShapes.map((shape) => ({
1866
+ shape,
1867
+ center: this.getShapePageBounds(shape)!.center,
1868
+ }))
1869
+ shapesWithCenters.sort((a, b) => a.center.y - b.center.y)
1870
+
1871
+ const rows: Array<typeof shapesWithCenters> = []
1872
+
1873
+ // First, group shapes into rows based on y-coordinates.
1874
+ for (const shapeWithCenter of shapesWithCenters) {
1875
+ let rowIndex = -1
1876
+ for (let i = rows.length - 1; i >= 0; i--) {
1877
+ const row = rows[i]
1878
+ const lastShapeInRow = row[row.length - 1]
1879
+
1880
+ // If the shape is close enough vertically to the last shape in this row.
1881
+ if (Math.abs(shapeWithCenter.center.y - lastShapeInRow.center.y) < ROW_THRESHOLD) {
1882
+ rowIndex = i
1883
+ break
1884
+ }
1885
+ }
1886
+
1887
+ // If no suitable row found, create a new row.
1888
+ if (rowIndex === -1) {
1889
+ rows.push([shapeWithCenter])
1890
+ } else {
1891
+ rows[rowIndex].push(shapeWithCenter)
1892
+ }
1893
+ }
1894
+
1895
+ // Then, sort each row by x-coordinate (left-to-right).
1896
+ for (const row of rows) {
1897
+ row.sort((a, b) => a.center.x - b.center.x)
1898
+ }
1899
+
1900
+ // Finally, apply angle/distance weight adjustments within rows for closely positioned shapes.
1901
+ for (const row of rows) {
1902
+ if (row.length <= 2) continue
1903
+
1904
+ for (let i = 0; i < row.length - 2; i++) {
1905
+ const currentShape = row[i]
1906
+ const nextShape = row[i + 1]
1907
+ const nextNextShape = row[i + 2]
1908
+
1909
+ // Only consider adjustment if the next two shapes are relatively close to each other.
1910
+ const dist1 = Vec.Dist2(currentShape.center, nextShape.center)
1911
+ const dist2 = Vec.Dist2(currentShape.center, nextNextShape.center)
1912
+
1913
+ // Check if the 2nd shape is actually closer to the current shape.
1914
+ if (dist2 < dist1 * 0.9) {
1915
+ // Check if it's a shallow enough angle.
1916
+ const angle = Math.abs(
1917
+ Vec.Angle(currentShape.center, nextNextShape.center) * (180 / Math.PI)
1918
+ )
1919
+ if (angle <= SHALLOW_ANGLE) {
1920
+ // Swap swap.
1921
+ ;[row[i + 1], row[i + 2]] = [row[i + 2], row[i + 1]]
1922
+ }
1923
+ }
1924
+ }
1925
+ }
1926
+
1927
+ return rows.flat().map((item) => item.shape)
1928
+ }
1929
+
1930
+ /**
1931
+ * Find the nearest adjacent shape in a specific direction.
1932
+ *
1933
+ * @public
1934
+ */
1935
+ getNearestAdjacentShape(
1936
+ currentShapeId: TLShapeId,
1937
+ direction: 'left' | 'right' | 'up' | 'down'
1938
+ ): TLShapeId {
1939
+ const directionToAngle = { right: 0, left: 180, down: 90, up: 270 }
1940
+ const currentShape = this.getShape(currentShapeId)
1941
+ if (!currentShape) return currentShapeId
1942
+
1943
+ const shapes = this.getCurrentPageShapes()
1944
+ const tabbableShapes = shapes.filter(
1945
+ (shape) => this.getShapeUtil(shape).canTabTo(shape) && shape.id !== currentShapeId
1946
+ )
1947
+ if (!tabbableShapes.length) return currentShapeId
1948
+
1949
+ const currentCenter = this.getShapePageBounds(currentShape)!.center
1950
+ const shapesWithCenters = tabbableShapes.map((shape) => ({
1951
+ shape,
1952
+ center: this.getShapePageBounds(shape)!.center,
1953
+ }))
1954
+
1955
+ // Filter shapes that are in the same direction.
1956
+ const shapesInDirection = shapesWithCenters.filter(({ center }) => {
1957
+ const isRight = center.x > currentCenter.x
1958
+ const isDown = center.y > currentCenter.y
1959
+ const xDist = center.x - currentCenter.x
1960
+ const yDist = center.y - currentCenter.y
1961
+ const isInXDirection = Math.abs(yDist) < Math.abs(xDist) * 2
1962
+ const isInYDirection = Math.abs(xDist) < Math.abs(yDist) * 2
1963
+ if (direction === 'left' || direction === 'right') {
1964
+ return isInXDirection && (direction === 'right' ? isRight : !isRight)
1965
+ }
1966
+ if (direction === 'up' || direction === 'down') {
1967
+ return isInYDirection && (direction === 'down' ? isDown : !isDown)
1968
+ }
1969
+ })
1970
+
1971
+ if (shapesInDirection.length === 0) return currentShapeId
1972
+
1973
+ // Ok, now score that subset of shapes.
1974
+ const lowestScoringShape = minBy(shapesInDirection, ({ center }) => {
1975
+ // Distance is the primary weighting factor.
1976
+ const distance = Vec.Dist2(currentCenter, center)
1977
+
1978
+ // Distance along the primary axis.
1979
+ const dirProp = ['left', 'right'].includes(direction) ? 'x' : 'y'
1980
+ const directionalDistance = Math.abs(center[dirProp] - currentCenter[dirProp])
1981
+
1982
+ // Distance off the perpendicular to the primary axis.
1983
+ const offProp = ['left', 'right'].includes(direction) ? 'y' : 'x'
1984
+ const offAxisDeviation = Math.abs(center[offProp] - currentCenter[offProp])
1985
+
1986
+ // Angle in degrees
1987
+ const angle = Math.abs(Vec.Angle(currentCenter, center) * (180 / Math.PI))
1988
+ const angleDeviation = Math.abs(angle - directionToAngle[direction])
1989
+
1990
+ // Calculate final score (lower is better).
1991
+ // Weight factors to prioritize:
1992
+ // 1. Shapes directly in line with the current shape
1993
+ // 2. Shapes closer to the current shape
1994
+ // 3. Shapes with less angular deviation from the primary direction
1995
+ return (
1996
+ distance * 1.0 + // Base distance
1997
+ offAxisDeviation * 2.0 + // Heavy penalty for off-axis deviation
1998
+ (distance - directionalDistance) * 1.5 + // Penalty for diagonal distance
1999
+ angleDeviation * 0.5
2000
+ ) // Slight penalty for angular deviation
2001
+ })
2002
+
2003
+ return lowestScoringShape!.shape.id
2004
+ }
2005
+
1780
2006
  /**
1781
2007
  * Clear the selection.
1782
2008
  *
@@ -3018,6 +3244,34 @@ export class Editor extends EventEmitter<TLEventMap> {
3018
3244
  return this
3019
3245
  }
3020
3246
 
3247
+ /**
3248
+ * Zoom the camera to the current selection if offscreen.
3249
+ *
3250
+ * @public
3251
+ */
3252
+ zoomToSelectionIfOffscreen(
3253
+ padding = 16,
3254
+ opts?: { targetZoom?: number; inset?: number } & TLCameraMoveOptions
3255
+ ) {
3256
+ const selectionPageBounds = this.getSelectionPageBounds()
3257
+ const viewportPageBounds = this.getViewportPageBounds()
3258
+ if (selectionPageBounds && !viewportPageBounds.contains(selectionPageBounds)) {
3259
+ const eb = selectionPageBounds
3260
+ .clone()
3261
+ // Expand the bounds by the padding
3262
+ .expandBy(padding / this.getZoomLevel())
3263
+ // then expand the bounds to include the viewport bounds
3264
+ .expand(viewportPageBounds)
3265
+
3266
+ // then use the difference between the centers to calculate the offset
3267
+ const nextBounds = viewportPageBounds.clone().translate({
3268
+ x: (eb.center.x - viewportPageBounds.center.x) * 2,
3269
+ y: (eb.center.y - viewportPageBounds.center.y) * 2,
3270
+ })
3271
+ this.zoomToBounds(nextBounds, opts)
3272
+ }
3273
+ }
3274
+
3021
3275
  /**
3022
3276
  * Zoom the camera to fit a bounding box (in the current page space).
3023
3277
  *
@@ -3711,7 +3965,15 @@ export class Editor extends EventEmitter<TLEventMap> {
3711
3965
  const addShapeById = (id: TLShapeId, opacity: number, isAncestorErasing: boolean) => {
3712
3966
  const shape = this.getShape(id)
3713
3967
  if (!shape) return
3714
- if (this.isShapeHidden(shape)) return
3968
+
3969
+ if (this.isShapeHidden(shape)) {
3970
+ // process children just in case they are overriding the hidden state
3971
+ const isErasing = isAncestorErasing || erasingShapeIds.includes(id)
3972
+ for (const childId of this.getSortedChildIdsForParent(id)) {
3973
+ addShapeById(childId, opacity, isErasing)
3974
+ }
3975
+ return
3976
+ }
3715
3977
 
3716
3978
  opacity *= shape.opacity
3717
3979
  let isShapeErasing = false
@@ -4286,7 +4548,7 @@ export class Editor extends EventEmitter<TLEventMap> {
4286
4548
  private _shapeGeometryCaches: Record<string, ComputedCache<Geometry2d, TLShape>> = {}
4287
4549
 
4288
4550
  /**
4289
- * Get the geometry of a shape.
4551
+ * Get the geometry of a shape in shape-space.
4290
4552
  *
4291
4553
  * @example
4292
4554
  * ```ts
@@ -4317,6 +4579,44 @@ export class Editor extends EventEmitter<TLEventMap> {
4317
4579
  )! as T
4318
4580
  }
4319
4581
 
4582
+ private _shapePageGeometryCaches: Record<string, ComputedCache<Geometry2d, TLShape>> = {}
4583
+
4584
+ /**
4585
+ * Get the geometry of a shape in page-space.
4586
+ *
4587
+ * @example
4588
+ * ```ts
4589
+ * editor.getShapePageGeometry(myShape)
4590
+ * editor.getShapePageGeometry(myShapeId)
4591
+ * editor.getShapePageGeometry(myShapeId, { context: "arrow" })
4592
+ * ```
4593
+ *
4594
+ * @param shape - The shape (or shape id) to get the geometry for.
4595
+ * @param opts - Additional options about the request for geometry. Passed to {@link ShapeUtil.getGeometry}.
4596
+ *
4597
+ * @public
4598
+ */
4599
+ getShapePageGeometry<T extends Geometry2d>(shape: TLShape | TLShapeId, opts?: TLGeometryOpts): T {
4600
+ const context = opts?.context ?? 'none'
4601
+ if (!this._shapePageGeometryCaches[context]) {
4602
+ this._shapePageGeometryCaches[context] = this.store.createComputedCache(
4603
+ 'bounds',
4604
+ (shape) => {
4605
+ const geometry = this.getShapeGeometry(shape.id, opts)
4606
+ const pageTransform = this.getShapePageTransform(shape.id)
4607
+ return geometry.transform(pageTransform)
4608
+ },
4609
+ {
4610
+ // we only depend directly on the shape id, and changing geometry/transform will update us anyway
4611
+ areRecordsEqual: () => true,
4612
+ }
4613
+ )
4614
+ }
4615
+ return this._shapePageGeometryCaches[context].get(
4616
+ typeof shape === 'string' ? shape : shape.id
4617
+ )! as T
4618
+ }
4619
+
4320
4620
  /** @internal */
4321
4621
  @computed private _getShapeHandlesCache(): ComputedCache<TLHandle[] | undefined, TLShape> {
4322
4622
  return this.store.createComputedCache('handles', (shape) => {
@@ -4423,15 +4723,7 @@ export class Editor extends EventEmitter<TLEventMap> {
4423
4723
  /** @internal */
4424
4724
  @computed private _getShapePageBoundsCache(): ComputedCache<Box, TLShape> {
4425
4725
  return this.store.createComputedCache<Box, TLShape>('pageBoundsCache', (shape) => {
4426
- const pageTransform = this._getShapePageTransformCache().get(shape.id)
4427
-
4428
- if (!pageTransform) return new Box()
4429
-
4430
- const result = Box.FromPoints(
4431
- Mat.applyToPoints(pageTransform, this.getShapeGeometry(shape).vertices)
4432
- )
4433
-
4434
- return result
4726
+ return this.getShapePageGeometry(shape).bounds
4435
4727
  })
4436
4728
  }
4437
4729
 
@@ -4505,11 +4797,10 @@ export class Editor extends EventEmitter<TLEventMap> {
4505
4797
  if (frameAncestors.length === 0) return undefined
4506
4798
 
4507
4799
  const pageMask = frameAncestors
4508
- .map<Vec[] | undefined>((s) =>
4509
- // Apply the frame transform to the frame outline to get the frame outline in the current page space
4510
- this._getShapePageTransformCache()
4511
- .get(s.id)!
4512
- .applyToPoints(this.getShapeGeometry(s).vertices)
4800
+ .map<Vec[] | undefined>(
4801
+ (s) =>
4802
+ // Apply the frame transform to the frame outline to get the frame outline in the current page space
4803
+ this.getShapePageGeometry(s.id).vertices
4513
4804
  )
4514
4805
  .reduce((acc, b) => {
4515
4806
  if (!(b && acc)) return undefined
@@ -58,7 +58,7 @@ export class FocusManager {
58
58
 
59
59
  private handleKeyDown(keyEvent: KeyboardEvent) {
60
60
  const container = this.editor.getContainer()
61
- if (keyEvent.key === 'Tab') {
61
+ if (['Tab', 'ArrowUp', 'ArrowDown'].includes(keyEvent.key)) {
62
62
  container.classList.remove('tl-container__no-focus-ring')
63
63
  }
64
64
  }
@@ -193,6 +193,16 @@ export abstract class ShapeUtil<Shape extends TLUnknownShape = TLUnknownShape> {
193
193
  return true
194
194
  }
195
195
 
196
+ /**
197
+ * Whether the shape can be tabbed to.
198
+ *
199
+ * @param shape - The shape.
200
+ * @public
201
+ */
202
+ canTabTo(_shape: Shape): boolean {
203
+ return true
204
+ }
205
+
196
206
  /**
197
207
  * Whether the shape can be scrolled while editing.
198
208
  *
@@ -438,6 +448,10 @@ export abstract class ShapeUtil<Shape extends TLUnknownShape = TLUnknownShape> {
438
448
  return undefined
439
449
  }
440
450
 
451
+ getAriaDescriptor(_shape: Shape): string | undefined {
452
+ return undefined
453
+ }
454
+
441
455
  // Events
442
456
 
443
457
  /**
@@ -2,8 +2,6 @@ import { TLGroupShape, groupShapeMigrations, groupShapeProps } from '@tldraw/tls
2
2
  import { SVGContainer } from '../../../components/SVGContainer'
3
3
  import { Geometry2d } from '../../../primitives/geometry/Geometry2d'
4
4
  import { Group2d } from '../../../primitives/geometry/Group2d'
5
- import { Polygon2d } from '../../../primitives/geometry/Polygon2d'
6
- import { Polyline2d } from '../../../primitives/geometry/Polyline2d'
7
5
  import { Rectangle2d } from '../../../primitives/geometry/Rectangle2d'
8
6
  import { ShapeUtil } from '../ShapeUtil'
9
7
  import { DashedOutlineBox } from './DashedOutlineBox'
@@ -14,6 +12,10 @@ export class GroupShapeUtil extends ShapeUtil<TLGroupShape> {
14
12
  static override props = groupShapeProps
15
13
  static override migrations = groupShapeMigrations
16
14
 
15
+ override canTabTo() {
16
+ return false
17
+ }
18
+
17
19
  override hideSelectionBoundsFg() {
18
20
  return true
19
21
  }
@@ -35,19 +37,9 @@ export class GroupShapeUtil extends ShapeUtil<TLGroupShape> {
35
37
  return new Group2d({
36
38
  children: children.map((childId) => {
37
39
  const shape = this.editor.getShape(childId)!
38
- const geometry = this.editor.getShapeGeometry(childId)
39
- const points = this.editor.getShapeLocalTransform(shape)!.applyToPoints(geometry.vertices)
40
-
41
- if (geometry.isClosed) {
42
- return new Polygon2d({
43
- points,
44
- isFilled: true,
45
- })
46
- }
47
-
48
- return new Polyline2d({
49
- points,
50
- })
40
+ return this.editor
41
+ .getShapeGeometry(childId)
42
+ .transform(this.editor.getShapeLocalTransform(shape)!)
51
43
  }),
52
44
  })
53
45
  }
@@ -5,3 +5,6 @@ export type TLSelectionHandle = SelectionCorner | SelectionEdge | RotateCorner
5
5
 
6
6
  /** @public */
7
7
  export type TLResizeHandle = SelectionCorner | SelectionEdge
8
+
9
+ /** @public */
10
+ export type TLAdjacentDirection = 'next' | 'prev' | 'left' | 'right' | 'up' | 'down'