Slack Block Kit

https://docs.slack.dev/reference/block-kit
Admin
Slack Block Kit is a UI framework for Slack apps, providing a collection of visual components...
Tokens:131,266
Snippets:785
Trust Score:10
Update:2 weeks ago
Show doc for...
Tokens:
Raw
### Node Slack SDK Video Block Example

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

Node Slack SDK example that returns a VideoBlock object with the required fields.

```javascript
export function example01() {
  /**
   * @type {import('@slack/types').VideoBlock}
   */
  const block = {
    type: "video",
    title: {
      type: "plain_text",
      text: "Use the Events API to create a dynamic App Home",
      emoji: true,
    },
    title_url: "https://www.youtube.com/watch?v=8876OZV_Yy0",
    description: {
      type: "plain_text",
      text: "Slack sure is nifty!",
      emoji: true,
    },
    video_url:
      "https://www.youtube.com/embed/8876OZV_Yy0?feature=oembed&autoplay=1",
    alt_text: "Use the Events API to create a dynamic App Home",
    thumbnail_url: "https://i.ytimg.com/vi/8876OZV_Yy0/hqdefault.jpg",
  };
  return block;
}
```

--------------------------------

### Java Slack SDK Video Block Example

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

Java Slack SDK example that builds a VideoBlock using the Blocks.video builder.

```java
public static VideoBlock example01() {
    VideoBlock block = Blocks.video(v -> v.title(
                    BlockCompositions.plainText(pt -> pt.text("Use the Events API to create a dynamic App Home")
                            .emoji(true)))
            .titleUrl("https://www.youtube.com/watch?v=8876OZV_Yy0")
            .description(BlockCompositions.plainText(
                    pt -> pt.text("Slack sure is nifty!").emoji(true)))
            .videoUrl("https://www.youtube.com/embed/8876OZV_Yy0?feature=oembed&autoplay=1")
            .altText("Use the Events API to create a dynamic App Home")
            .thumbnailUrl("https://i.ytimg.com/vi/8876OZV_Yy0/hqdefault.jpg"));
    return block;
}
```

--------------------------------

### Java Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/rich-text-preformatted-element

Example of creating a rich text block with a preformatted element using the Java Slack SDK.

```APIDOC
## Java Slack SDK example

### Description
Displays a preformatted rich text element using the Java Slack SDK.

### Code
```java
public static RichTextBlock example01() {
    RichTextBlock block = Blocks.richText(rt -> rt.elements(List.of(RichTextPreformattedElement.builder()
            .border(0)
            .elements(List.of(RichTextSectionElement.Text.builder()
                    .text(
                            "{\n  \"object\": {\n    \"description\": \"this is an example of a json object\"\n  }\n}")
                    .build()))
            .build())));
    return block;
}
```
```

--------------------------------

### Static Multi-Select Menu Java Example

Source: https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element

A Java example demonstrating how to construct a section block containing a multi-select menu with static options.

```java
public static SectionBlock example01() {
    SectionBlock block = Blocks.section(s -> s.blockId("section678")
            .text(BlockCompositions.markdownText("Pick items from the list"))
            .accessory(BlockElements.multiStaticSelect(m -> m.actionId("text1234")
                    .placeholder(BlockCompositions.plainText("Select items"))
                    .options(List.of(
                            OptionObject.builder()
                                    .text(BlockCompositions.plainText("*this is plain_text text*"))
                                    .value("value-0")
                                    .build(),
                            OptionObject.builder()
                                    .text(BlockCompositions.plainText("*this is plain_text text*"))
                                    .value("value-1")
                                    .build(),
                            OptionObject.builder()
                                    .text(BlockCompositions.plainText("*this is plain_text text*"))
                                    .value("value-2")
                                    .build())))));
    return block;
}
```

--------------------------------

### users_select element example

Source: https://docs.slack.dev/reference/block-kit/block-elements/select-menu-element

Example of a users_select select menu element in a section block, showing the JSON structure and SDK implementations.

```APIDOC
## users_select Element

### Description
A select menu that populates its options with a list of Slack users visible to the current user in the active workspace.

### Fields

| Field | Type | Description | Required? |
| --- | --- | --- | --- |
| `type` | String | The type of element. In this case `type` is always `users_select`. | Required |
| `action_id` | String | An identifier for the action triggered when a menu option is selected. Use this when you receive an interaction payload to identify the source of the action. Should be unique among all other `action_id`s in the containing block. Maximum length is 255 characters. | Optional |
| `initial_user` | String | The user ID of any valid user to be pre-selected when the menu loads. | Optional |
| `confirm` | Object | A confirm object that defines an optional confirmation dialog that appears after a menu item is selected. | Optional |
| `focus_on_load` | Boolean | Indicates whether the element will be set to auto focus within the view object. Only one element can be set to `true`. Defaults to `false`. | Optional |
| `placeholder` | Object | A plain_text only text object that defines the placeholder text shown on the menu. Maximum length for the `text` in this field is 150 characters. | Optional |

### Example

A select menu in a section block showing a list of users.

#### JSON
```json
{
    "blocks": [
        {
            "type": "section",
            "block_id": "section678",
            "text": {
                "type": "mrkdwn",
                "text": "Pick a user from the dropdown list"
            },
            "accessory": {
                "action_id": "text1234",
                "type": "users_select",
                "placeholder": {
                    "type": "plain_text",
                    "text": "Select an item"
                }
            }
        }
    ]
}
```

#### Python Slack SDK
```python
def example03() -> SectionBlock:
    """
    A section block with a users select menu accessory.
    """
    block = SectionBlock(
        block_id="section678",
        text=MarkdownTextObject(text="Pick a user from the dropdown list"),
        accessory=UserSelectElement(
            action_id="text1234",
            placeholder=PlainTextObject(text="Select an item"),
        ),
    )
    return block
```

#### Node Slack SDK
```javascript
export function example03() {
  /**
   * @type {import('@slack/types').SectionBlock}
   */
  const block = {
    type: "section",
    block_id: "section678",
    text: {
      type: "mrkdwn",
      text: "Pick a user from the dropdown list",
    },
    accessory: {
      action_id: "text1234",
      type: "users_select",
      placeholder: {
        type: "plain_text",
        text: "Select an item",
      },
    },
  };
  return block;
}
```

#### Java Slack SDK
```java
public static SectionBlock example03() {
    SectionBlock block = Blocks.section(s -> s.blockId("section678")
            .text(BlockCompositions.markdownText("Pick a user from the dropdown list"))
            .accessory(BlockElements.usersSelect(
                    m -> m.actionId("text1234").placeholder(BlockCompositions.plainText("Select an item")))));
    return block;
}
```
```

--------------------------------

### Node Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/rich-text-preformatted-element

Example of creating a rich text block with a preformatted element using the Node Slack SDK.

```APIDOC
## Node Slack SDK example

### Description
Displays a preformatted rich text element using the Node Slack SDK.

### Code
```javascript
export function example01() {
  /**
   * @type {import('@slack/types').RichTextBlock}
   */
  const block = {
    type: "rich_text",
    elements: [
      {
        type: "rich_text_preformatted",
        elements: [
          {
            type: "text",
            text: '{\n  "object": {\n    "description": "this is an example of a json object"\n  }\n}',
          },
        ],
        border: 0,
      },
    ],
  };
  return block;
}
```
```

--------------------------------

### Python Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/rich-text-preformatted-element

Example of creating a rich text block with a preformatted element using the Python Slack SDK.

```APIDOC
## Python Slack SDK example

### Description
Displays a preformatted rich text element using the Python Slack SDK.

### Code
```python
def example01() -> RichTextBlock:
    """
    Displays a preformatted rich text element.
    https://docs.slack.dev/reference/block-kit/block-elements/rich-text-preformatted-element/

    A rich text block with a preformatted code section.
    """
    block = RichTextBlock(
        elements=[
            RichTextPreformattedElement(
                border=0,
                elements=[
                    RichTextElementParts.Text(
                        text='{\n  "object": {\n    "description": "this is an example of a json object"\n  }\n}'
                    ),
                ],
            )
        ]
    )
    return block
```
```

--------------------------------

### Java Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/color-element

Example of creating a color element using the Java Slack SDK, demonstrating the builder pattern for rich text blocks.

```APIDOC
## Java Slack SDK example

### Description
Example of creating a color element using the Java Slack SDK, demonstrating the builder pattern for rich text blocks.

### Code
```java
public static RichTextBlock example01() {
    RichTextBlock block = Blocks.richText(rt -> rt.elements(List.of(RichTextSectionElement.builder()
            .elements(List.of(
                    RichTextSectionElement.Color.builder().value("#F405B3").build()))
            .build())));
    return block;
}
```
```

--------------------------------

### Java Slack SDK Example

Source: https://docs.slack.dev/reference/block-kit/block-elements/broadcast-element

Example of creating a broadcast element using the Java Slack SDK, demonstrating the builder pattern for rich text blocks.

```APIDOC
## Java Slack SDK Example

### Description
Creates a rich text block with a broadcast mention in a section using the Java Slack SDK.

### Code

java
public static RichTextBlock example01() {
    RichTextBlock block = Blocks.richText(rt -> rt.elements(List.of(RichTextSectionElement.builder()
            .elements(List.of(RichTextSectionElement.Broadcast.builder()
                    .range("everyone")
                    .build()))
            .build())));
    return block;
}

```

--------------------------------

### Python Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/color-element

Example of creating a color element using the Python Slack SDK, demonstrating the RichTextBlock and RichTextSectionElement classes.

```APIDOC
## Python Slack SDK example

### Description
Example of creating a color element using the Python Slack SDK, demonstrating the RichTextBlock and RichTextSectionElement classes.

### Code
```python
def example01() -> RichTextBlock:
    """
    Displays a color swatch from a hex value.
    https://docs.slack.dev/reference/block-kit/block-elements/color-element/

    A rich text block with a color element in a section.
    """
    block = RichTextBlock(
        elements=[
            RichTextSectionElement(
                elements=[
                    RichTextElementParts.Color(value="#F405B3"),
                ]
            )
        ]
    )
    return block
```
```

--------------------------------

### Python Slack SDK Example

Source: https://docs.slack.dev/reference/block-kit/block-elements/broadcast-element

Example of creating a broadcast element using the Python Slack SDK, demonstrating the RichTextBlock and RichTextSectionElement classes.

```APIDOC
## Python Slack SDK Example

### Description
Creates a rich text block with a broadcast mention in a section using the Python Slack SDK.

### Code

python
def example01() -> RichTextBlock:
    """
    Displays a broadcast mention such as here, channel, or everyone.
    https://docs.slack.dev/reference/block-kit/block-elements/broadcast-element/

    A rich text block with a broadcast mention in a section.
    """
    block = RichTextBlock(
        elements=[
            RichTextSectionElement(
                elements=[
                    RichTextElementParts.Broadcast(range="everyone"),
                ]
            )
        ]
    )
    return block

```

--------------------------------

### Node Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/color-element

Example of creating a color element using the Node Slack SDK, showing the object structure for a rich text block.

```APIDOC
## Node Slack SDK example

### Description
Example of creating a color element using the Node Slack SDK, showing the object structure for a rich text block.

### Code
```javascript
export function example01() {
  /**
   * @type {import('@slack/types').RichTextBlock}
   */
  const block = {
    type: "rich_text",
    elements: [
      {
        type: "rich_text_section",
        elements: [
          {
            type: "color",
            value: "#F405B3",
          },
        ],
      },
    ],
  };
  return block;
}
```
```

--------------------------------

### Node Slack SDK Example

Source: https://docs.slack.dev/reference/block-kit/block-elements/broadcast-element

Example of creating a broadcast element using the Node Slack SDK, showing the object structure for a rich text block.

```APIDOC
## Node Slack SDK Example

### Description
Creates a rich text block with a broadcast mention in a section using the Node Slack SDK.

### Code

javascript
export function example01() {
  /**
   * @type {import('@slack/types').RichTextBlock}
   */
  const block = {
    type: "rich_text",
    elements: [
      {
        type: "rich_text_section",
        elements: [
          {
            type: "broadcast",
            range: "everyone",
          },
        ],
      },
    ],
  };
  return block;
}

```

--------------------------------

### Java ActionsBlock Example

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

This example demonstrates how to construct an ActionsBlock containing a date picker, an overflow menu, and a button using the Java SDK.

```java
public static ActionsBlock example02() {
    ActionsBlock block = Blocks.actions(a -> a.blockId("actionblock789")
            .elements(List.of(
                    BlockElements.datePicker(d -> d.actionId("datepicker123")
                            .initialDate("1990-04-28")
                            .placeholder(BlockCompositions.plainText("Select a date"))),
                    BlockElements.overflowMenu(o -> o.actionId("overflow")
                            .options(List.of(
                                    OptionObject.builder()
                                            .text(plainText("*this is plain_text text*"))
                                            .value("value-0")
                                            .build(),
                                    OptionObject.builder()
                                            .text(plainText("*this is plain_text text*"))
                                            .value("value-1")
                                            .build(),
                                    OptionObject.builder()
                                            .text(plainText("*this is plain_text text*"))
                                            .value("value-2")
                                            .build(),
                                    OptionObject.builder()
                                            .text(plainText("*this is plain_text text*"))
                                            .value("value-3")
                                            .build(),
                                    OptionObject.builder()
                                            .text(plainText("*this is plain_text text*"))
                                            .value("value-4")
                                            .build()))),
                    BlockElements.button(b -> b.text(BlockCompositions.plainText("Click Me"))
                            .value("click_me_123")
                            .actionId("button")))));
    return block;
}
```

--------------------------------

### URL input element example

Source: https://docs.slack.dev/reference/block-kit/block-elements/url-input-element

Example of using the URL input element inside an input block, shown in JSON and Slack SDKs.

```APIDOC
## URL input element

### Description
Allows user to enter a URL into a single-line field. Must be used inside an input block.

### Fields

| Field | Type | Description | Required? |
| --- | --- | --- | --- |
| `type` | String | The type of element. In this case `type` is always `url_text_input`. | Required |
| `action_id` | String | An identifier for the input value when the parent modal is submitted. Should be unique among all other `action_id`s in the containing block. Maximum length is 255 characters. | Optional |
| `initial_value` | String | The initial value in the URL input when it is loaded. | Optional |
| `dispatch_action_config` | Object | A dispatch configuration object that determines when during text input the element returns a `block_actions` payload. | Optional |
| `focus_on_load` | Boolean | Indicates whether the element will be set to auto focus within the `view object`. Only one element can be set to `true`. Defaults to `false`. | Optional |
| `placeholder` | Object | A `plain_text` only text object that defines the placeholder text shown in the URL input. Maximum length for the `text` in this field is 150 characters. | Optional |

### Example (JSON)
```json
{
    "blocks": [
        {
            "type": "input",
            "element": {
                "type": "url_text_input",
                "action_id": "url_text_input-action"
            },
            "label": {
                "type": "plain_text",
                "text": "Label",
                "emoji": true
            }
        }
    ]
}
```

### Example (Python Slack SDK)
```python
def example01() -> InputBlock:
    """
    Allows user to enter a URL into a single-line field.
    https://docs.slack.dev/reference/block-kit/block-elements/url-input-element/

    An input block with a URL input element.
    """
    block = InputBlock(
        element=UrlInputElement(action_id="url_text_input-action"),
        label=PlainTextObject(text="Label", emoji=True),
    )
```

### Example (Node Slack SDK)
```javascript
export function example01() {
  /**
   * @type {import('@slack/types').InputBlock}
   */
  const block = {
    type: "input",
    element: {
      type: "url_text_input",
      action_id: "url_text_input-action",
    },
    label: {
      type: "plain_text",
      text: "Label",
      emoji: true,
    },
  };
  return block;
}
```

### Example (Java Slack SDK)
```java
public static InputBlock example01() {
    InputBlock block = Blocks.input(i -> i.element(
                    BlockElements.urlTextInput(u -> u.actionId("url_text_input-action")))
            .label(BlockCompositions.plainText(pt -> pt.text("Label").emoji(true))));
    return block;
}
```
```

--------------------------------

### Java Slack SDK example: Create an OptionObject

Source: https://docs.slack.dev/reference/block-kit/composition-objects/option-object

Uses the Slack Java SDK to build an OptionObject with a plain text object and value. The example uses the builder pattern and BlockCompositions.plainText.

```java
public static OptionObject example01() {
    OptionObject option = OptionObject.builder()
            .text(BlockCompositions.plainText(pt -> pt.text("Save it").emoji(true)))
            .value("value-2")
            .build();
    return option;
}
```

--------------------------------

### Java Slack SDK channel element example

Source: https://docs.slack.dev/reference/block-kit/block-elements/channel-element

Java Slack SDK example that builds a rich text block with a channel mention using Blocks.richText and RichTextSectionElement.Channel.

```java
public static RichTextBlock example01() {
    RichTextBlock block = Blocks.richText(rt -> rt.elements(List.of(RichTextSectionElement.builder()
            .elements(List.of(RichTextSectionElement.Channel.builder()
                    .channelId("C123ABC456")
                    .build()))
            .build())));
    return block;
}
```

--------------------------------

### Python Slack SDK Video Block Example

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

Python Slack SDK example that creates a VideoBlock with a plain text title, description, video URL, alt text, and thumbnail URL.

```python
def example01() -> VideoBlock:
    """
    Displays an embedded video player.
    https://docs.slack.dev/reference/block-kit/blocks/video-block/

    A video block.
    """
    block = VideoBlock(
        title=PlainTextObject(
            text="Use the Events API to create a dynamic App Home", emoji=True
        ),
        title_url="https://www.youtube.com/watch?v=8876OZV_Yy0",
        description=PlainTextObject(text="Slack sure is nifty!", emoji=True),
        video_url="https://www.youtube.com/embed/8876OZV_Yy0?feature=oembed&autoplay=1",
        alt_text="Use the Events API to create a dynamic App Home",
        thumbnail_url="https://i.ytimg.com/vi/8876OZV_Yy0/hqdefault.jpg",
    )
    return block
```

--------------------------------

### Create Input Block with Plain Text Input (Java)

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

Defines example01() that returns an InputBlock with a plain text input element and a label. Use this to collect user input in a Slack message.

```java
public static InputBlock example01() {
    InputBlock block = Blocks.input(i -> i.element(BlockElements.plainTextInput(pt -> pt))
            .label(BlockCompositions.plainText(pt -> pt.text("Label").emoji(true))));
    return block;
}
```

--------------------------------

### Java Slack SDK file block example

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

Creating a file block using the Java Slack SDK.

```java
public class File {
    /**
     * A file block for a remote file.
     */
    public static FileBlock example01() {
        FileBlock block = Blocks.file(f -> f.externalId("ABCD1").source("remote"));
        return block;
    }
}
```

--------------------------------

### Actions Block Python Example

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

An example of an Actions block containing a datepicker, an overflow menu, and a button using the Python SDK.

```python
def example02() -> ActionsBlock:
    """
    An actions block with a datepicker, an overflow, and a button.
    """
    block = ActionsBlock(
        block_id="actionblock789",
        elements=[
            DatePickerElement(
                action_id="datepicker123",
                initial_date="1990-04-28",
                placeholder=PlainTextObject(text="Select a date"),
            ),
            OverflowMenuElement(
                action_id="overflow",
                options=[
                    Option(
                        text=PlainTextObject(text="*this is plain_text text*"),
                        value="value-0",
                    ),
                    Option(
                        text=PlainTextObject(text="*this is plain_text text*"),
                        value="value-1",
                    ),
                    Option(
                        text=PlainTextObject(text="*this is plain_text text*"),
                        value="value-2",
                    ),
                    Option(
                        text=PlainTextObject(text="*this is plain_text text*"),
                        value="value-3",
                    ),
                    Option(
                        text=PlainTextObject(text="*this is plain_text text*"),
                        value="value-4",
                    ),
                ],
            ),
            ButtonElement(
                text=PlainTextObject(text="Click Me"),
                value="click_me_123",
                action_id="button",
            ),
        ],
    )
    return block
```

--------------------------------

### Python Slack SDK file block example

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

Creating a file block using the Python Slack SDK.

```python
def example01() -> FileBlock:
    """
    Displays info about remote files.
    https://docs.slack.dev/reference/block-kit/blocks/file-block/

    A file block for a remote file.
    """
    block = FileBlock(external_id="ABCD1", source="remote")
    return block
```

--------------------------------

### Create Input Block with Plain Text Input (Python)

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

Defines example01() that returns an InputBlock with a PlainTextInputElement and a label. Use this to collect user input in a Slack message.

```python
def example01() -> InputBlock:
    """
    Collects information from users via elements.
    https://docs.slack.dev/reference/block-kit/blocks/input-block/

    An input block containing a plain-text input element.
    """
    block = InputBlock(
        element=PlainTextInputElement(),
        label=PlainTextObject(text="Label", emoji=True),
    )
    return block
```

--------------------------------

### Header block JSON example

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

A JSON example of a header block with plain text. Use this to create a header in your Slack message.

```json
{
    "blocks": [
        {
            "type": "header",
            "text": {
                "type": "plain_text",
                "text": "A Heartfelt Header"
            }
        }
    ]
}
```

--------------------------------

### Node Slack SDK file block example

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

Creating a file block using the Node Slack SDK.

```javascript
export function example01() {
  /**
   * @type {import('@slack/types').FileBlock}
   */
  const block = {
    type: "file",
    external_id: "ABCD1",
    source: "remote",
  };
  return block;
}
```

--------------------------------

### File element JSON example

Source: https://docs.slack.dev/reference/block-kit/block-elements/file-element

Example of a File element nested inside a rich_text_section, which is inside a rich_text block. The file_id is required.

```json
{    "blocks": [        {            "type": "rich_text",            "elements": [                {                    "type": "rich_text_section",                    "elements": [                        {                            "type": "file",                            "file_id": "F123ABC456"                        }                    ]                }            ]        }    ]}
```

--------------------------------

### Actions Block JavaScript Example

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

An example of an Actions block containing a datepicker, an overflow menu, and a button using JavaScript object notation.

```javascript
export function example02() {
  /**
   * @type {import('@slack/types').ActionsBlock}
   */
  const block = {
    type: "actions",
    block_id: "actionblock789",
    elements: [
      {
        type: "datepicker",
        action_id: "datepicker123",
        initial_date: "1990-04-28",
        placeholder: {
          type: "plain_text",
          text: "Select a date",
        },
      },
      {
        type: "overflow",
        action_id: "overflow",
        options: [
          {
            text: {
              type: "plain_text",
              text: "*this is plain_text text*",
            },
            value: "value-0",
          },
          {
            text: {
              type: "plain_text",
              text: "*this is plain_text text*",
            },
            value: "value-1",
          },
          {
            text: {
              type: "plain_text",
              text: "*this is plain_text text*",
            },
            value: "value-2",
          },
          {
            text: {
              type: "plain_text",
              text: "*this is plain_text text*",
            },
            value: "value-3",
          },
          {
            text: {
              type: "plain_text",
              text: "*this is plain_text text*",
            },
            value: "value-4",
          },
        ],
      },
      {
        type: "button",
        text: {
          type: "plain_text",
          text: "Click Me",
        },
        value: "click_me_123",
        action_id: "button",
      },
    ],
  };
  return block;
}
```

--------------------------------

### Markdown block JSON example

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

Example of a markdown block in JSON format. The block type is 'markdown' and the text contains markdown-formatted content.

```json
{
    "blocks": [
        {
            "type": "markdown",
            "text": "**Lots of information here!!**"
        }
    ]
}
```

--------------------------------

### Create Input Block with Plain Text Input (JavaScript)

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

Defines example01() that returns an InputBlock object with a plain_text_input element and a label. Use this to collect user input in a Slack message.

```javascript
export function example01() {
  /**
   * @type {import('@slack/types').InputBlock}
   */
  const block = {
    type: "input",
    element: {
      type: "plain_text_input",
    },
    label: {
      type: "plain_text",
      text: "Label",
      emoji: true,
    },
  };
  return block;
}
```

--------------------------------

### Workflow object Python Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/composition-objects/workflow-object

A Python example demonstrating how to construct a section block with a workflow button using the Slack SDK.

```python
def example01() -> SectionBlock:
    """
    Defines an object containing workflow information.
    https://docs.slack.dev/reference/block-kit/composition-objects/workflow-object/

    A section block with a workflow button whose workflow carries a trigger.
    """
    block = SectionBlock(
        text=MarkdownTextObject(
            text="A message *with some bold text* and _some italicized text_."
        ),
        accessory=WorkflowButtonElement(
            text=PlainTextObject(text="Run Workflow"),
            action_id="workflowbutton123",
            workflow=Workflow(
                trigger=WorkflowTrigger(
                    url="https://slack.com/shortcuts/Ft0123ABC456/xyz...zyx",
                    customizable_input_parameters=[
                        {
                            "name": "input_parameter_a",
                            "value": "Value for input param A",
                        },
                        {
                            "name": "input_parameter_b",
                            "value": "Value for input param B",
                        },
                    ],
                ),
            ),
        ),
    )
    return block
```

--------------------------------

### Trigger object Python Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/composition-objects/trigger-object

A Python example using the Slack SDK to define a section block with a workflow button and trigger.

```python
def example01() -> SectionBlock:
    """
    Defines an object containing trigger information.
    https://docs.slack.dev/reference/block-kit/composition-objects/trigger-object/

    A section block with a workflow button whose trigger carries customizable input parameters.
    """
    block = SectionBlock(
        text=MarkdownTextObject(
            text="A message *with some bold text* and _some italicized text_."
        ),
        accessory=WorkflowButtonElement(
            text=PlainTextObject(text="Run Workflow"),
            action_id="workflowbutton123",
            workflow=Workflow(
                trigger=WorkflowTrigger(
                    url="https://slack.com/shortcuts/Ft0123ABC456/xyz...zyx",
                    customizable_input_parameters=[
                        {
                            "name": "input_parameter_a",
                            "value": "Value for input param A",
                        },
                        {
                            "name": "input_parameter_b",
                            "value": "Value for input param B",
                        },
                    ],
                ),
            ),
        ),
    )
    return block
```

--------------------------------

### Rich text preformatted element JSON example

Source: https://docs.slack.dev/reference/block-kit/block-elements/rich-text-preformatted-element

Example of a rich_text block containing a rich_text_preformatted element with a text element and border set to 0.

```APIDOC
## rich_text_preformatted element

### Description
Displays a preformatted rich text element.

### Fields
- `type` (String) - Required - The type of the sub-element; in this case, `rich_text_preformatted`.
- `elements` (Object[]) - Required - An array of text or link elements.
- `border` (Number) - Optional - Turn the border on or off.
- `language` (String) - Optional - The language of the code block, used for syntax highlighting (e.g., `"python"`, `"javascript"`, `"json"`).

### Example
```json
{
  "blocks": [
    {
      "type": "rich_text",
      "elements": [
        {
          "type": "rich_text_preformatted",
          "elements": [
            {
              "type": "text",
              "text": "{\n  \"object\": {\n    \"description\": \"this is an example of a json object\"\n  }\n}"
            }
          ],
          "border": 0
        }
      ]
    }
  ]
}
```
```

--------------------------------

### Link element Java Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/link-element

Example of creating a rich text block with a link element using the Java Slack SDK.

```java
public static RichTextBlock example01() {
    RichTextBlock block = Blocks.richText(rt -> rt.elements(List.of(RichTextSectionElement.builder()
            .elements(List.of(RichTextSectionElement.Link.builder()
                    .url("https://docs.slack.dev")
                    .build()))
            .build())));
    return block;
}
```

--------------------------------

### Python Slack SDK example: Create an Option object

Source: https://docs.slack.dev/reference/block-kit/composition-objects/option-object

Uses the Slack Python SDK to build an Option with a plain text object and a value. The example is part of a function that returns the option object. Refer to the docs link for full details.

```python
def example01() -> Option:
    """
    Defines a single item in a number of item selection elements.
    https://docs.slack.dev/reference/block-kit/composition-objects/option-object/

    A single option object.
    """
    option = Option(
        text=PlainTextObject(text="Save it", emoji=True),
        value="value-2",
    )
    return option
```

--------------------------------

### Multi-select menu Node Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element

Implementation of a multi-select menu using the Node Slack SDK.

```javascript
export function example04() {
  /**
   * @type {import('@slack/types').SectionBlock}
   */
  const block = {
    type: "section",
    block_id: "section678",
    text: {
      type: "mrkdwn",
      text: "Pick conversations from the list",
    },
    accessory: {
      action_id: "text1234",
      type: "multi_conversations_select",
      placeholder: {
        type: "plain_text",
        text: "Select conversations",
      },
    },
  };
  return block;
}
```

--------------------------------

### Link element Node Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/link-element

Example of creating a rich text block with a link element using the Node Slack SDK.

```javascript
export function example01() {
  /**
   * @type {import('@slack/types').RichTextBlock}
   */
  const block = {
    type: "rich_text",
    elements: [
      {
        type: "rich_text_section",
        elements: [
          {
            type: "link",
            url: "https://docs.slack.dev",
          },
        ],
      },
    ],
  };
  return block;
}
```

--------------------------------

### Multi-select menu Node Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element

Implementation of a multi-select menu using the Node Slack SDK.

```javascript
export function example05() {
  /**
   * @type {import('@slack/types').SectionBlock}
   */
  const block = {
    type: "section",
    block_id: "section678",
    text: {
      type: "mrkdwn",
      text: "Pick channels from the list",
    },
    accessory: {
      action_id: "text1234",
      type: "multi_channels_select",
      placeholder: {
        type: "plain_text",
        text: "Select channels",
      },
    },
  };
  return block;
}
```

--------------------------------

### Link element Python Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/link-element

Example of creating a rich text block with a link element using the Python Slack SDK.

```python
def example01() -> RichTextBlock:
    """
    Displays a hyperlink.
    https://docs.slack.dev/reference/block-kit/block-elements/link-element/

    A rich text block with a link element in a section.
    """
    block = RichTextBlock(
        elements=[
            RichTextSectionElement(
                elements=[
                    RichTextElementParts.Link(url="https://docs.slack.dev"),
                ]
            )
        ]
    )
    return block
```

--------------------------------

### Color element JSON example

Source: https://docs.slack.dev/reference/block-kit/block-elements/color-element

Example of a color element within a rich_text_section inside a rich_text block, showing the required type and value fields.

```APIDOC
## Color element JSON example

### Description
Example of a color element within a rich_text_section inside a rich_text block, showing the required type and value fields.

### Fields
- **type** (String) - Required - The type of object; in this case, "color".
- **value** (String) - Required - The hex value for the color.
- **style** (Object) - Optional - An object of optional boolean properties that dictate style: `bold`, `italic`, `strike`, `highlight`, `client_highlight`, and `underline`.

### Example
```json
{
    "blocks": [
        {
            "type": "rich_text",
            "elements": [
                {
                    "type": "rich_text_section",
                    "elements": [
                        {
                            "type": "color",
                            "value": "#F405B3"
                        }
                    ]
                }
            ]
        }
    ]
}
```
```

--------------------------------

### Multi-select menu Python Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element

Implementation of a multi-select menu using the Python Slack SDK.

```python
def example05() -> SectionBlock:
    """
    A multi-select menu in a section block showing a list of channels.
    """
    block = SectionBlock(
        block_id="section678",
        text=MarkdownTextObject(text="Pick channels from the list"),
        accessory=ChannelMultiSelectElement(
            action_id="text1234",
            placeholder=PlainTextObject(text="Select channels"),
        ),
    )
    return block
```

--------------------------------

### Multi-select menu Python Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element

Implementation of a multi-select menu using the Python Slack SDK.

```python
def example04() -> SectionBlock:
    """
    A multi-select menu in a section block showing a list of conversations.
    """
    block = SectionBlock(
        block_id="section678",
        text=MarkdownTextObject(text="Pick conversations from the list"),
        accessory=ConversationMultiSelectElement(
            action_id="text1234",
            placeholder=PlainTextObject(text="Select conversations"),
        ),
    )
    return block
```

--------------------------------

### Multi-select menu Java Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element

Implementation of a multi-select menu using the Java Slack SDK.

```java
public static SectionBlock example05() {
    SectionBlock block = Blocks.section(s -> s.blockId("section678")
            .text(BlockCompositions.markdownText("Pick channels from the list"))
            .accessory(BlockElements.multiChannelsSelect(
                    m -> m.actionId("text1234").placeholder(BlockCompositions.plainText("Select channels")))));
    return block;
}
```

--------------------------------

### Multi-select menu Java Slack SDK example

Source: https://docs.slack.dev/reference/block-kit/block-elements/multi-select-menu-element

Implementation of a multi-select menu using the Java Slack SDK.

```java
public static SectionBlock example04() {
    SectionBlock block = Blocks.section(s -> s.blockId("section678")
            .text(BlockCompositions.markdownText("Pick conversations from the list"))
            .accessory(BlockElements.multiConversationsSelect(
                    m -> m.actionId("text1234").placeholder(BlockCompositions.plainText("Select conversations")))));
    return block;
}
```

--------------------------------

### Python Slack SDK channel element example

Source: https://docs.slack.dev/reference/block-kit/block-elements/channel-element

Python Slack SDK example that creates a rich text block with a channel mention using RichTextElementParts.Channel.

```python
def example01() -> RichTextBlock:
    """
    Renders as a mention of a channel.
    https://docs.slack.dev/reference/block-kit/block-elements/channel-element/

    A rich text block with a channel mention in a section.
    """
    block = RichTextBlock(
        elements=[
            RichTextSectionElement(
                elements=[
                    RichTextElementParts.Channel(channel_id="C123ABC456"),
                ]
            )
        ]
    )
    return block
```

--------------------------------

### Python example of button element using slack-sdk Block Kit classes

Source: https://docs.slack.dev/reference/block-kit/block-elements/button-element

Defines a function returning a list of Block objects. Uses SectionBlock with a ButtonElement accessory and ActionsBlock with primary and link buttons. Requires the slack-sdk Block Kit classes.

```python
def example05() -> list[Block]:
    """
    The button element used inside either the section or actions block.
    """
    blocks: list[Block] = [
        SectionBlock(
            text=MarkdownTextObject(text="This is a section block with a button."),
            accessory=ButtonElement(
                text=PlainTextObject(text="Click Me"),
                value="click_me_123",
                action_id="button",
            ),
        ),
        ActionsBlock(
            block_id="actionblock789",
            elements=[
                ButtonElement(
                    text=PlainTextObject(text="Primary Button"),
                    style="primary",
                    value="click_me_456",
                ),
                ButtonElement(
                    text=PlainTextObject(text="Link Button"),
                    url="https://api.slack.com/block-kit",
                ),
            ],
        ),
    ]
    return blocks
```
Tokens:
Raw