TextInputBuilder

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

No summary provided.

Extends

ComponentBuilder<APITextInputComponent>

Implements

Equatable<JSONEncodable<APITextInputComponent> | APITextInputComponent>
constructor(data?)
Constructs a new instance of the TextInputBuilder class
NameTypeOptionalDescription
dataAPITextInputComponent & { type?: ComponentType.TextInput; }YesNone
Readonly
data:Partial<DataType>
The API data associated with this component
Inherited from ComponentBuilder
equals(other):boolean
Whether or not this is equal to another structure
NameTypeOptionalDescription
otherJSONEncodable<APITextInputComponent> | APITextInputComponentNoNone
setCustomId(customId):this
Sets the custom id for this text input
NameTypeOptionalDescription
customIdstringNoThe custom id of this text input
setLabel(label):this
Sets the label for this text input
NameTypeOptionalDescription
labelstringNoThe label for this text input
setMaxLength(maxLength):this
Sets the maximum length of text for this text input
NameTypeOptionalDescription
maxLengthnumberNoThe maximum length of text for this text input
setMinLength(minLength):this
Sets the minimum length of text for this text input
NameTypeOptionalDescription
minLengthnumberNoThe minimum length of text for this text input
setPlaceholder(placeholder):this
Sets the placeholder of this text input
NameTypeOptionalDescription
placeholderstringNoThe placeholder of this text input
setRequired(required?):this
Sets whether this text input is required
NameTypeOptionalDescription
requiredbooleanYesWhether this text input is required
setStyle(style):this
Sets the style for this text input
NameTypeOptionalDescription
styleTextInputStyleNoThe style for this text input
setValue(value):this
Sets the value of this text input
NameTypeOptionalDescription
valuestringNoThe value for this text input
Serializes this component to an API-compatible JSON object
Remarks
This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.