Skip to main content

@slack/types / PlanBlock

Interface: PlanBlock

Defined in: block-kit/blocks.ts:621

Description​

A collection of related tasks.

See​

https://docs.slack.dev/reference/block-kit/blocks/plan-block/

Extends​

Properties​

block_id?​

optional block_id?: string;

Defined in: block-kit/blocks.ts:50

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

tasks?​

optional tasks?: (TaskCardBlock | Record<string, unknown>)[];

Defined in: block-kit/blocks.ts:635

Description​

A sequence of task card blocks. Each task represents a single action within the plan.

title​

title: string;

Defined in: block-kit/blocks.ts:630

Description​

Title of the plan in plain text.

type​

type: "plan";

Defined in: block-kit/blocks.ts:625

Description​

The type of block. In this case type is always plan.

Overrides​

Block.type