FrameShapeUtil

Extends BaseBoxShapeUtil<TLFrameShape>.

class FrameShapeUtil extends BaseBoxShapeUtil<TLFrameShape> {}

Constructs a new instance of the ShapeUtil class

Editor

Properties

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

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

static type: 'frame'

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

canBeLaidOut: TLShapeUtilFlag<Shape>

Whether the shape can be cropped.

canCrop: TLShapeUtilFlag<Shape>

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

canEdit: () => boolean

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

canEditInReadOnly: TLShapeUtilFlag<Shape>

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

Whether the shape can be resized.

canResize: TLShapeUtilFlag<Shape>

Whether the shape can be scrolled while editing.

canScroll: TLShapeUtilFlag<Shape>

Whether the shape can be snapped to by another shape.

canSnap: TLShapeUtilFlag<Shape>

editor: Editor

Whether the shape should hide its resize handles when selected.

hideResizeHandles: TLShapeUtilFlag<Shape>

Whether the shape should hide its rotation handles when selected.

hideRotateHandle: TLShapeUtilFlag<Shape>

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

hideSelectionBoundsBg: TLShapeUtilFlag<Shape>

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

hideSelectionBoundsFg: TLShapeUtilFlag<Shape>

Whether the shape's aspect ratio is locked.

isAspectRatioLocked: TLShapeUtilFlag<Shape>

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

onBeforeCreate?: TLOnBeforeCreateHandler<Shape>

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

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

onBeforeUpdate?: TLOnBeforeUpdateHandler<Shape>

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

A callback called when a shape's children change.

onChildrenChange?: TLOnChildrenChangeHandler<Shape>

A callback called when a shape is clicked.

onClick?: TLOnClickHandler<Shape>

A callback called when a shape is double clicked.

onDoubleClick?: TLOnDoubleClickHandler<Shape>

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

onDoubleClickEdge?: TLOnDoubleClickHandler<Shape>

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

onDoubleClickHandle?: TLOnDoubleClickHandleHandler<Shape>

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

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

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

onDropShapesOver?: TLOnDragHandler<Shape>

A callback called when a shape finishes being editing.

onEditEnd?: TLOnEditEndHandler<Shape>

A callback called when a shape's handle changes.

onHandleDrag?: TLOnHandleDragHandler<Shape>

onResize: TLOnResizeHandler<any>

A callback called when a shape finishes resizing.

onResizeEnd?: TLOnResizeEndHandler<Shape>

A callback called when a shape starts being resized.

onResizeStart?: TLOnResizeStartHandler<Shape>

A callback called when a shape changes from a rotation.

onRotate?: TLOnRotateHandler<Shape>

A callback called when a shape finishes rotating.

onRotateEnd?: TLOnRotateEndHandler<Shape>

A callback called when a shape starts being rotated.

onRotateStart?: TLOnRotateStartHandler<Shape>

A callback called when a shape changes from a translation.

onTranslate?: TLOnTranslateHandler<Shape>

A callback called when a shape finishes translating.

onTranslateEnd?: TLOnTranslateEndHandler<Shape>

A callback called when a shape starts being translated.

onTranslateStart?: TLOnTranslateStartHandler<Shape>

Methods

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

canBind(opts: TLShapeUtilCanBindOpts<Shape>): boolean

TLShapeUtilCanBindOpts<Shape>

boolean

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

canDropShapes(shape: Shape, shapes: TLShape[]): boolean

Shape

TLShape[]

boolean

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

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

Shape

TLShape['type']

boolean

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

TLFrameShape

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

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

getBoundsSnapGeometry(shape: Shape): BoundsSnapGeometry

Shape

BoundsSnapGeometry

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(): TLFrameShape['props']

getGeometry(shape: TLFrameShape): Geometry2d

TLFrameShape

Geometry2d

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

getHandles?(shape: Shape): TLHandle[]

util.getHandles?.(myShape)

Shape

TLHandle[]

getHandleSnapGeometry(shape: Shape): HandleSnapGeometry

Shape

HandleSnapGeometry

getInterpolatedProps(
  startShape: Shape,
  endShape: Shape,
  t: number
): Shape['props']

Shape

Shape

number

Shape['props']

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

TLFrameShape

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

providesBackgroundForChildren(): boolean

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

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

Shape

SvgExportContext

null | Promise<null | ReactElement> | ReactElement

An SVG element.

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

TLFrameShape

SvgExportContext

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