Input

A labeled form field for a modal or App Home, the only way to collect input from a user.

input pairs a label with one form element: a text field, a select, a date or time picker, checkboxes, or radio buttons. It’s the field type modals and App Home tabs use to collect values a user submits; message and card surfaces never render it.

Fields

Examples

Plain text input

Multiline plain text input

Checkboxes

Radio buttons

Static select

Every select variant renders the same way inside input. See select menus for multi_static_select, users_select, external_select, and the rest.

Multi-user select

Date and time pickers

Optional field

An optional field shows an “(optional)” suffix next to its label, in a modal or Home tab form:

Hint

Interactivity

By default an input block’s element sends no actions: its value only reaches state, and your app reads it from the view_submission payload. Set dispatch_action: true to also get a block_actions payload as the user interacts, like an element in an actions block.

Checkboxes, radio buttons, selects and pickers then dispatch on every change. Single-line text inputs (plain_text_input, email_text_input, url_text_input, number_input) dispatch on the trigger in their dispatch_action_config: on_enter_pressed (the default) or on_character_entered. A multiline plain_text_input never dispatches on Enter, which inserts a newline instead.

onAction receives, on pressing Enter:

{
  "type": "plain_text_input",
  "action_id": "plain_text_input-action",
  "block_id": "<the input block's block_id>",
  "value": "…"
}

When the field doesn’t already carry its own hint, a single-line on_enter_pressed-dispatching input shows a synthesized “Press ‘enter’ to submit” hint below it, matching Slack’s Builder preview:

Any other element dispatches on change. Tick a box to see the action:

Related