Version: Next

APIContainerComponent

A Container is a top-level layout component that holds up to 10 components. Containers are visually distinct from surrounding components and has an optional customizable color bar.

Containers are only available in messages.

@see: https://discord.com/developers/docs/components/reference#container

Hierarchy

APIBaseComponent<ComponentType.Container>
- APIContainerComponent

Index

Properties

optionalaccent_color

accent_color?: null | number

Color for the accent on the container as RGB from 0x000000 to 0xFFFFFF

components

components: APIComponentInContainer[]

Up to 10 components of the type action row, text display, section, media gallery, separator, or file

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.

optionalspoiler

spoiler?: boolean

Whether the container should be a spoiler (or blurred out)

@defaultValue: false

inheritedtype

type: Container

The type of the component