APIRadioGroupComponent

@see

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

@unstable

This component is not publicly released and is currently in preview.

Hierarchy

• APIBaseComponent<ComponentType.RadioGroup>
  • APIRadioGroupComponent

Index

Properties

• custom_id
• id
• options
• required
• type

Properties

custom_id

custom_id: string

Id for the radio group; max 100 characters

optionalinheritedid

id?: number

Inherited from APIBaseComponent.id

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.

options

options: APIRadioGroupOption[]

2-10 radio group options within the radio group component

optionalrequired

required?: boolean

Whether the radio group requires selection before submitting the modal

@defaultValue

true

inheritedtype

type: RadioGroup

Inherited from APIBaseComponent.type

The type of the component