discord.js | ContainerBuilder

Search...

ContainerBuilder

export declare class ContainerBuilder extends ComponentBuilder<APIContainerComponent>

export declare class ContainerBuilder extends ComponentBuilder<APIContainerComponent>

A builder that creates API-compatible JSON data for a container.

Extends

ComponentBuilder<APIContainerComponent>

constructor(data?)

Creates a new container from API data.

Example

Creating a container from an API data object:

const container = new ContainerBuilder({
	components: [
		{
			content: "Some text here",
			type: ComponentType.TextDisplay,
		},
	],
});

const container = new ContainerBuilder({
	components: [
		{
			content: "Some text here",
			type: ComponentType.TextDisplay,
		},
	],
});

Example

Creating a container using setters and API data:

const container = new ContainerBuilder({
	components: [
		{
			content: "# Heading",
			type: ComponentType.TextDisplay,
		},
	],
})
	.addComponents(separator, section);

const container = new ContainerBuilder({
	components: [
		{
			content: "# Heading",
			type: ComponentType.TextDisplay,
		},
	],
})
	.addComponents(separator, section);

Name	Type	Optional	Description
data	Partial<APIContainerComponent>	Yes	The API data to create this container with

Readonly

components:ContainerComponentBuilder[]

The components within this container.

Readonly

data:Partial<APIContainerComponent>

The API data associated with this component.

Inherited from ComponentBuilder

addActionRowComponents(...components):this

Adds action row components to this container.

Name	Constraints	Optional	Default	Description
ComponentType	MessageActionRowComponentBuilder	No		None

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

addFileComponents(...components):this

Adds file components to this container.

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

addMediaGalleryComponents(...components):this

Adds media gallery components to this container.

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

addSectionComponents(...components):this

Adds section components to this container.

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

addSeparatorComponents(...components):this

Adds separator components to this container.

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

addTextDisplayComponents(...components):this

Adds text display components to this container.

Name	Type	Optional	Description
...components	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	RGBTuple \| number	Yes	The color to use

setId(id):this

Sets the id (not the custom id) for this component.

Name	Type	Optional	Description
id	number	No	The id for this component

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.

Name	Type	Optional	Description
index	number	No	The index to start removing, replacing or inserting components
deleteCount	number	No	The amount of components to remove
...components	RestOrArray<APIComponentInContainer \| ContainerComponentBuilder>	No	The components to set

toJSON():APIContainerComponent

Serializes this builder to API-compatible JSON data.

Remarks

This method runs validations on the data before serializing it. As such, it may throw an error if the data is invalid.