Interface: PlainTextInput
Description
Allows users to enter freeform text data into a single-line or multi-line field.
See
- Plain-text input element reference.
- This is an interactive component - see our guide to enabling interactivity.
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
Defined in
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
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
Defined in
initial_value?
optional initial_value: string;
Description
The initial value in the plain-text input when it is loaded.
Defined in
block-kit/block-elements.ts:543
max_length?
optional max_length: number;
Description
The maximum length of input that the user can provide. If the user provides more, they will receive an error.
Defined in
block-kit/block-elements.ts:558
min_length?
optional min_length: number;
Description
The minimum length of input that the user must provide. If the user provides less, they will receive an error. Maximum value is 3000.
Defined in
block-kit/block-elements.ts:553
multiline?
optional multiline: boolean;
Description
Indicates whether the input will be a single line (false) or a larger textarea (true).
Defaults to false.
Defined in
block-kit/block-elements.ts:548
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
Defined in
type
type: "plain_text_input";
Description
The type of element. In this case type is always plain_text_input.