APILabelComponent

A Label is a top-level layout component. Labels wrap modal components with text as a label and optional description.

@see

https://discord.com/developers/docs/components/reference#label

Hierarchy

• APIBaseComponent<ComponentType.Label>
  • APILabelComponent

Index

Properties

• component
• description
• id
• label
• type

Properties

component

component: APIComponentInLabel

The component within the label

optionaldescription

description?: string

An optional description text for the label; 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.

label

label: string

The label text; max 45 characters

inheritedtype

type: Label

Inherited from APIBaseComponent.type

The type of the component