@tldraw/editor 3.11.0-canary.271f68c07747 → 3.11.0-canary.3758de89732a

package/dist-esm/version.mjs

@@ -1,8 +1,8 @@
-const version = "3.11.0-canary.271f68c07747";
+const version = "3.11.0-canary.3758de89732a";
 const publishDates = {
   major: "2024-09-13T14:36:29.063Z",
-  minor: "2025-03-14T09:49:25.689Z",
-  patch: "2025-03-14T09:49:25.689Z"
+  minor: "2025-03-15T13:28:31.594Z",
+  patch: "2025-03-15T13:28:31.594Z"
 };
 export {
   publishDates,

package/dist-esm/version.mjs.map

@@ -1,7 +1,7 @@
 {
   "version": 3,
   "sources": ["../src/version.ts"],
-  "sourcesContent": ["// This file is automatically generated by internal/scripts/refresh-assets.ts.\n// Do not edit manually. Or do, I'm a comment, not a cop.\n\nexport const version = '3.11.0-canary.271f68c07747'\nexport const publishDates = {\n\tmajor: '2024-09-13T14:36:29.063Z',\n\tminor: '2025-03-14T09:49:25.689Z',\n\tpatch: '2025-03-14T09:49:25.689Z',\n}\n"],
+  "sourcesContent": ["// This file is automatically generated by internal/scripts/refresh-assets.ts.\n// Do not edit manually. Or do, I'm a comment, not a cop.\n\nexport const version = '3.11.0-canary.3758de89732a'\nexport const publishDates = {\n\tmajor: '2024-09-13T14:36:29.063Z',\n\tminor: '2025-03-15T13:28:31.594Z',\n\tpatch: '2025-03-15T13:28:31.594Z',\n}\n"],
   "mappings": "AAGO,MAAM,UAAU;AAChB,MAAM,eAAe;AAAA,EAC3B,OAAO;AAAA,EACP,OAAO;AAAA,EACP,OAAO;AACR;",
   "names": []
 }

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@tldraw/editor",
   "description": "A tiny little drawing app (editor).",
-  "version": "3.11.0-canary.271f68c07747",
+  "version": "3.11.0-canary.3758de89732a",
   "author": {
     "name": "tldraw Inc.",
     "email": "hello@tldraw.com"
@@ -48,12 +48,12 @@
     "@tiptap/core": "^2.9.1",
     "@tiptap/pm": "^2.9.1",
     "@tiptap/react": "^2.9.1",
-    "@tldraw/state": "3.11.0-canary.271f68c07747",
-    "@tldraw/state-react": "3.11.0-canary.271f68c07747",
-    "@tldraw/store": "3.11.0-canary.271f68c07747",
-    "@tldraw/tlschema": "3.11.0-canary.271f68c07747",
-    "@tldraw/utils": "3.11.0-canary.271f68c07747",
-    "@tldraw/validate": "3.11.0-canary.271f68c07747",
+    "@tldraw/state": "3.11.0-canary.3758de89732a",
+    "@tldraw/state-react": "3.11.0-canary.3758de89732a",
+    "@tldraw/store": "3.11.0-canary.3758de89732a",
+    "@tldraw/tlschema": "3.11.0-canary.3758de89732a",
+    "@tldraw/utils": "3.11.0-canary.3758de89732a",
+    "@tldraw/validate": "3.11.0-canary.3758de89732a",
     "@types/core-js": "^2.5.8",
     "@use-gesture/react": "^10.3.1",
     "classnames": "^2.5.1",

package/src/index.ts

@@ -109,7 +109,10 @@ export {
 	type TLShapeIndicatorProps,
 } from './lib/components/default-components/DefaultShapeIndicator'
 export { type TLShapeIndicatorErrorFallbackComponent } from './lib/components/default-components/DefaultShapeIndicatorErrorFallback'
-export { DefaultShapeIndicators } from './lib/components/default-components/DefaultShapeIndicators'
+export {
+	DefaultShapeIndicators,
+	type TLShapeIndicatorsProps,
+} from './lib/components/default-components/DefaultShapeIndicators'
 export {
 	DefaultSnapIndicator,
 	type TLSnapIndicatorProps,

package/src/lib/components/default-components/DefaultShapeIndicator.tsx

@@ -9,15 +9,15 @@ import { useEditorComponents } from '../../hooks/useEditorComponents'
 import { OptionalErrorBoundary } from '../ErrorBoundary'
 
 // need an extra layer of indirection here to allow hooks to be used inside the indicator render
-const EvenInnererIndicator = ({ shape, util }: { shape: TLShape; util: ShapeUtil<any> }) => {
+const EvenInnererIndicator = memo(({ shape, util }: { shape: TLShape; util: ShapeUtil<any> }) => {
 	return useStateTracking('Indicator: ' + shape.type, () =>
 		// always fetch the latest shape from the store even if the props/meta have not changed, to avoid
 		// calling the render method with stale data.
 		util.indicator(util.editor.store.unsafeGetWithoutCapture(shape.id) as TLShape)
 	)
-}
+})
 
-const InnerIndicator = ({ editor, id }: { editor: Editor; id: TLShapeId }) => {
+const InnerIndicator = memo(({ editor, id }: { editor: Editor; id: TLShapeId }) => {
 	const shape = useValue('shape for indicator', () => editor.store.get(id), [editor, id])
 
 	const { ShapeIndicatorErrorFallback } = useEditorComponents()
@@ -34,7 +34,7 @@ const InnerIndicator = ({ editor, id }: { editor: Editor; id: TLShapeId }) => {
 			<EvenInnererIndicator key={shape.id} shape={shape} util={editor.getShapeUtil(shape)} />
 		</OptionalErrorBoundary>
 	)
-}
+})
 
 /** @public */
 export interface TLShapeIndicatorProps {

package/src/lib/components/default-components/DefaultShapeIndicators.tsx

@@ -4,10 +4,24 @@ import { memo, useRef } from 'react'
 import { useEditor } from '../../hooks/useEditor'
 import { useEditorComponents } from '../../hooks/useEditorComponents'
 
+/** @public */
+export interface TLShapeIndicatorsProps {
+	/** Whether to hide all of the indicators */
+	hideAll?: boolean
+	/** Whether to show all of the indicators */
+	showAll?: boolean
+}
+
 /** @public @react */
-export const DefaultShapeIndicators = memo(function DefaultShapeIndicators() {
+export const DefaultShapeIndicators = memo(function DefaultShapeIndicators({
+	hideAll,
+	showAll,
+}: TLShapeIndicatorsProps) {
 	const editor = useEditor()
 
+	if (hideAll && showAll)
+		throw Error('You cannot set both hideAll and showAll props to true, cmon now')
+
 	const rPreviousSelectedShapeIds = useRef<Set<TLShapeId>>(new Set())
 
 	const idsToDisplay = useValue(
@@ -16,33 +30,38 @@ export const DefaultShapeIndicators = memo(function DefaultShapeIndicators() {
 			const prev = rPreviousSelectedShapeIds.current
 			const next = new Set<TLShapeId>()
 
-			if (
-				// We only show indicators when in the following states...
-				editor.isInAny(
-					'select.idle',
-					'select.brushing',
-					'select.scribble_brushing',
-					'select.editing_shape',
-					'select.pointing_shape',
-					'select.pointing_selection',
-					'select.pointing_handle'
-				) &&
-				// ...but we hide indicators when we've just changed a style (so that the user can see the change)
-				!editor.getInstanceState().isChangingStyle
-			) {
-				// We always want to show indicators for the selected shapes, if any
-				const selected = editor.getSelectedShapeIds()
-				for (const id of selected) {
-					next.add(id)
-				}
+			const isChangingStyle = editor.getInstanceState().isChangingStyle
+
+			// todo: this is tldraw specific and is duplicated at the tldraw layer. What should we do here instead?
+			const isInSelectState = editor.isInAny(
+				'select.idle',
+				'select.brushing',
+				'select.scribble_brushing',
+				'select.editing_shape',
+				'select.pointing_shape',
+				'select.pointing_selection',
+				'select.pointing_handle'
+			)
+
+			// We hide all indicators if we're changing style or in certain interactions
+			// todo: move this to some kind of Tool.hideIndicators property
+			if (isChangingStyle || !isInSelectState) {
+				rPreviousSelectedShapeIds.current = next
+				return next
+			}
+
+			// We always want to show indicators for the selected shapes, if any
+			const selected = editor.getSelectedShapeIds()
+			for (const id of selected) {
+				next.add(id)
+			}
 
-				// If we're idle or editing a shape, we want to also show an indicator for the hovered shape, if any
-				if (editor.isInAny('select.idle', 'select.editing_shape')) {
-					const instanceState = editor.getInstanceState()
-					if (instanceState.isHoveringCanvas && !instanceState.isCoarsePointer) {
-						const hovered = editor.getHoveredShapeId()
-						if (hovered) next.add(hovered)
-					}
+			// If we're idle or editing a shape, we want to also show an indicator for the hovered shape, if any
+			if (editor.isInAny('select.idle', 'select.editing_shape')) {
+				const instanceState = editor.getInstanceState()
+				if (instanceState.isHoveringCanvas && !instanceState.isCoarsePointer) {
+					const hovered = editor.getHoveredShapeId()
+					if (hovered) next.add(hovered)
 				}
 			}
 
@@ -75,6 +94,10 @@ export const DefaultShapeIndicators = memo(function DefaultShapeIndicators() {
 	if (!ShapeIndicator) return null
 
 	return renderingShapes.map(({ id }) => (
-		<ShapeIndicator key={id + '_indicator'} shapeId={id} hidden={!idsToDisplay.has(id)} />
+		<ShapeIndicator
+			key={id + '_indicator'}
+			shapeId={id}
+			hidden={!showAll && (hideAll || !idsToDisplay.has(id))}
+		/>
 	))
 })

package/src/lib/editor/Editor.ts

@@ -6328,21 +6328,22 @@ export class Editor extends EventEmitter<TLEventMap> {
 	 *
 	 * @example
 	 * ```ts
-	 * editor.stackShapes([box1, box2], 'horizontal', 32)
-	 * editor.stackShapes(editor.getSelectedShapeIds(), 'horizontal', 32)
+	 * editor.stackShapes([box1, box2], 'horizontal')
+	 * editor.stackShapes(editor.getSelectedShapeIds(), 'horizontal')
 	 * ```
 	 *
 	 * @param shapes - The shapes (or shape ids) to stack.
 	 * @param operation - Whether to stack horizontally or vertically.
-	 * @param gap - The gap to leave between shapes.
+	 * @param gap - The gap to leave between shapes. By default, uses the editor's `adjacentShapeMargin` option.
 	 *
 	 * @public
 	 */
 	stackShapes(
 		shapes: TLShapeId[] | TLShape[],
 		operation: 'horizontal' | 'vertical',
-		gap: number
+		gap?: number
 	): this {
+		const _gap = gap ?? this.options.adjacentShapeMargin
 		const ids =
 			typeof shapes[0] === 'string'
 				? (shapes as TLShapeId[])
@@ -6400,7 +6401,7 @@ export class Editor extends EventEmitter<TLEventMap> {
 		}
 
 		const len = shapeClustersToStack.length
-		if ((gap === 0 && len < 3) || len < 2) return this
+		if ((_gap === 0 && len < 3) || len < 2) return this
 
 		let val: 'x' | 'y'
 		let min: 'minX' | 'minY'
@@ -6421,7 +6422,7 @@ export class Editor extends EventEmitter<TLEventMap> {
 
 		let shapeGap: number = 0
 
-		if (gap === 0) {
+		if (_gap === 0) {
 			// note: this is not used in the current tldraw.com; there we use a specified stack
 
 			const gaps: Record<number, number> = {}
@@ -6461,7 +6462,7 @@ export class Editor extends EventEmitter<TLEventMap> {
 			}
 		} else {
 			// If a gap was provided, then use that instead.
-			shapeGap = gap
+			shapeGap = _gap
 		}
 
 		const changes: TLShapePartial[] = []
@@ -6500,17 +6501,19 @@ export class Editor extends EventEmitter<TLEventMap> {
 	 *
 	 * @example
 	 * ```ts
-	 * editor.packShapes([box1, box2], 32)
+	 * editor.packShapes([box1, box2])
 	 * editor.packShapes(editor.getSelectedShapeIds(), 32)
 	 * ```
 	 *
 	 *
 	 * @param shapes - The shapes (or shape ids) to pack.
-	 * @param gap - The padding to apply to the packed shapes. Defaults to 16.
+	 * @param gap - The padding to apply to the packed shapes. Defaults to the editor's `adjacentShapeMargin` option.
 	 */
-	packShapes(shapes: TLShapeId[] | TLShape[], gap: number): this {
+	packShapes(shapes: TLShapeId[] | TLShape[], _gap?: number): this {
 		if (this.getIsReadonly()) return this
 
+		const gap = _gap ?? this.options.adjacentShapeMargin
+
 		const ids =
 			typeof shapes[0] === 'string'
 				? (shapes as TLShapeId[])

package/src/version.ts

@@ -1,9 +1,9 @@
 // This file is automatically generated by internal/scripts/refresh-assets.ts.
 // Do not edit manually. Or do, I'm a comment, not a cop.
 
-export const version = '3.11.0-canary.271f68c07747'
+export const version = '3.11.0-canary.3758de89732a'
 export const publishDates = {
 	major: '2024-09-13T14:36:29.063Z',
-	minor: '2025-03-14T09:49:25.689Z',
-	patch: '2025-03-14T09:49:25.689Z',
+	minor: '2025-03-15T13:28:31.594Z',
+	patch: '2025-03-15T13:28:31.594Z',
 }