Rich text input element

Welcome to the new home of Slack developer docs!

We're still building and not all features are available quite yet. Enjoy this peek into the future!

Not ready for the future? Return to the past at api.slack.com.

An example of a rich text input element

Fields

Field	Type	Description	Required?
`type`	String	The type of element. In this case `type` is always `rich_text_input`.	Required
`action_id`	String	An identifier for the input value when the parent modal is submitted. You can use this when you receive a `view_submission` payload to identify the value of the input element. Should be unique in the containing block. Maximum length is 255 characters.	Required
`initial_value`	Rich text	The initial value in the rich text 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` object that defines the placeholder text shown in the plain-text input. Maximum length for the `text` in this field is 150 characters.	Optional

Example

An input block containing a rich text input element.

{
  "type": "rich_text_input",
  "action_id": "rich_text_input-action",
  "dispatch_action_config": {
    "trigger_actions_on": [
      "on_character_entered"
    ]
  },
  "focus_on_load": true,
  "placeholder": {
    "type": "plain_text",
    "text": "Enter text"
  }
}

Fields​

Example​

Fields

Example