Skip to main content

TextBlock

Overview​

TextBlock represents a block of text content that can include additional formatting and layout options. It is commonly used for adding textual information to pages or components.

Attributes​

id​

type: string

A unique identifier for the text block.

type​

type: literal = 'text'

Discriminant for this block type.

text​

type: string (optional)

The main text content displayed in the block.

format​

type: literal = 'markdown' | 'html' (optional)

Specifies the format of the text content.

paddingTop​

type: PaddingOptions (optional)

Specifies the top padding for the text block.

paddingBottom​

type: PaddingOptions (optional)

Specifies the bottom padding for the text block.

backgroundColor​

type: string (optional)

Defines the background color of the text block.

textColor​

type: string (optional)

Defines the text color for the content in the block.

fullBleed​

type: boolean (optional)

Indicates whether the text block spans the full width of its container.

headerTextPosition​

type: TextAlignment (optional)

Defines the alignment of the header text.

headerPadding​

type: PaddingOptions (optional)

Specifies the padding for the header.

bodyTextPosition​

type: TextAlignment (optional)

Defines the alignment of the body text.

headerText​

type: string (optional)

The header text displayed above the main content.