builders

class TextInputBuilder

export declare class TextInputBuilder extends ComponentBuilder<APITextInputComponent> implements Equatable<APITextInputComponent | JSONEncodable<APITextInputComponent>>

A builder that creates API-compatible JSON data for text inputs.

Constructors

constructor(
data?: APITextInputComponent & { type?: ComponentType.TextInput; }
)

Creates a new text input from API data.

Examples:Creating a select menu option from an API data object:
const textInput = new TextInputBuilder({
	custom_id: 'a cool select menu',
	label: 'Type something',
	style: TextInputStyle.Short,
});
Creating a select menu option using setters and API data:
const textInput = new TextInputBuilder({
	label: 'Type something else',
})
	.setCustomId('woah')
	.setStyle(TextInputStyle.Paragraph);

readonly
data : Partial<APITextInputComponent>

The API data associated with this component.

Inherited from: ComponentBuilder

equals(
other: APITextInputComponent | JSONEncodable<APITextInputComponent>
) : boolean

Whether this is equal to another structure.

setCustomId(
customId: string
) : this

Sets the custom id for this text input.

setLabel(
label: string
) : this

Sets the label for this text input.

setMaxLength(
maxLength: number
) : this

Sets the maximum length of text for this text input.

setMinLength(
minLength: number
) : this

Sets the minimum length of text for this text input.

setPlaceholder(
placeholder: string
) : this

Sets the placeholder for this text input.

setRequired(
required?: boolean
) : this

Sets whether this text input is required.

setStyle(
style: TextInputStyle
) : this

Sets the style for this text input.

setValue(
value: string
) : this

Sets the value for this text input.

toJSON() : APITextInputComponent

Serializes this builder to API-compatible JSON data.