TextInput

Represents a text input component builder.

Example

const textInput = new TextInput().setLabel("Enter text");
textInput.setStyle(TextInputStyle.Paragraph);
textInput.setPlaceholder("Type here");
const json = textInput.toJSON();

Extends

• BaseComponentBuilder<APITextInputComponent>

Constructors

new TextInput(data)

new TextInput(data: Partial<APITextInputComponent>): TextInput

Creates a new TextInput instance.

Parameters

Parameter	Type	Description
data	Partial<APITextInputComponent>	Optional data for the text input.

Returns

TextInput

Overrides

BaseComponentBuilder.constructor

Source

seyfert/src/builders/Modal.ts:118

Properties

Property	Modifier	Type	Inherited from
data	public	Partial<APITextInputComponent>	BaseComponentBuilder.data

Methods

setCustomId()

setCustomId(id: string): this

Sets the custom ID of the text input.

Parameters

Parameter	Type	Description
id	string	The custom ID for the text input.

Returns

this

The current TextInput instance.

Source

seyfert/src/builders/Modal.ts:168

---

setLabel()

setLabel(label: string): this

Sets the label of the text input.

Parameters

Parameter	Type	Description
label	string	The label of the text input.

Returns

this

The current TextInput instance.

Source

seyfert/src/builders/Modal.ts:137

---

setLength()

setLength(options: Partial<OptionValuesLength>): this

Sets the length constraints for the text input.

Parameters

Parameter	Type	Description
options	Partial<OptionValuesLength>	The length constraints.

Returns

this

The current TextInput instance.

Source

seyfert/src/builders/Modal.ts:157

---

setPlaceholder()

setPlaceholder(placeholder: string): this

Sets the placeholder of the text input.

Parameters

Parameter	Type	Description
placeholder	string	The placeholder text.

Returns

this

The current TextInput instance.

Source

seyfert/src/builders/Modal.ts:147

---

setRequired()

setRequired(required: boolean): this

Sets whether the text input is required.

Parameters

Parameter	Type	Default value	Description
required	boolean	true	Indicates whether the text input is required.

Returns

this

The current TextInput instance.

Source

seyfert/src/builders/Modal.ts:188

---

setStyle()

setStyle(style: TextInputStyle): this

Sets the style of the text input.

Parameters

Parameter	Type	Description
style	TextInputStyle	The style of the text input.

Returns

this

The current TextInput instance.

Source

seyfert/src/builders/Modal.ts:127

---

setValue()

setValue(value: string): this

Sets the initial value of the text input.

Parameters

Parameter	Type	Description
value	string	The initial value.

Returns

this

The current TextInput instance.

Source

seyfert/src/builders/Modal.ts:178

---

toJSON()

toJSON(): APITextInputComponent

Returns

APITextInputComponent

Inherited from

BaseComponentBuilder.toJSON

Source

seyfert/src/builders/Base.ts:8