TLNoteShapeProps

See source code
Table of contents

Properties for a note shape. Note shapes represent sticky notes or text annotations with rich formatting capabilities and various styling options.

interface TLNoteShapeProps {}

Example

const noteProps: TLNoteShapeProps = {
  color: 'yellow',
  labelColor: 'black',
  size: 'm',
  font: 'draw',
  fontSizeAdjustment: 0,
  align: 'middle',
  verticalAlign: 'middle',
  growY: 0,
  url: '',
  richText: toRichText('Hello **world**!'),
  scale: 1,
}

Properties

align

Horizontal alignment of text within the note


color

Background color style of the note


font

Font family style for the note text


fontSizeAdjustment

Adjustment to the base font size (positive increases, negative decreases)

fontSizeAdjustment: number

growY

Additional height growth for the note beyond its base size

growY: number

labelColor

Text color style for the note content

labelColor: TLDefaultColorStyle

richText

Rich text content with formatting like bold, italic, etc.

richText: TLRichText

scale

Scale factor applied to the note shape for display

scale: number

size

Size style determining the font size and note dimensions


url

Optional URL associated with the note for linking

url: string

verticalAlign

Vertical alignment of text within the note

verticalAlign: TLDefaultVerticalAlignStyle

Prev
TLLineShapeProps
Next
TLPage