APITextInputComponent

Text Input is an interactive component that allows users to enter free-form text responses in modals. It supports both short, single-line inputs and longer, multi-line paragraph inputs.

Text Inputs can only be used within modals and must be placed inside an Action Row.

When defining a text input component, you can set attributes to customize the behavior and appearance of it. However, not all attributes will be returned in the text input interaction payload.

@see

https://discord.com/developers/docs/components/reference#text-input

Hierarchy

• APIBaseComponent<ComponentType.TextInput>
  • APITextInputComponent

Index

Properties

• custom_id
• id
• label
• max_length
• min_length
• placeholder
• required
• style
• type
• value

Properties

custom_id

custom_id: string

The custom id for the text input

optionalinheritedid

id?: number

Inherited from APIBaseComponent.id

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.

label

label: string

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

optionalmax_length

max_length?: number

Maximal length of text input

optionalmin_length

min_length?: number

Minimal length of text input

optionalplaceholder

placeholder?: string

Placeholder for the text input

optionalrequired

required?: boolean

Whether or not this text input is required or not

style

style: TextInputStyle

One of text input styles

inheritedtype

type: TextInput

Inherited from APIBaseComponent.type

The type of the component

optionalvalue

value?: string

The pre-filled text in the text input