Class Container

Represents a container component builder. Containers group other components together.

Example

const container = new Container()
 .addComponents(
     new TextDisplay('This is text inside a container!'),
     new ActionRow().addComponents(new Button().setLabel('Click me!'))
 )
 .setColor('Blue');

Hierarchy (View Summary)

BaseComponentBuilder<APIContainerComponent>
- Container

Index

Constructors

constructor

new Container(data?: Partial<APIContainerComponent>): Container
Constructs a new Container.
Parameters
- data: Partial<APIContainerComponent> = {}
  Optional initial data for the container.
Returns Container
Overrides BaseComponentBuilder.constructor
- Defined in src/builders/Container.ts:39

Properties

components

components: ContainerBuilderComponents[]

The components held within this container.

data

data: Partial<TYPE> = {}

Methods

addComponents

addComponents(...components: RestOrArray<ContainerBuilderComponents>): Container
Adds components to the container.
Parameters
- ...components: RestOrArray<ContainerBuilderComponents>
  The components to add. Can be a single component, an array of components, or multiple components as arguments.
Returns Container
The updated Container instance.
- Defined in src/builders/Container.ts:49

setColor

setColor(color: ColorResolvable): Container
Sets the accent color for the container.
Parameters
- color: ColorResolvable
  The color resolvable (e.g., hex code, color name, integer).
Returns Container
The updated Container instance.
- Defined in src/builders/Container.ts:79

setComponents

setComponents(...components: RestOrArray<ContainerBuilderComponents>): Container
Sets the components for the container, replacing any existing components.
Parameters
- ...components: RestOrArray<ContainerBuilderComponents>
  The components to set. Can be a single component, an array of components, or multiple components as arguments.
Returns Container
The updated Container instance.
- Defined in src/builders/Container.ts:59

setId

setId(id: number): Container
Sets the ID for the container.
Parameters
- id: number
  The ID to set.
Returns Container
The updated Container instance.
- Defined in src/builders/Container.ts:89

setSpoiler

setSpoiler(spoiler?: boolean): Container
Sets whether the container's content should be visually marked as a spoiler.
Parameters
- spoiler: boolean = true
  Whether the content is a spoiler (defaults to true).
Returns Container
The updated Container instance.
- Defined in src/builders/Container.ts:69

toJSON

toJSON(): APIContainerComponent
Returns APIContainerComponent
Overrides BaseComponentBuilder.toJSON
- Defined in src/builders/Container.ts:94

Class Container

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Container

Properties

components

data

Methods

addComponents

Parameters

Returns Container

setColor

Parameters

Returns Container

setComponents

Parameters

Returns Container

setId

Parameters

Returns Container

setSpoiler

Parameters

Returns Container

toJSON

Returns APIContainerComponent

Settings

On This Page