Preview environment

interface APILabelComponent

external
export interface APILabelComponent extends APIBaseComponent<ComponentType.Label>

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

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

external
component : APIComponentInLabel

The component within the label

optionalexternal
description? : string

An optional description text for the label; max 100 characters

optionalexternal
id? : number

32 bit integer used as an optional identifier for componentThe 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.

Inherited from: APIBaseComponent

external
label : string

The label text; max 45 characters

external
type : T

The type of the component

Inherited from: APIBaseComponent