Skip to main content

Interface: RichTextInput

Description​

A rich text input creates a composer/WYSIWYG editor for entering formatted text, offering nearly the same experience you have writing messages in Slack.

See​

Extends​

Properties​

action_id?​

optional action_id: string;

@description: An identifier for this action. You can use this when you receive an interaction payload to identify the source of the action. Should be unique among all other action_ids in the containing block. Maximum length for this field is 255 characters.

Inherited from​

Actionable.action_id

Defined in​

block-kit/extensions.ts:15

dispatch_action_config?​

optional dispatch_action_config: DispatchActionConfig;

Description​

A DispatchActionConfig object that determines when during text input the element returns a block_actions payload.

Inherited from​

Dispatchable.dispatch_action_config

Defined in​

block-kit/extensions.ts:33

focus_on_load?​

optional focus_on_load: boolean;

Description​

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.

Inherited from​

Focusable.focus_on_load

Defined in​

block-kit/extensions.ts:42

initial_value?​

optional initial_value: RichTextBlock;

Description​

Initial contents of the input when it is loaded.

Defined in​

block-kit/block-elements.ts:964

placeholder?​

optional placeholder: PlainTextElement;

Description​

A PlainTextElement object that defines the placeholder text shown on the element. Maximum length for the text field in this object is 150 characters.

Inherited from​

Placeholdable.placeholder

Defined in​

block-kit/extensions.ts:57

type​

type: "rich_text_input";

Description​

The type of element. In this case type is always rich_text_input.

Overrides​

Actionable.type

Defined in​

block-kit/block-elements.ts:960