class ActionRowBuilder

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

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

components
data
addComponents
clearId
setComponents
setId
toJSON

Constructors

constructor(
data?: Partial<APIActionRowComponent<APIComponentInActionRow>>
)

Creates a new action row from API data.

Examples: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,
		},
	],
});
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);

Type Parameters

ComponentType extends AnyComponentBuilder

The types of components this action row holds

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: RestOrArray<ComponentType>
) : this

Adds components to this action row.

clearId() : this

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

Inherited from: ComponentBuilder

setComponents(
...components: RestOrArray<ComponentType>
) : this

Sets components for this action row.

setId(
id: number
) : this

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

Inherited from: ComponentBuilder

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

Serializes this builder to API-compatible JSON data.