Skip to main content

DiscordTextInputComponent

@discordeno/bot

Documentation / @discordeno/bot / DiscordTextInputComponent

Interface: DiscordTextInputComponent

Defined in: packages/types/dist/types/discord/components.d.ts:178

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

Extends​

Properties​

custom_id​

custom_id: string

Defined in: packages/types/dist/types/discord/components.d.ts:181

The customId of the InputText

id?​

optional id: number

Defined in: packages/types/dist/types/discord/components.d.ts:43

32 bit integer used as an optional identifier for component

Inherited from​

DiscordBaseComponent.id

label​

label: string

Defined in: packages/types/dist/types/discord/components.d.ts:185

The label of the InputText (max 45 characters)

max_length?​

optional max_length: number

Defined in: packages/types/dist/types/discord/components.d.ts:189

The maximum length of the text the user has to provide

min_length?​

optional min_length: number

Defined in: packages/types/dist/types/discord/components.d.ts:187

The minimum length of the text the user has to provide

placeholder?​

optional placeholder: string

Defined in: packages/types/dist/types/discord/components.d.ts:195

The placeholder of the InputText

required?​

optional required: boolean

Defined in: packages/types/dist/types/discord/components.d.ts:191

whether this component is required to be filled, default true

style​

style: TextStyles

Defined in: packages/types/dist/types/discord/components.d.ts:183

The style of the InputText

type​

type: TextInput

Defined in: packages/types/dist/types/discord/components.d.ts:179

The type of the component

Overrides​

DiscordBaseComponent.type

value?​

optional value: string

Defined in: packages/types/dist/types/discord/components.d.ts:193

Pre-filled value for input text.