tldraw SDK

Table of contents

migrations
props
type
editor
Properties
Methods

Extends ShapeUtil<TLDrawShape>.

class DrawShapeUtil extends ShapeUtil<TLDrawShape> {}

Constructor

from ShapeUtil

Constructs a new instance of the ShapeUtil class

Parameters

Name	Description
`editor`	`Editor`

Properties

migrations

static

static migrations: import('@tldraw/editor').TLPropsMigrations

props

static

static props: import('@tldraw/editor').RecordProps<TLDrawShape>

type

static

static type: 'draw'

editor

from ShapeUtil

editor: Editor

Methods

canBeLaidOut()

from ShapeUtil

Whether the shape participates in stacking, aligning, and distributing.

canBeLaidOut(_shape: Shape): boolean

Parameters

Name	Description
`_shape`	`Shape`

Returns

boolean

canBind()

from ShapeUtil

Whether the shape can be bound to. See TLShapeUtilCanBindOpts for details.

canBind(_opts: TLShapeUtilCanBindOpts<Shape>): boolean

Parameters

Name	Description
`_opts`	`TLShapeUtilCanBindOpts<Shape>`

Returns

boolean

canCrop()

from ShapeUtil

Whether the shape can be cropped.

canCrop(_shape: Shape): boolean

Parameters

Name	Description
`_shape`	`Shape`

Returns

boolean

canDropShapes()

from ShapeUtil

Get whether the shape can receive children of a given type.

canDropShapes(_shape: Shape, _shapes: TLShape[]): boolean

Parameters

Name	Description
`_shape`	`Shape`
`_shapes`	`TLShape[]`

Returns

boolean

canEdit()

from ShapeUtil

Whether the shape can be double clicked to edit.

canEdit(_shape: Shape): boolean

Parameters

Name	Description
`_shape`	`Shape`

Returns

boolean

canEditInReadOnly()

from ShapeUtil

Whether the shape can be edited in read-only mode.

canEditInReadOnly(_shape: Shape): boolean

Parameters

Name	Description
`_shape`	`Shape`

Returns

boolean

canReceiveNewChildrenOfType()

from ShapeUtil

Get whether the shape can receive children of a given type.

canReceiveNewChildrenOfType(_shape: Shape, _type: TLShape['type']): boolean

Parameters

Name	Description
`_shape`	`Shape`
`_type`	`TLShape['type']`

Returns

boolean

canResize()

from ShapeUtil

Whether the shape can be resized.

canResize(_shape: Shape): boolean

Parameters

Name	Description
`_shape`	`Shape`

Returns

boolean

canScroll()

from ShapeUtil

Whether the shape can be scrolled while editing.

canScroll(_shape: Shape): boolean

Parameters

Name	Description
`_shape`	`Shape`

Returns

boolean

canSnap()

from ShapeUtil

Whether the shape can be snapped to by another shape.

canSnap(_shape: Shape): boolean

Parameters

Name	Description
`_shape`	`Shape`

Returns

boolean

component()

component(shape: TLDrawShape): import('react/jsx-runtime').JSX.Element

Parameters

Name	Description
`shape`	`TLDrawShape`

Returns

import('react/jsx-runtime').JSX.Element

expandSelectionOutlinePx()

expandSelectionOutlinePx(shape: TLDrawShape): number

Parameters

Name	Description
`shape`	`TLDrawShape`

Returns

number

getBoundsSnapGeometry()

from ShapeUtil

Get the geometry to use when snapping to this this shape in translate/resize operations. See BoundsSnapGeometry for details.

getBoundsSnapGeometry(_shape: Shape): BoundsSnapGeometry

Parameters

Name	Description
`_shape`	`Shape`

Returns

BoundsSnapGeometry

getCanvasSvgDefs()

getCanvasSvgDefs(): TLShapeUtilCanvasSvgDef[]

getDefaultProps()

getDefaultProps(): TLDrawShape['props']

getGeometry()

getGeometry(shape: TLDrawShape): Circle2d | Polyline2d

Parameters

Name	Description
`shape`	`TLDrawShape`

Returns

Circle2d | Polyline2d

getHandles()

optional

from ShapeUtil

Get an array of handle models for the shape. This is an optional method.

getHandles?(shape: Shape): TLHandle[]

Example

util.getHandles?.(myShape)

Parameters

Name	Description
`shape`	`Shape` The shape.

Returns

TLHandle[]

getHandleSnapGeometry()

from ShapeUtil

Get the geometry to use when snapping handles to this shape. See HandleSnapGeometry for details.

getHandleSnapGeometry(_shape: Shape): HandleSnapGeometry

Parameters

Name	Description
`_shape`	`Shape`

Returns

HandleSnapGeometry

getInterpolatedProps()

getInterpolatedProps(
  startShape: TLDrawShape,
  endShape: TLDrawShape,
  t: number
): TLDrawShapeProps

Parameters

Name	Description
`startShape`	`TLDrawShape`
`endShape`	`TLDrawShape`
`t`	`number`

Returns

TLDrawShapeProps

getText()

from ShapeUtil

getText(_shape: Shape): string | undefined

Parameters

Name	Description
`_shape`	`Shape`

Returns

string | undefined

hideResizeHandles()

hideResizeHandles(shape: TLDrawShape): boolean

Parameters

Name	Description
`shape`	`TLDrawShape`

Returns

boolean

hideRotateHandle()

hideRotateHandle(shape: TLDrawShape): boolean

Parameters

Name	Description
`shape`	`TLDrawShape`

Returns

boolean

hideSelectionBoundsBg()

from ShapeUtil

Whether the shape should hide its selection bounds background when selected.

hideSelectionBoundsBg(_shape: Shape): boolean

Parameters

Name	Description
`_shape`	`Shape`

Returns

boolean

hideSelectionBoundsFg()

hideSelectionBoundsFg(shape: TLDrawShape): boolean

Parameters

Name	Description
`shape`	`TLDrawShape`

Returns

boolean

indicator()

indicator(shape: TLDrawShape): import('react/jsx-runtime').JSX.Element

Parameters

Name	Description
`shape`	`TLDrawShape`

Returns

import('react/jsx-runtime').JSX.Element

isAspectRatioLocked()

from ShapeUtil

Whether the shape's aspect ratio is locked.

isAspectRatioLocked(_shape: Shape): boolean

Parameters

Name	Description
`_shape`	`Shape`

Returns

boolean

onBeforeCreate()

optional

from ShapeUtil

A callback called just before a shape is created. This method provides a last chance to modify the created shape.

onBeforeCreate?(next: Shape): Shape | void

Example

onBeforeCreate = (next) => {
  return { ...next, x: next.x + 1 }
}

Parameters

Name	Description
`next`	`Shape` The next shape.

Returns

Shape | void

The next shape or void.

onBeforeUpdate()

optional

from ShapeUtil

A callback called just before a shape is updated. This method provides a last chance to modify the updated shape.

onBeforeUpdate?(prev: Shape, next: Shape): Shape | void

Example

onBeforeUpdate = (prev, next) => {
  if (prev.x === next.x) {
    return { ...next, x: next.x + 1 }
  }
}

Parameters

Name	Description
`prev`	`Shape` The previous shape.
`next`	`Shape` The next shape.

Returns

Shape | void

The next shape or void.

onChildrenChange()

optional

from ShapeUtil

A callback called when a shape's children change.

onChildrenChange?(shape: Shape): TLShapePartial[] | void

Parameters

Name	Description
`shape`	`Shape` The shape.

Returns

TLShapePartial[] | void

An array of shape updates, or void.

onClick()

optional

from ShapeUtil

A callback called when a shape is clicked.

onClick?(shape: Shape): TLShapePartial<Shape> | void

Parameters

Name	Description
`shape`	`Shape` The shape.

Returns

TLShapePartial<Shape> | void

A change to apply to the shape, or void.

onDoubleClick()

optional

from ShapeUtil

A callback called when a shape is double clicked.

onDoubleClick?(shape: Shape): TLShapePartial<Shape> | void

Parameters

Name	Description
`shape`	`Shape` The shape.

Returns

TLShapePartial<Shape> | void

A change to apply to the shape, or void.

onDoubleClickEdge()

optional

from ShapeUtil

A callback called when a shape's edge is double clicked.

onDoubleClickEdge?(shape: Shape): TLShapePartial<Shape> | void

Parameters

Name	Description
`shape`	`Shape` The shape.

Returns

TLShapePartial<Shape> | void

A change to apply to the shape, or void.

onDoubleClickHandle()

optional

from ShapeUtil

A callback called when a shape's handle is double clicked.

onDoubleClickHandle?(
  shape: Shape,
  handle: TLHandle
): TLShapePartial<Shape> | void

Parameters

Name	Description
`shape`	`Shape` The shape.
`handle`	`TLHandle` The handle that is double-clicked.

Returns

TLShapePartial<Shape> | void

A change to apply to the shape, or void.

onDragShapesOut()

optional

from ShapeUtil

A callback called when some other shapes are dragged out of this one.

onDragShapesOut?(shape: Shape, shapes: TLShape[]): void

Parameters

Name	Description
`shape`	`Shape` The shape.
`shapes`	`TLShape[]` The shapes that are being dragged out.

Returns

void

onDragShapesOver()

optional

from ShapeUtil

A callback called when some other shapes are dragged over this one.

onDragShapesOver?(shape: Shape, shapes: TLShape[]): void

Example

onDragShapesOver = (shape, shapes) => {
  this.editor.reparentShapes(shapes, shape.id)
}

Parameters

Name	Description
`shape`	`Shape` The shape.
`shapes`	`TLShape[]` The shapes that are being dragged over this one.

Returns

void

onDropShapesOver()

optional

from ShapeUtil

A callback called when some other shapes are dropped over this one.

onDropShapesOver?(shape: Shape, shapes: TLShape[]): void

Parameters

Name	Description
`shape`	`Shape` The shape.
`shapes`	`TLShape[]` The shapes that are being dropped over this one.

Returns

void

onEditEnd()

optional

from ShapeUtil

A callback called when a shape finishes being editing.

onEditEnd?(shape: Shape): void

Parameters

Name	Description
`shape`	`Shape` The shape.

Returns

void

onHandleDrag()

optional

from ShapeUtil

A callback called when a shape's handle changes.

onHandleDrag?(
  shape: Shape,
  info: TLHandleDragInfo<Shape>
): TLShapePartial<Shape> | void

Parameters

Name	Description
`shape`	`Shape` The current shape.
`info`	`TLHandleDragInfo<Shape>` An object containing the handle and whether the handle is 'precise' or not.

Returns

TLShapePartial<Shape> | void

A change to apply to the shape, or void.

onResize()

onResize(
  shape: TLDrawShape,
  info: TLResizeInfo<TLDrawShape>
): {
  props: {
    segments: TLDrawShapeSegment[]
  }
}

Parameters

Name	Description
`shape`	`TLDrawShape`
`info`	`TLResizeInfo<TLDrawShape>`

Returns

{
  props: {
    segments: TLDrawShapeSegment[]
  }
}

onResizeEnd()

optional

from ShapeUtil

A callback called when a shape finishes resizing.

onResizeEnd?(initial: Shape, current: Shape): TLShapePartial<Shape> | void

Parameters

Name	Description
`initial`	`Shape` The shape at the start of the resize.
`current`	`Shape` The current shape.

Returns

TLShapePartial<Shape> | void

A change to apply to the shape, or void.

onResizeStart()

optional

from ShapeUtil

A callback called when a shape starts being resized.

onResizeStart?(shape: Shape): TLShapePartial<Shape> | void

Parameters

Name	Description
`shape`	`Shape` The shape.

Returns

TLShapePartial<Shape> | void

A change to apply to the shape, or void.

onRotate()

optional

from ShapeUtil

A callback called when a shape changes from a rotation.

onRotate?(initial: Shape, current: Shape): TLShapePartial<Shape> | void

Parameters

Name	Description
`initial`	`Shape` The shape at the start of the rotation.
`current`	`Shape` The current shape.

Returns

TLShapePartial<Shape> | void

A change to apply to the shape, or void.

onRotateEnd()

optional

from ShapeUtil

A callback called when a shape finishes rotating.

onRotateEnd?(initial: Shape, current: Shape): TLShapePartial<Shape> | void

Parameters

Name	Description
`initial`	`Shape` The shape at the start of the rotation.
`current`	`Shape` The current shape.

Returns

TLShapePartial<Shape> | void

A change to apply to the shape, or void.

onRotateStart()

optional

from ShapeUtil

A callback called when a shape starts being rotated.

onRotateStart?(shape: Shape): TLShapePartial<Shape> | void

Parameters

Name	Description
`shape`	`Shape` The shape.

Returns

TLShapePartial<Shape> | void

A change to apply to the shape, or void.

onTranslate()

optional

from ShapeUtil

A callback called when a shape changes from a translation.

onTranslate?(initial: Shape, current: Shape): TLShapePartial<Shape> | void

Parameters

Name	Description
`initial`	`Shape` The shape at the start of the translation.
`current`	`Shape` The current shape.

Returns

TLShapePartial<Shape> | void

A change to apply to the shape, or void.

onTranslateEnd()

optional

from ShapeUtil

A callback called when a shape finishes translating.

onTranslateEnd?(initial: Shape, current: Shape): TLShapePartial<Shape> | void

Parameters

Name	Description
`initial`	`Shape` The shape at the start of the translation.
`current`	`Shape` The current shape.

Returns

TLShapePartial<Shape> | void

A change to apply to the shape, or void.

onTranslateStart()

optional

from ShapeUtil

A callback called when a shape starts being translated.

onTranslateStart?(shape: Shape): TLShapePartial<Shape> | void

Parameters

Name	Description
`shape`	`Shape` The shape.

Returns

TLShapePartial<Shape> | void

A change to apply to the shape, or void.

toBackgroundSvg()

optional

from ShapeUtil

Get the shape's background layer as an SVG object.

toBackgroundSvg?(
  shape: Shape,
  ctx: SvgExportContext
): null | Promise<null | ReactElement> | ReactElement

Parameters

Name	Description
`shape`	`Shape` The shape.
`ctx`	`SvgExportContext` ctx - The export context for the SVG - used for adding e.g. <def>s

Returns

null | Promise<null | ReactElement> | ReactElement

An SVG element.

toSvg()

toSvg(
  shape: TLDrawShape,
  ctx: SvgExportContext
): import('react/jsx-runtime').JSX.Element

Parameters

Name	Description
`shape`	`TLDrawShape`
`ctx`	`SvgExportContext`

Returns

import('react/jsx-runtime').JSX.Element