@mocanvas/mocanvas · interface

NoteShapeProps

interface NoteShapeProps

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


Properties · 13

align: DefaultHorizontalAlignStyle
color: DefaultColorStyle
font: DefaultFontStyle
fontSizeAdjustment: number
growY: number
labelColor: DefaultColorStyle
richText: RichText

The label as a rich-text document — the v5 spelling, and the one the store keeps. NoteShapeProps.text stays alongside it as the flattened form, derived on load, so plain-text consumers need no conversion.

scale: number
size: DefaultSizeStyle
text?: string

The label as plain text.

Optional, and *derived*: v5 replaced it with NoteShapeProps.richText, and a record written by a v5 client has no text at all. mocanvas keeps deriving it on load, because a plain-text consumer (search, export, an agent reading the board) should not have to walk a document — but nothing may require it to be present, and readRichText is what reconciles the two when they disagree.

textFirstEditedBy?: string | null | undefined

Who first edited the label by hand, or null while nobody has.

The seam attribution hangs off: a note whose text is still exactly what a generator wrote can be regenerated freely, and one a person has touched cannot. mocanvas stores and round-trips it; it never writes it itself, because only the host knows who "a person" is.

url: string
verticalAlign: DefaultVerticalAlignStyle

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.