DiscordPHP Documentation

TextInput extends Interactive

in package

• Application

Text inputs are an interactive component that render on modals. They can be used to collect short-form or long-form text.

Tags

link

https://discord.com/developers/docs/interactions/message-components#text-inputs

since

7.0.0

@property

?int|null $min_length Minimum input length for a text input; min 0, max 4000.

@property

?int|null $max_length Maximum input length for a text input; min 1, max 4000.

@property

?bool|null $required Whether this component is required to be filled (defaults to true).

@property

?string|null $value Pre-filled value for this component; max 4000 characters.

@property

?string|null $placeholder Custom placeholder text if the input is empty; max 100 characters.

Table of Contents

Constants

STYLE_PARAGRAPH  = 2

Multi-line input.

STYLE_SHORT  = 1

Single-line input.

TYPE_ACTION_ROW  = 1

Container to display a row of interactive components.

TYPE_BUTTON  = 2

Button object.

TYPE_CHANNEL_SELECT  = 8

Select menu for channels.

TYPE_CHECKPOINT_CARD  = 20

Undocumented.

TYPE_CONTAINER  = 17

Container that visually groups a set of components.

TYPE_CONTENT_INVENTORY_ENTRY  = 16

Undocumented.

TYPE_FILE  = 13

Displays an attached file.

TYPE_FILE_UPLOAD  = 19

Component for uploading files.

TYPE_LABEL  = 18

Container associating a label and description with a component.

TYPE_MEDIA_GALLERY  = 12

Display images and other media.

TYPE_MENTIONABLE_SELECT  = 7

Select menu for mentionables (users and roles).

TYPE_ROLE_SELECT  = 6

Select menu for roles.

TYPE_SECTION  = 9

Container to display text alongside an accessory component.

TYPE_SELECT_MENU  = 3

TYPE_SEPARATOR  = 14

Component to add vertical padding between other components.

TYPE_STRING_SELECT  = 3

Select menu for picking from defined text options.

TYPE_TEXT_DISPLAY  = 10

Markdown text.

TYPE_TEXT_INPUT  = 4

Text input object.

TYPE_THUMBNAIL  = 11

Small image that can be used as an accessory.

TYPE_USER_SELECT  = 5

Select menu for users.

USAGE  = ['Message', 'Modal']

Properties

$custom_id  : string

Custom ID to send with interactive component.

$id  : int|null

32 bit integer used as an optional identifier for component.

$label  : string|null

Label for the text input.

$max_length  : int|null

Maximum input length for a text input, min 1, max 4000.

$min_length  : int|null

Minimum input length for a text input, min 0, max 4000.

$placeholder  : string|null

Placeholder string to display if text input is empty. Maximum 100 characters.

$required  : bool|null

Whether the text input is required.

$style  : int

Style of text input.

$type  : int

Component type.

$value  : string|null

Pre-filled value for text input. Max 4000 characters.

Methods

__construct()  : mixed

Creates a new text input.

__get()  : mixed

Handles dynamic get calls onto the part.

__set()  : void

Handles dynamic set calls onto the part.

fromPart()  : self

Creates a new instance of the builder from a given Part.

getCustomId()  : string

Returns the Custom ID of the text input.

getMaxLength()  : int|null

Returns the maximum length of the text input.

getMinLength()  : int|null

Returns the minimum length of the text input.

getPlaceholder()  : string|null

Returns the placeholder string of the text input.

getType()  : int

Retrieves the type of the component.

isRequired()  : bool|null

Returns whether the text input is disabled.

jsonSerialize()  : array<string|int, mixed>

new()  : self

Creates a new text input.

setCustomId()  : $this

Sets the custom ID for the interactive component.

setLabel()  : $this

Sets the label of the text input.

setMaxLength()  : $this

Sets the maximum input length for a text input.

setMinLength()  : $this

Sets the minimum input length for a text input.

setPlaceholder()  : $this

Sets the placeholder string to display if text input is empty.

setRequired()  : $this

Set if this component is required to be filled (defaults to true).

setStyle()  : $this

Sets the style of the text input.

setValue()  : $this

Sets a pre-filled value for the text input.

checkForGetMutator()  : string|false

Checks if there is a get mutator present.

checkForSetMutator()  : string|false

Checks if there is a set mutator present.

generateUuid()  : string

Generates a UUID which can be used for component custom IDs.

getId()  : int|null

Retrieves the ID associated with the interactive component.

getProperty()  : mixed

Gets a property on the parent part.

setId()  : self

The id field is optional and is used to identify components in the response from an interaction. The id must be unique within the message and is generated sequentially if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component. Sending components with an id of 0 is allowed but will be treated as empty and replaced by the API. 32 bit integer used as an optional identifier for component.

setProperty()  : void

Sets an property on the parent part.

studly()  : string

Converts a string to studlyCase.