Skip to main content

DiscordTextInputComponent

Documentation

Documentation / @discordeno/types / DiscordTextInputComponent

Interface: DiscordTextInputComponent

Defined in: discord/components.ts:268

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

Extends​

Properties​

custom_id​

custom_id: string

Defined in: discord/components.ts:272

The customId of the InputText

id?​

optional id?: number

Defined in: discord/components.ts:100

32 bit integer used as an optional identifier for component

Inherited from​

DiscordBaseComponent.id

label?​

optional label?: string

Defined in: discord/components.ts:283

The label of the InputText.

Remarks​

Maximum 45 characters

Deprecated​

Use the label and description from the DiscordLabelComponent

max_length?​

optional max_length?: number

Defined in: discord/components.ts:287

The maximum length of the text the user has to provide

min_length?​

optional min_length?: number

Defined in: discord/components.ts:285

The minimum length of the text the user has to provide

placeholder?​

optional placeholder?: string

Defined in: discord/components.ts:293

The placeholder of the InputText

required?​

optional required?: boolean

Defined in: discord/components.ts:289

whether this component is required to be filled, default true

style​

style: TextStyles

Defined in: discord/components.ts:274

The style of the InputText

type​

type: TextInput

Defined in: discord/components.ts:269

The type of the component

Overrides​

DiscordBaseComponent.type

value?​

optional value?: string

Defined in: discord/components.ts:291

Pre-filled value for input text.