discord.js | ActionRowBuilder

Search...

ActionRowBuilder

export declare class ActionRowBuilder<ComponentType extends AnyComponentBuilder> extends ComponentBuilder<APIActionRowComponent<APIComponentInMessageActionRow | APIComponentInModalActionRow>>

export declare class ActionRowBuilder<ComponentType extends AnyComponentBuilder> extends ComponentBuilder<APIActionRowComponent<APIComponentInMessageActionRow | APIComponentInModalActionRow>>

A builder that creates API-compatible JSON data for action rows.

Extends

ComponentBuilder<APIActionRowComponent<APIComponentInMessageActionRow | APIComponentInModalActionRow>>

Name	Constraints	Optional	Default	Description
ComponentType	AnyComponentBuilder	No		The types of components this action row holds

constructor(data?)

Creates a new action row from API data.

Example

Creating an action row from an API data object:

const actionRow = new ActionRowBuilder({
	components: [
		{
			custom_id: "custom id",
			label: "Type something",
			style: TextInputStyle.Short,
			type: ComponentType.TextInput,
		},
	],
});

const actionRow = new ActionRowBuilder({
	components: [
		{
			custom_id: "custom id",
			label: "Type something",
			style: TextInputStyle.Short,
			type: ComponentType.TextInput,
		},
	],
});

Example

Creating an action row using setters and API data:

const actionRow = new ActionRowBuilder({
	components: [
		{
			custom_id: "custom id",
			label: "Click me",
			style: ButtonStyle.Primary,
			type: ComponentType.Button,
		},
	],
})
	.addComponents(button2, button3);

const actionRow = new ActionRowBuilder({
	components: [
		{
			custom_id: "custom id",
			label: "Click me",
			style: ButtonStyle.Primary,
			type: ComponentType.Button,
		},
	],
})
	.addComponents(button2, button3);

Name	Type	Optional	Description
data	Partial<APIActionRowComponent<APIComponentInActionRow>>	Yes	The API data to create this action row with

Readonly

components:ComponentType[]

The components within this action row.

Readonly

data:Partial<APIActionRowComponent>

The API data associated with this component.

Inherited from ComponentBuilder

addComponents(...components):this

Adds components to this action row.

Name	Type	Optional	Description
...components	RestOrArray<ComponentType>	No	The components to add

clearId():this

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

Inherited from ComponentBuilder

setComponents(...components):this

Sets components for this action row.

Name	Type	Optional	Description
...components	RestOrArray<ComponentType>	No	The components to set

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

toJSON():APIActionRowComponent<ReturnType<ComponentType['toJSON']>>

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.