TLNoteShapeProps

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

Horizontal alignment of text within the note

align: TLDefaultHorizontalAlignStyle;

Background color style of the note

color: TLDefaultColorStyle;

Font family style for the note text

font: TLDefaultFontStyle;

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

fontSizeAdjustment: number;

Additional height growth for the note beyond its base size

growY: number;

Text color style for the note content

labelColor: TLDefaultColorStyle;

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

richText: TLRichText;

Scale factor applied to the note shape for display

scale: number;

Size style determining the font size and note dimensions

size: TLDefaultSizeStyle;

User ID of the person who first edited the note text

textFirstEditedBy: null | string;

Optional URL associated with the note for linking

url: string;

Vertical alignment of text within the note

verticalAlign: TLDefaultVerticalAlignStyle;