Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
7 changes: 0 additions & 7 deletions .changeset/deep-hands-peel.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/new-block-kit-elements.md

This file was deleted.

5 changes: 0 additions & 5 deletions .changeset/rare-boats-brake.md

This file was deleted.

4 changes: 0 additions & 4 deletions .changeset/simple-tests-shine.md

This file was deleted.

2 changes: 1 addition & 1 deletion docs/english/reference/cli-test/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @slack/cli-test v3.0.0
# @slack/cli-test v3.0.1

## Classes

Expand Down
5 changes: 4 additions & 1 deletion docs/english/reference/types/index.md
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
# @slack/types v2.20.1
# @slack/types v2.21.0

## Enumerations

Expand All @@ -10,6 +10,7 @@
- [~~Action~~](interfaces/Action.md)
- [~~Actionable~~](interfaces/Actionable.md)
- [ActionsBlock](interfaces/ActionsBlock.md)
- [AlertBlock](interfaces/AlertBlock.md)
- [AppDeletedEvent](interfaces/AppDeletedEvent.md)
- [AppHomeOpenedEvent](interfaces/AppHomeOpenedEvent.md)
- [AppInstalledEvent](interfaces/AppInstalledEvent.md)
Expand All @@ -26,6 +27,8 @@
- [CallRejectedEvent](interfaces/CallRejectedEvent.md)
- [CallUserExternal](interfaces/CallUserExternal.md)
- [CallUserSlack](interfaces/CallUserSlack.md)
- [CardBlock](interfaces/CardBlock.md)
- [CarouselBlock](interfaces/CarouselBlock.md)
- [ChannelArchiveEvent](interfaces/ChannelArchiveEvent.md)
- [ChannelArchiveMessageEvent](interfaces/ChannelArchiveMessageEvent.md)
- [ChannelCreatedEvent](interfaces/ChannelCreatedEvent.md)
Expand Down
8 changes: 4 additions & 4 deletions docs/english/reference/types/interfaces/ActionsBlock.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Interface: ActionsBlock

Defined in: [block-kit/blocks.ts:99](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L99)
Defined in: [block-kit/blocks.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L103)

## Description

Expand All @@ -24,7 +24,7 @@ Holds multiple interactive elements.
optional block_id: string;
```

Defined in: [block-kit/blocks.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L48)
Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49)

#### Description

Expand All @@ -46,7 +46,7 @@ a message. If a message is updated, use a new `block_id`.
elements: ActionsBlockElement[];
```

Defined in: [block-kit/blocks.ts:108](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L108)
Defined in: [block-kit/blocks.ts:112](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L112)

#### Description

Expand All @@ -61,7 +61,7 @@ There is a maximum of 25 elements in each action block.
type: "actions";
```

Defined in: [block-kit/blocks.ts:103](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L103)
Defined in: [block-kit/blocks.ts:107](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L107)

#### Description

Expand Down
85 changes: 85 additions & 0 deletions docs/english/reference/types/interfaces/AlertBlock.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,85 @@
[@slack/types](../index.md) / AlertBlock

# Interface: AlertBlock

Defined in: [block-kit/blocks.ts:119](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L119)

## Description

A prominent notice block for displaying warnings, status updates, or other important information.

## See

[Alert block reference](https://docs.slack.dev/reference/block-kit/blocks/alert-block).

## Extends

- [`Block`](Block.md)

## Properties

### block\_id?

```ts
optional block_id: string;
```

Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49)

#### 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](https://docs.slack.dev/interactivity/handling-user-interaction#payloads).
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.md).[`block_id`](Block.md#block_id)

***

### level?

```ts
optional level: "default" | "info" | "warning" | "error" | "success";
```

Defined in: [block-kit/blocks.ts:131](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L131)

#### Description

The severity level of the alert. Defaults to `"default"` if omitted.

***

### text

```ts
text: TextObject;
```

Defined in: [block-kit/blocks.ts:127](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L127)

#### Description

The alert message content in the form of a [TextObject](../type-aliases/TextObject.md).

***

### type

```ts
type: "alert";
```

Defined in: [block-kit/blocks.ts:123](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L123)

#### Description

The type of block. For an alert block, `type` is always `alert`.

#### Overrides

[`Block`](Block.md).[`type`](Block.md#type)
9 changes: 6 additions & 3 deletions docs/english/reference/types/interfaces/Block.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,14 @@

# Interface: Block

Defined in: [block-kit/blocks.ts:36](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L36)
Defined in: [block-kit/blocks.ts:37](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L37)

## Extended by

- [`ActionsBlock`](ActionsBlock.md)
- [`AlertBlock`](AlertBlock.md)
- [`CardBlock`](CardBlock.md)
- [`CarouselBlock`](CarouselBlock.md)
- [`ContextBlock`](ContextBlock.md)
- [`ContextActionsBlock`](ContextActionsBlock.md)
- [`DividerBlock`](DividerBlock.md)
Expand All @@ -29,7 +32,7 @@ Defined in: [block-kit/blocks.ts:36](https://github.com/slackapi/node-slack-sdk/
optional block_id: string;
```

Defined in: [block-kit/blocks.ts:48](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L48)
Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49)

#### Description

Expand All @@ -47,7 +50,7 @@ a message. If a message is updated, use a new `block_id`.
type: string;
```

Defined in: [block-kit/blocks.ts:40](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L40)
Defined in: [block-kit/blocks.ts:41](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L41)

#### Description

Expand Down
145 changes: 145 additions & 0 deletions docs/english/reference/types/interfaces/CardBlock.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,145 @@
[@slack/types](../index.md) / CardBlock

# Interface: CardBlock

Defined in: [block-kit/blocks.ts:139](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L139)

## 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.

## See

[Card block reference](https://docs.slack.dev/reference/block-kit/blocks/card-block).

## Extends

- [`Block`](Block.md)

## Properties

### actions?

```ts
optional actions: Button[];
```

Defined in: [block-kit/blocks.ts:170](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L170)

#### Description

An array of [Button](Button.md) elements displayed at the bottom of the card.

***

### block\_id?

```ts
optional block_id: string;
```

Defined in: [block-kit/blocks.ts:49](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L49)

#### 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](https://docs.slack.dev/interactivity/handling-user-interaction#payloads).
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.md).[`block_id`](Block.md#block_id)

***

### body?

```ts
optional body: MrkdwnElement;
```

Defined in: [block-kit/blocks.ts:166](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L166)

#### Description

The body text of the card in the form of a [MrkdwnElement](MrkdwnElement.md).
Maximum length for the text in this field is 200 characters.

***

### hero\_image?

```ts
optional hero_image: ImageElement;
```

Defined in: [block-kit/blocks.ts:147](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L147)

#### Description

A top banner image for the card in the form of an [ImageElement](../type-aliases/ImageElement.md).

***

### icon?

```ts
optional icon: ImageElement;
```

Defined in: [block-kit/blocks.ts:151](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L151)

#### Description

A small icon displayed next to the title and subtitle in the form of an [ImageElement](../type-aliases/ImageElement.md).

***

### subtitle?

```ts
optional subtitle: MrkdwnElement;
```

Defined in: [block-kit/blocks.ts:161](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L161)

#### Description

The subtitle of the card in the form of a [MrkdwnElement](MrkdwnElement.md).
Maximum length for the text in this field is 150 characters.

***

### title?

```ts
optional title: MrkdwnElement;
```

Defined in: [block-kit/blocks.ts:156](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L156)

#### Description

The title of the card in the form of a [MrkdwnElement](MrkdwnElement.md).
Maximum length for the text in this field is 150 characters.

***

### type

```ts
type: "card";
```

Defined in: [block-kit/blocks.ts:143](https://github.com/slackapi/node-slack-sdk/blob/main/packages/types/src/block-kit/blocks.ts#L143)

#### Description

The type of block. For a card block, `type` is always `card`.

#### Overrides

[`Block`](Block.md).[`type`](Block.md#type)
Loading