Carbon
Core/Classes

TextInput

Extends

Constructors

Constructor

new TextInput(): TextInput

Returns

TextInput

Inherited from

BaseModalComponent.constructor

Properties

PropertyModifierTypeDefault valueDescriptionOverridesInherited from
customIdabstractstringundefinedThe custom ID of the text inputBaseModalComponent.customId-
customIdParserpublic(id) => ComponentParserResultundefinedThis function is called by the handler when a component is received, and is used to parse the custom ID into a key and data object. By default, the ID is parsed in this format: key:arg1=true;arg2=2;arg3=cheese, where arg1, arg2, and arg3 are the data arguments. It will also automatically parse true and false as booleans, and will parse numbers as numbers. You can override this to parse the ID in a different format as you see fit, but it must follow these rules: - The ID must have a key somewhere in the ID that can be returned by the parser. This key is what Carbon's component handler will use to identify the component and pass an interaction to the correct component. - The data must be able to be arbitrary as far as Carbon's handler is concerned, meaning that any component with the same base key can be treated as the same component with logic within the component's logic methods to handle the data.-BaseModalComponent.customIdParser
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

serialize()

serialize(): APITextInputComponent

Returns

APITextInputComponent

Overrides

BaseModalComponent.serialize

On this page