Preview environment

interface APITextInputComponent

export interface APITextInputComponent extends APIBaseComponent<ComponentType.TextInput>

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

custom_id : string

The custom id for the text input

optional
id? : number

32 bit integer used as an optional identifier for componentThe 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.

Inherited from: APIBaseComponent

optional
label? : string

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

optional
max_length? : number

Maximal length of text input

optional
min_length? : number

Minimal length of text input

optional
placeholder? : string

Placeholder for the text input

optional
required? : boolean

Whether this text input is required

style : TextInputStyle

One of text input styles

type : T

The type of the component

Inherited from: APIBaseComponent

optional
value? : string

The pre-filled text in the text input