Skip to main content

CheckboxGroupComponent

Documentation

Documentation / @discordeno/types / CheckboxGroupComponent

Interface: CheckboxGroupComponent

Defined in: discordeno/components.ts:503

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

Extends​

Properties​

customId​

customId: string

Defined in: discordeno/components.ts:506

A custom identifier for this component. Maximum 100 characters.

id?​

optional id?: number

Defined in: discordeno/components.ts:42

32 bit integer used as an optional identifier for component

Inherited from​

BaseComponent.id

maxValues?​

optional maxValues?: number

Defined in: discordeno/components.ts:512

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

minValues?​

optional minValues?: number

Defined in: discordeno/components.ts:510

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: CheckboxGroupOption[]

Defined in: discordeno/components.ts:508

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

required?​

optional required?: boolean

Defined in: discordeno/components.ts:514

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

type​

type: CheckboxGroup

Defined in: discordeno/components.ts:504

The type of the component

Overrides​

BaseComponent.type