kord-extensions/dev.kordex.core.components.forms.widgets/TextInputWidget

TextInputWidget

abstract class TextInputWidget<T : TextInputWidget<T>> : Widget<String?> , KordExKoinComponent

An abstract type representing a widget that accepts text from the user.

Inheritors

LineTextWidget

ParagraphTextWidget

Constructors

TextInputWidget

constructor()

Properties

height

open override var height: Int

How tall this widget is, in grid cells.

var id: String

The widget's unique ID on Discord, defaulting to a UUID.

initialValue

var initialValue: Key?

The initial value to provide for this widget, if any.

label

lateinit var label: Key

The widget's label, to be shown on Discord.

maxLength

var maxLength: Int

The maximum number of characters that may be provided.

minLength

var minLength: Int

The minimum number of characters that may be provided.

placeholder

var placeholder: Key?

Placeholder text, to be shown to the user on Discord.

required

var required: Boolean

Whether this widget must be filled out for the form to be valid.

style

abstract val style: TextInputStyle

The TextInputStyle, to be provided by a subtype.

translateInitialValue

var translateInitialValue: Boolean

Whether to translate the initialValue.

value

open override var value: String?

The final value stored in this widget, as provided by the user.

width

open override var width: Int

How wide this widget is, in grid cells.

Functions

apply

open suspend override fun apply(builder: ActionRowBuilder, locale: Locale)

Function called to apply this widget to a Discord action row.

getKoin

open override fun getKoin(): Koin

Get the associated Koin instance.

toString

open override fun toString(): String

validate

open override fun validate()

Function called to ensure that this widget was set up correctly.