Skip to main content

Rich text input element

An example of a rich text input element

Fields

FieldTypeDescriptionRequired?
typeStringThe type of element. In this case type is always rich_text_input.Required
action_idStringAn 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_valueRich textThe initial value in the rich text input when it is loaded.Optional
dispatch_action_configObjectA dispatch configuration object that determines when during text input the element returns a block_actions payload.Optional
focus_on_loadBooleanIndicates 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
placeholderObjectA 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"
}
}