discord.js | ActionRowBuilder

Search...

ActionRowBuilder

export class ActionRowBuilder<T extends AnyComponentBuilder = AnyComponentBuilder> extends BuilderActionRow<T>

export class ActionRowBuilder<T extends AnyComponentBuilder = AnyComponentBuilder> extends BuilderActionRow<T>

Represents an action row builder.

Name	Constraints	Optional	Default	Description
T	AnyComponentBuilder	Yes	AnyComponentBuilder	None

constructor(data?)

Constructs a new instance of the ActionRowBuilder class

Name	Type	Optional	Description
data	Partial< \| ActionRowData<ActionRowComponentData \| JSONEncodable<APIActionRowComponentTypes>> \| APIActionRowComponent<APIMessageActionRowComponent \| APIModalActionRowComponent> >	Yes	None

Readonly

components:T[]

The components within this action row.

Readonly

data:Partial<DataType>

The API data associated with this component.

addComponents(...components):this

Adds components to this action row.

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

Static

Creates a new action row builder from JSON data

Name	Type	Optional	Description
other	\| JSONEncodable<APIActionRowComponent<ReturnType<T['toJSON']>>> \| APIActionRowComponent<ReturnType<T['toJSON']>>	No	The other data

setComponents(...components):this

Sets components for this action row.

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

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

Serializes this builder to API-compatible JSON data.

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