CheckboxWidget

A checkbox widget that supports a single checkbox.

Constructors

constructor()

Whether the checkbox is selected by default.

open override var description: Key?

An optional description for the Widget. Displayed on Discord.

open override var height: Int

How tall this component is, in grid cells.

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

open lateinit override var label: Key

The Widget's label, displayed on Discord.

open override var value: Boolean?

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

open override var width: Int

How wide this component is, in grid cells.

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

suspend override fun apply(builder: ModalBuilder, locale: Locale)

Function called to apply this component to a Discord form.

open override fun getKoin(): Koin

Get the associated Koin instance.

open override fun toString(): String

open override fun validate()

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