Skip to main content

DiscordCheckboxGroupComponent

Documentation

Documentation / @discordeno/types / DiscordCheckboxGroupComponent

Interface: DiscordCheckboxGroupComponent

Defined in: discord/components.ts:823

https://docs.discord.com/developers/components/reference#checkbox-group-structure

Extends​

Properties​

custom_id​

custom_id: string

Defined in: discord/components.ts:826

A dev-defined unique string for the component; 1-100 characters.

id?​

optional id?: number

Defined in: discord/components.ts:100

32 bit integer used as an optional identifier for component

Inherited from​

DiscordBaseComponent.id

max_values?​

optional max_values?: number

Defined in: discord/components.ts:832

Maximum number of items that can be chosen; min 1, max 10. Defaults to the number of options.

min_values?​

optional min_values?: number

Defined in: discord/components.ts:830

Minimum number of items that must be chosen; min 0, max 10. Defaults to 1; if set to 0 required must be false.

options​

options: DiscordCheckboxGroupOption[]

Defined in: discord/components.ts:828

List of options to show; min 1, max 10.

required?​

optional required?: boolean

Defined in: discord/components.ts:834

Whether selecting within the group is required. Defaults to true.

type​

type: CheckboxGroup

Defined in: discord/components.ts:824

The type of the component

Overrides​

DiscordBaseComponent.type