Version: Next

APICheckboxGroupComponent

@see: https://discord.com/developers/docs/components/reference#checkbox-group
@unstable: This component is not publicly released and is currently in preview.

Hierarchy

APIBaseComponent<ComponentType.CheckboxGroup>
- APICheckboxGroupComponent

Index

Properties

custom_id
id
max_values
min_values
options
required
type

Properties

custom_id

custom_id: string

Id for the checkbox group; max 100 characters

optionalinheritedid

id?: number

32 bit integer used as an optional identifier for component

The id field is optional and is used to identify components in the response from an interaction that aren't interactive components. The id must be unique within the message and is generated sequentially if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component.

optionalmax_values

max_values?: number

Maximum number of checkbox that can be selected; min 1, max 10

@defaultValue: APICheckboxGroupComponent.options length

optionalmin_values

min_values?: number

Minimum number of checkbox that can be selected; min 0, max 10

@defaultValue: 1

options

options: APICheckboxGroupOption[]

Checkbox group option within the component; max 10

optionalrequired

required?: boolean

Whether selecting within the group is required before submitting the modal

@defaultValue: true

inheritedtype

type: CheckboxGroup

The type of the component