APITextInputComponent

@see

https://discord.com/developers/docs/interactions/message-components#text-inputs-text-input-structure

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

int32, auto generated via increment if not provided

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