TextInput

Implementation of discords TextInput object as a Luau builder.

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

Summary

Properties

TextInput.customId :: string?TextInput.style :: apiTypes.TextInputStyle?TextInput.label :: string?TextInput.minLength :: number?TextInput.maxLength :: number?TextInput.required :: boolean?TextInput.value :: string?TextInput.placeholder :: string?

Methods

TextInput:setCustomId(customId: string) → TextInputTextInput:setStyle(style: apiTypes.TextInputStyle) → TextInputTextInput:setLabel(label: string) → TextInputTextInput:setMinLength(minLength: number) → TextInputTextInput:setMaxLength(maxLength: number) → TextInputTextInput:setIsRequired(isRequired: boolean) → TextInputTextInput:setValue(value: string) → TextInputTextInput:setPlaceholder(placeholder: string) → TextInputTextInput:build() → JSON

Functions

TextInput.new(resource: { customId: string?, style: apiTypes.TextInputStyle?, label: string?, minLength: number?, maxLength: number?, required: boolean?, value: string?, placeholder: string?, }?) → TextInput

Properties

customId

TextInput.customId  :: string?

---

The custom identifier for the text input component.

style

TextInput.style  :: TextInputStyle?

---

The style of the text input component.

label

TextInput.label  :: string?

---

The label text that appears above the text input field.

minLength

TextInput.minLength  :: number?

---

The minimum length of text that can be entered.

maxLength

TextInput.maxLength  :: number?

---

The maximum length of text that can be entered.

required

TextInput.required  :: boolean?

---

Whether this text input field is required to be filled.

value

TextInput.value  :: string?

---

The pre-filled value for the text input field.

placeholder

TextInput.placeholder  :: string?

---

The placeholder text that appears when no text is entered.

Methods

setCustomId

TextInput : setCustomId ( customId )  -> TextInput

Sets the custom identifier for this text input component.

Parameters

customId: string

Returns

TextInput

setStyle

TextInput : setStyle ( style )  -> TextInput

Sets the style of the text input component.

Parameters

style: TextInputStyle

Returns

TextInput

setLabel

TextInput : setLabel ( label )  -> TextInput

Sets the label text that appears above the text input field.

Parameters

label: string

Returns

TextInput

setMinLength

TextInput : setMinLength ( minLength )  -> TextInput

Sets the minimum length of text that can be entered.

Parameters

minLength: number

Returns

TextInput

setMaxLength

TextInput : setMaxLength ( maxLength )  -> TextInput

Sets the maximum length of text that can be entered.

Parameters

maxLength: number

Returns

TextInput

setIsRequired

TextInput : setIsRequired ( isRequired )  -> TextInput

Sets whether this text input field is required to be filled.

Parameters

isRequired: boolean

Returns

TextInput

setValue

TextInput : setValue ( value )  -> TextInput

Sets the pre-filled value for the text input field.

Parameters

value: string

Returns

TextInput

setPlaceholder

TextInput : setPlaceholder ( placeholder )  -> TextInput

Sets the placeholder text that appears when no text is entered.

Parameters

placeholder: string

Returns

TextInput

build

TextInput : build ( )  -> JSON

Responsible for building the TextInput JSON that can be parsed by the Discord API.

Returns

JSON

Functions

new

TextInput . new ( resource )  -> TextInput

Responsible for creating a new TextInput.

local textInput = TextInput.new({
  customId = "my_text_input",
  style = TextInputStyle.Short,
  label = "Enter your name"
})

Parameters

resource: { customId: string?, style: apiTypes.TextInputStyle?, label: string?, minLength: number?, maxLength: number?, required: boolean?, value: string?, placeholder: string?, }

Returns

TextInput