CheckboxOptions

interface CheckboxOptions

Options for a single checkbox component.

exported from lib.weeble.d

Properties

Property

Type

Description

checked?

boolean

Indicates whether the checkbox is pre-checked.

customId?

string

Custom ID for a standalone checkbox, or value for a checkbox group option.

default?

boolean

Indicates whether the checkbox is pre-checked.

description?

string

Description shown below the label.

emoji?

EmojiData

Optional emoji shown next to the label.

label?

string

Label displayed next to the checkbox. Required for checkbox group options; standalone checkboxes can fall back to customId.

required?

boolean

Indicates whether this checkbox must be checked.

value?

string

Value for a checkbox group option.