kord-extensions/dev.kordex.core.components.forms.widgets.menus/StringSelectMenuWidget

StringSelectMenuWidget

class StringSelectMenuWidget : SelectMenuWidget<String, StringSelectMenuWidget> , StringSelectMenu

A select widget that supports strings as options.

Constructors

constructor()

Properties

description

open override var description: Key?

An optional description for the Widget. Displayed on Discord.

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.

label

open lateinit override var label: Key

The Widget's label, displayed on Discord.

maxValues

var maxValues: Int

The maximum number of items that can be chosen. Default: 1.

minValues

var minValues: Int

The minimum number of items that must be chosen. Default: 1.

options

open override val options: MutableList<SelectOptionBuilder>

Specified choices in a select menu.

placeholder

var placeholder: Key?

Placeholder text if nothing is selected, 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.

value

open override var value: List<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: LabelComponentBuilder, locale: Locale)

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

applyStringSelectMenu

open fun applyStringSelectMenu(selectMenu: SelectMenu<*, *>, builder: ActionRowBuilder)

Apply the string select menu to an action row builder.

getKoin

open override fun getKoin(): Koin

Get the associated Koin instance.

option

open suspend fun option(label: Key, value: String, body: suspend StringSelectOption.() -> Unit = {})

Add an option to this select menu.

toString

open override fun toString(): String

validate

open override fun validate()

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

validateOptions

open fun validateOptions()

Validate the options of the string select menu.