Carbon
Core/Classes

TextInput

Extends

Constructors

Constructor

new TextInput(data?): TextInput

Parameters

ParameterType
data?{ additionalData: ComponentAdditionalData; }
data.additionalData?ComponentAdditionalData

Returns

TextInput

Inherited from

BaseModalComponent.constructor

Properties

PropertyModifierTypeDefault valueDescriptionOverridesInherited from
additionalDatapublicnull | ComponentAdditionalDatanull--BaseModalComponent.additionalData
customIdabstractstringundefinedThe custom ID of the text inputBaseModalComponent.customId-
id?publicnumberundefined32 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
isV2readonlyfalsefalseWhether the component is a v2 component and requires the IS_COMPONENTS_V2 flagBaseModalComponent.isV2-
labelabstractstringundefinedThe label of the text input--
maxLength?publicnumberundefinedThe maximum length of the text input--
minLength?publicnumberundefinedThe minimum length of the text input--
placeholder?publicstringundefinedThe placeholder of the text input--
required?publicbooleanundefinedWhether the text input is required--
stylepublicTextInputStyleTextInputStyle.ShortThe style of the text input Default TextInputStyle.Short--
typereadonlyTextInputundefinedThe type of the componentBaseModalComponent.type-
value?publicstringundefinedThe 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

ParameterTypeDescription
additionalDatanull | ComponentAdditionalDataThe additional data that you want to be passed in this component's custom ID

Returns

string

The custom ID to use

Inherited from

BaseModalComponent.createId


serialize()

serialize(): APITextInputComponent

Returns

APITextInputComponent

Overrides

BaseModalComponent.serialize

On this page