Skip to main content

Interface: RichTextBlock

Description

Displays formatted, structured representation of text. It is also the output of the Slack client's WYSIWYG message composer, so all messages sent by end-users will have this format. Use this block to include user-defined formatted text in your Block Kit payload. While it is possible to format text with mrkdwn, rich_text is strongly preferred and allows greater flexibility. You might encounter a rich_text block in a message payload, as a built-in type in workflow apps, or as output of the RichTextInput.

See

Rich text block reference.

Extends

Properties

block_id?

optional block_id: string;

Description

A string acting as a unique identifier for a block. If not specified, a block_id will be generated. You can use this block_id when you receive an interaction payload to identify the source of the action. Maximum length for this field is 255 characters. block_id should be unique for each message and each iteration of a message. If a message is updated, use a new block_id.

Inherited from

Block.block_id

Defined in

block-kit/blocks.ts:39


elements

elements: RichTextBlockElement[];

Defined in

block-kit/blocks.ts:268


type

type: "rich_text";

Description

The type of block. For a rich text block, type is always rich_text.

Overrides

Block.type

Defined in

block-kit/blocks.ts:267