Skip to content
Block Kit for React
Esc
↑↓navigate↵open⌘Jpreview
On this page

Plan block

A collapsible, step-by-step agent plan, with a status per task.

plan groups a sequence of tasks under one shared goal, each with its own status. It’s a Slack block documented for agent surfaces, newer than the version of @slack/types this library depends on, so its TypeScript type is the field reference here. It’s read-only: expanding a plan doesn’t emit an action.

Your AppAPP

Click the pill to expand the plan and see each task’s details, output, and sources.

Statuses show as icons, so screen readers hear them as text after each title instead: “complete”, “in progress”, “pending” or “failed” (for error), on the pill and on every task. A task’s title is a button only when the task has something to show; a task with no details, output or sources is plain text, not a disabled button. As in Slack, each expanded task is a list item the keyboard can focus, so Tab steps through a long plan task by task, with the focus ring around the whole task. The pill that opens the plan shows Slack’s button focus ring (--sbk-focus-ring) with keyboard focus.

Fields

PropType
typestring

Always plan.

Typestring
titlestring

The plan's shared goal, shown in the collapsed pill.

Typestring
tasks?PlanTask[]

The steps, in order. An invalid or missing value renders an empty plan.

TypePlanTask[]

PlanTask

A plan’s tasks share the same shape as a standalone task card:

PropType
task_idstring

Identifies the task.

Typestring
titlestring

The task's one-line summary.

Typestring
status"pending" | "in_progress" | "complete" | "error"

The task's state. On the timeline, in_progress shows a blue spinner, error a red warning, and complete and pending a grey dot, lighter while pending.

Type"pending" | "in_progress" | "complete" | "error"
details?RichTextBlock

What the task is doing, shown when the plan is expanded.

TypeRichTextBlock
output?RichTextBlock

The task's result, shown below details.

TypeRichTextBlock
sources?{ type: "url"; url: string; text?: string }[]

Links shown under the task. text defaults to the raw URL.

Type{ type: "url"; url: string; text?: string }[]

The plan’s own collapsed pill shows one status for the whole plan: in progress (a spinner) while any task is still pending or in progress, then failed (a warning) if any task’s status is error, else complete (a check).

Examples

Every task status

The preview above covers complete, in_progress, and pending in one plan, plus optional details, output, and sources on the first two tasks. All three fields are safe to omit, as the third task shows.

Last updated on