Skip to content

docs(types): align Alert, Card, Carousel block descriptions with official docs #2578

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
srtaalej merged 1 commit into from
May 5, 2026
+8 −4
Merged

docs(types): align Alert, Card, Carousel block descriptions with official docs #2578

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
5 changes: 5 additions & 0 deletions .changeset/fix-block-descriptions.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,5 @@
---
'@slack/types': patch
---

Align Alert, Card, and Carousel block type descriptions with official documentation
7 changes: 3 additions & 4 deletions packages/types/src/block-kit/blocks.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -113,7 +113,7 @@ export interface ActionsBlock extends Block {
}

/**
* @description A prominent notice block for displaying warnings, status updates, or other important information.
* @description Displays alerts, warnings, and informational messages.
* @see {@link https://docs.slack.dev/reference/block-kit/blocks/alert-block Alert block reference}.
*/
export interface AlertBlock extends Block {
Expand All @@ -132,8 +132,7 @@ export interface AlertBlock extends Block {
}

/**
* @description A rich display block for presenting structured content such as recommendations, results, or work items.
* At least one of `hero_image`, `title`, `actions`, or `body` must be provided.
* @description Displays content in a card. At least one of `hero_image`, `title`, `actions`, or `body` must be provided.
* @see {@link https://docs.slack.dev/reference/block-kit/blocks/card-block Card block reference}.
*/
export interface CardBlock extends Block {
Expand Down Expand Up @@ -171,7 +170,7 @@ export interface CardBlock extends Block {
}

/**
* @description A horizontally scrollable collection of {@link CardBlock} elements.
* @description Displays related card blocks in a horizontally-scrolling container.
* @see {@link https://docs.slack.dev/reference/block-kit/blocks/carousel-block Carousel block reference}.
*/
export interface CarouselBlock extends Block {
Expand Down
Loading