Skip to main content

Interface: HeaderBlock

Description

Displays a larger-sized text block. A header is a plain-text block that displays in a larger, bold font. Use it to delineate between different groups of content in your app's surfaces.

See

Header 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


text

text: PlainTextElement;

Description

The text for the block, in the form of a PlainTextElement. Maximum length for the text in this field is 150 characters.

Defined in

block-kit/blocks.ts:167


type

type: "header";

Description

The type of block. For a header block, type is always header.

Overrides

Block.type

Defined in

block-kit/blocks.ts:162