Version: Next

APICheckboxComponent

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

Hierarchy

APIBaseComponent<ComponentType.Checkbox>
- APICheckboxComponent

Index

Properties

custom_id
default
id
type

Properties

custom_id

custom_id: string

Id for the checkbox; max 100 characters

optionaldefault

default?: boolean

Whether this checkbox is selected by default

@defaultValue: false

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.

inheritedtype

type: Checkbox

The type of the component