mocanvasv4.11.2

FrameShapeUtil

declare class FrameShapeUtil extends BaseFrameLikeShapeUtil<FrameShape>

This one ships without a description. The signature above is read from the package, and the guides cover the area it belongs to.

On this page

canEdit component getDefaultProps getFontFaces getGeometry getIndicatorPath getRenderStyle getText hasOverlayLabel needsOverlay onEditEnd migrations options options props type

Methods · 11

canEdit(_shape: FrameShape): boolean

component(shape: FrameShape): ReactNode

getDefaultProps(): FrameShapeProps

getFontFaces(_shape: FrameShape): TLFontFace[]

A frame draws its name in the sans family, whatever its children use.

getGeometry(shape: FrameShape): Geometry2d

getIndicatorPath(shape: FrameShape): Path2D

getRenderStyle(_shape: FrameShape): StyleWords

getText(shape: FrameShape): string

hasOverlayLabel(_shape: FrameShape): boolean

needsOverlay(_shape: FrameShape): boolean

The GPU draws the frame body while its name is edited.

onEditEnd(shape: FrameShape): void

Properties · 5

static migrations: _mocanvas_editor.PropsMigrations

static options: FrameShapeOptions

readonly options: FrameShapeOptions

static props: _mocanvas_editor.RecordProps<FrameShape>

static type: "frame"

All of @mocanvas/mocanvas Guides Demos

mocanvas

Docs Licensing mocanvas@symbio.agency

mocanvas is built by Symbio. Free for non-commercial, non-profit and development use; commercial use needs an agreement. Not affiliated with or endorsed by tldraw.