TextInput
Extends
Constructors
Constructor
new TextInput(
data?):TextInput
Parameters
| Parameter | Type |
|---|---|
data? | { additionalData: ComponentAdditionalData; } |
data.additionalData? | ComponentAdditionalData |
Returns
TextInput
Inherited from
BaseModalComponent.constructor
Properties
| Property | Modifier | Type | Default value | Description | Overrides | Inherited from |
|---|---|---|---|---|---|---|
additionalData | public | null | ComponentAdditionalData | null | - | - | BaseModalComponent.additionalData |
customId | abstract | string | undefined | The custom ID of the text input | BaseModalComponent.customId | - |
id? | public | number | undefined | 32 bit integer used as an optional identifier for component The id field is optional and is used to identify components in the response from an interaction that aren't interactive components. The id must be unique within the message and is generated sequentially by Discord if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component. | - | BaseModalComponent.id |
isV2 | readonly | false | false | Whether the component is a v2 component and requires the IS_COMPONENTS_V2 flag | BaseModalComponent.isV2 | - |
label | abstract | string | undefined | The label of the text input | - | - |
maxLength? | public | number | undefined | The maximum length of the text input | - | - |
minLength? | public | number | undefined | The minimum length of the text input | - | - |
placeholder? | public | string | undefined | The placeholder of the text input | - | - |
required? | public | boolean | undefined | Whether the text input is required | - | - |
style | public | TextInputStyle | TextInputStyle.Short | The style of the text input Default TextInputStyle.Short | - | - |
type | readonly | TextInput | undefined | The type of the component | BaseModalComponent.type | - |
value? | public | string | undefined | The value of the text input | - | - |
Methods
createId()
createId(
additionalData):string
Create a custom ID to use for this component that embeds additional data that you want to be handed
Parameters
| Parameter | Type | Description |
|---|---|---|
additionalData | null | ComponentAdditionalData | The additional data that you want to be passed in this component's custom ID |
Returns
string
The custom ID to use
Inherited from
serialize()
serialize():
APITextInputComponent
Returns
APITextInputComponent
Overrides
BaseModalComponent.serialize