discord.js | ContainerBuilder

Search...

ContainerBuilder

export declare class ContainerBuilder extends ComponentBuilder<APIContainerComponent>

export declare class ContainerBuilder extends ComponentBuilder<APIContainerComponent>

No summary provided.

Extends

ComponentBuilder<APIContainerComponent>

constructor({ components, ...rest }?)

Constructs a new instance of the ContainerBuilder class

Name	Type	Optional	Description
{ components, ...rest }	Partial<APIContainerComponent>	Yes	None

ProtectedReadonly

data:ContainerBuilderData

addActionRowComponents(...input):this

Adds action row components to this container.

Name	Type	Optional	Description
...input	RestOrArray<ActionRowBuilder \| APIActionRowComponent<APIComponentInMessageActionRow> \| ((builder: ActionRowBuilder) => ActionRowBuilder)>	No	The action row to add

addFileComponents(...input):this

Adds file components to this container.

Name	Type	Optional	Description
...input	RestOrArray<APIFileComponent \| FileBuilder \| ((builder: FileBuilder) => FileBuilder)>	No	The file components to add

addMediaGalleryComponents(...input):this

Adds media gallery components to this container.

Name	Type	Optional	Description
...input	RestOrArray<APIMediaGalleryComponent \| MediaGalleryBuilder \| ((builder: MediaGalleryBuilder) => MediaGalleryBuilder)>	No	The media gallery components to add

addSectionComponents(...input):this

Adds section components to this container.

Name	Type	Optional	Description
...input	RestOrArray<APISectionComponent \| SectionBuilder \| ((builder: SectionBuilder) => SectionBuilder)>	No	The section components to add

addSeparatorComponents(...input):this

Adds separator components to this container.

Name	Type	Optional	Description
...input	RestOrArray<APISeparatorComponent \| SeparatorBuilder \| ((builder: SeparatorBuilder) => SeparatorBuilder)>	No	The separator components to add

addTextDisplayComponents(...input):this

Adds text display components to this container.

Name	Type	Optional	Description
...input	RestOrArray<APITextDisplayComponent \| TextDisplayBuilder \| ((builder: TextDisplayBuilder) => TextDisplayBuilder)>	No	The text display components to add

clearAccentColor():this

Clears the accent color of this container.

clearId():this

Clears the id of this component, defaulting to a default incremented id.

Inherited from ComponentBuilder

setAccentColor(color):this

Sets the accent color of this container.

Name	Type	Optional	Description
color	number	No	The color to use

setId(id):this

Sets the id of this component.

Name	Type	Optional	Description
id	number	No	The id to use

Inherited from ComponentBuilder

setSpoiler(spoiler?):this

Sets the spoiler status of this container.

Name	Type	Optional	Description
spoiler	boolean	Yes	The spoiler status to use

spliceComponents(index, deleteCount, ...components):this

Removes, replaces, or inserts components for this container

Remarks

This method behaves similarly to Array.prototype.splice().It's useful for modifying and adjusting order of the already-existing components of a container.

Example

Remove the first component:

container.spliceComponents(0, 1);

container.spliceComponents(0, 1);

Example

Remove the first n components:

const n = 4;
container.spliceComponents(0, n);

const n = 4;
container.spliceComponents(0, n);

Example

Remove the last component:

container.spliceComponents(-1, 1);

container.spliceComponents(-1, 1);

Name	Type	Optional	Description
index	number	No	The index to start at
deleteCount	number	No	The number of components to remove
...components	RestOrArray<APIComponentInContainer \| ContainerComponentBuilders>	No	The replacing component objects

toJSON(validationOverride?):APIContainerComponent

Serializes this builder to API-compatible JSON data.Note that by disabling validation, there is no guarantee that the resulting object will be valid.

Name	Type	Optional	Description
validationOverride	boolean	Yes	Force validation to run/not run regardless of your global preference