Skip to main content

TextInputComponent

Documentation

Documentation / @discordeno/types / TextInputComponent

Interface: TextInputComponent

Defined in: discordeno/components.ts:160

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

Extends​

Properties​

customId​

customId: string

Defined in: discordeno/components.ts:164

The customId of the InputText

id?​

optional id?: number

Defined in: discordeno/components.ts:42

32 bit integer used as an optional identifier for component

Inherited from​

BaseComponent.id

label?​

optional label?: string

Defined in: discordeno/components.ts:175

The label of the InputText.

Remarks​

Maximum 45 characters

Deprecated​

Use the label and description from the LabelComponent

maxLength?​

optional maxLength?: number

Defined in: discordeno/components.ts:179

The maximum length of the text the user has to provide

minLength?​

optional minLength?: number

Defined in: discordeno/components.ts:177

The minimum length of the text the user has to provide

placeholder?​

optional placeholder?: string

Defined in: discordeno/components.ts:185

The placeholder of the InputText

required?​

optional required?: boolean

Defined in: discordeno/components.ts:181

Whether or not this input is required.

style​

style: TextStyles

Defined in: discordeno/components.ts:166

The style of the InputText

type​

type: TextInput

Defined in: discordeno/components.ts:161

The type of the component

Overrides​

BaseComponent.type

value?​

optional value?: string

Defined in: discordeno/components.ts:183

Pre-filled value for input text.