FrameShapeUtil • tldraw Docs

Table of contents

migrations
props
type
editor
options
Properties
Methods

Extends BaseBoxShapeUtil<TLFrameShape>.

class FrameShapeUtil extends BaseBoxShapeUtil<TLFrameShape> {}

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<TLFrameShape>

type

static

static type: 'frame'

editor

from ShapeUtil

editor: Editor

options

from ShapeUtil

Options for this shape util. If you're implementing a custom shape util, you can override this to provide customization options for your shape. If using an existing shape util, you can customizing this by calling ShapeUtil.configure.

options: {}

Methods

configure()

static

from ShapeUtil

Configure this shape utils options.

static configure<T extends TLShapeUtilConstructor<any, any>>(
  this: T,
  options: T extends new (...args: any[]) => {
    options: infer Options
  }
    ? Partial<Options>
    : never
): T

Parameters

Name	Description
`this`	`T`
`options`	`T extends new (...args: any[]) => { options: infer Options } ? Partial<Options> : never`

Returns

canBeLaidOut()

from ShapeUtil

Whether the shape can participate in layout functions such as alignment or distribution.

canBeLaidOut(_shape: Shape, _info: TLShapeUtilCanBeLaidOutOpts): boolean

Parameters

Name	Description
`_shape`	`Shape`
`_info`	`TLShapeUtilCanBeLaidOutOpts`

Returns

boolean

canBind()

from ShapeUtil

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

canBind(_opts: TLShapeUtilCanBindOpts): boolean

Parameters

Name	Description
`_opts`	`TLShapeUtilCanBindOpts`

Returns

boolean

canCrop()

from ShapeUtil

Whether the shape can be cropped.

canCrop(_shape: Shape): boolean

Parameters

Name	Description
`_shape`	`Shape`

Returns

boolean

canDropShapes()

canDropShapes(shape: TLFrameShape, _shapes: TLShape[]): boolean

Parameters

Name	Description
`shape`	`TLFrameShape`
`_shapes`	`TLShape[]`

Returns

boolean

canEdit()

canEdit(): 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()

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

Parameters

Name	Description
`shape`	`TLShape`
`_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: TLFrameShape): import('react/jsx-runtime').JSX.Element

Parameters

Name	Description
`shape`	`TLFrameShape`

Returns

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

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()

from ShapeUtil

Return elements to be added to the <defs> section of the canvases SVG context. This can be used to define SVG content (e.g. patterns & masks) that can be referred to by ID from svg elements returned by component.

Each def should have a unique key. If multiple defs from different shapes all have the same key, only one will be used.

getCanvasSvgDefs(): TLShapeUtilCanvasSvgDef[]

getDefaultProps()

getDefaultProps(): TLFrameShape['props']

getFontFaces()

from ShapeUtil

Get the font faces that should be rendered in the document in order for this shape to render correctly.

getFontFaces(shape: Shape): TLFontFace[]

Parameters

Name	Description
`shape`	`Shape` The shape.

Returns

TLFontFace[]

getGeometry()

getGeometry(shape: TLFrameShape): Geometry2d

Parameters

Name	Description
`shape`	`TLFrameShape`

Returns

Geometry2d

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 BaseBoxShapeUtil

getHandleSnapGeometry(shape: Shape): HandleSnapGeometry

Parameters

Name	Description
`shape`	`Shape`

Returns

HandleSnapGeometry

getInterpolatedProps()

getInterpolatedProps(
  startShape: TLFrameShape,
  endShape: TLFrameShape,
  t: number
): TLFrameShapeProps

Parameters

Name	Description
`startShape`	`TLFrameShape`
`endShape`	`TLFrameShape`
`t`	`number`

Returns

TLFrameShapeProps

getText()

getText(shape: TLFrameShape): string | undefined

Parameters

Name	Description
`shape`	`TLFrameShape`

Returns

string | undefined

hideResizeHandles()

from ShapeUtil

Whether the shape should hide its resize handles when selected.

hideResizeHandles(_shape: Shape): boolean

Parameters

Name	Description
`_shape`	`Shape`

Returns

boolean

hideRotateHandle()

from ShapeUtil

Whether the shape should hide its rotation handles when selected.

hideRotateHandle(_shape: Shape): boolean

Parameters

Name	Description
`_shape`	`Shape`

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()

from ShapeUtil

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

hideSelectionBoundsFg(_shape: Shape): boolean

Parameters

Name	Description
`_shape`	`Shape`

Returns

boolean

indicator()

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

Parameters

Name	Description
`shape`	`TLFrameShape`

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.

onCrop()

optional

from ShapeUtil

A callback called when a shape changes from a crop.

onCrop?(
  shape: Shape,
  info: TLCropInfo<Shape>
): Omit<TLShapePartial<Shape>, 'id' | 'type'> | undefined | void

Parameters

Name	Description
`shape`	`Shape` The shape at the start of the crop.
`info`	`TLCropInfo<Shape>` Info about the crop.

Returns

Omit<TLShapePartial<Shape>, 'id' | 'type'> | undefined | 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()

onDragShapesOut(_shape: TLFrameShape, shapes: TLShape[]): void

Parameters

Name	Description
`_shape`	`TLFrameShape`
`shapes`	`TLShape[]`

Returns

void

onDragShapesOver()

onDragShapesOver(frame: TLFrameShape, shapes: TLShape[]): void

Parameters

Name	Description
`frame`	`TLFrameShape`
`shapes`	`TLShape[]`

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: any, info: TLResizeInfo<any>): any

Parameters

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

Returns

any

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.

providesBackgroundForChildren()

providesBackgroundForChildren(): boolean

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: TLFrameShape,
  ctx: SvgExportContext
): import('react/jsx-runtime').JSX.Element

Parameters

Name	Description
`shape`	`TLFrameShape`
`ctx`	`SvgExportContext`

Returns

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