Skip to main content
Version: Next

APITextInputComponentInModal

A text input component that may be used in modals.

Hierarchy

Index

Properties

Properties

inheritedcustom_id

custom_id: string

The custom id for the text input

optionalinheritedid

id?: number

32 bit integer used as an optional identifier for component

The id field is optional and is used to identify components in the response from an interaction that aren't interactive components. The id must be unique within the message and is generated sequentially if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component.

inheritedlabel

label: string

Text that appears on top of the text input field, max 45 characters

optionalinheritedmax_length

max_length?: number

Maximal length of text input

optionalinheritedmin_length

min_length?: number

Minimal length of text input

optionalinheritedplaceholder

placeholder?: string

Placeholder for the text input

optionalinheritedrequired

required?: boolean

Whether or not this text input is required or not

inheritedstyle

style: TextInputStyle

One of text input styles

inheritedtype

type: TextInput

The type of the component

optionalinheritedvalue

value?: string

The pre-filled text in the text input

Page Options