Skip to main content

@slack/types / RichTextInput

Interface: RichTextInput

Defined in: block-kit/block-elements.ts:1060

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;

Defined in: block-kit/extensions.ts:15

@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

dispatch_action_config?​

optional dispatch_action_config?: DispatchActionConfig;

Defined in: block-kit/extensions.ts:33

Description​

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

Inherited from​

Dispatchable.dispatch_action_config

focus_on_load?​

optional focus_on_load?: boolean;

Defined in: block-kit/extensions.ts:42

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

initial_value?​

optional initial_value?: RichTextBlock;

Defined in: block-kit/block-elements.ts:1068

Description​

Initial contents of the input when it is loaded.

max_lines?​

optional max_lines?: number;

Defined in: block-kit/block-elements.ts:1077

Description​

The maximum number of lines of text shown in the input before it scrolls. Must be between 1 and 100. Defaults to 8 when not specified.

min_lines?​

optional min_lines?: number;

Defined in: block-kit/block-elements.ts:1072

Description​

The minimum number of lines of text shown in the input. Must be between 1 and 100.

placeholder?​

optional placeholder?: PlainTextElement;

Defined in: block-kit/extensions.ts:57

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

type​

type: "rich_text_input";

Defined in: block-kit/block-elements.ts:1064

Description​

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

Overrides​

Actionable.type