Skip to content
Interfacediscord-component-embedv1.0.0

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.

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 also:https://discord.com/developers/docs/components/reference#text-input

interface APITextInputComponent extends APIBaseComponent<ComponentType.TextInput>

custom_id

The custom id for the text input

custom_id: string;

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.

id?: number

Inherited from:APIBaseComponent

label

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

Cannot be used in a label component.

label?: string

max_length

Maximal length of text input

max_length?: number

min_length

Minimal length of text input

min_length?: number

placeholder

Placeholder for the text input

placeholder?: string

required

Whether this text input is required

required?: boolean

value

The pre-filled text in the text input

value?: string