EmailInput.md

@slack/web-api / EmailInput

Interface: EmailInput

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:106

Description

Allows user to enter an email into a single-line field.

See

• Email input element reference.
• This is an interactive component - see our guide to enabling interactivity.

Extends

• Actionable.Dispatchable.Focusable.Placeholdable

Properties

action_id?

optional action_id: string;

Defined in: node_modules/@slack/types/dist/block-kit/extensions.d.ts:12

@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: node_modules/@slack/types/dist/block-kit/extensions.d.ts:28

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: node_modules/@slack/types/dist/block-kit/extensions.d.ts:36

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: string;

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:114

Description

The initial value in the email input when it is loaded.

---

placeholder?

optional placeholder: PlainTextElement;

Defined in: node_modules/@slack/types/dist/block-kit/extensions.d.ts:49

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: "email_text_input";

Defined in: node_modules/@slack/types/dist/block-kit/block-elements.d.ts:110

Description

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

Overrides

Actionable.type