Class ActionRowBuilder<ComponentType>

constructor

• new ActionRowBuilder<ComponentType extends AnyComponentBuilder>(
      data?: Partial<APIActionRowComponent<APIComponentInActionRow>>,
  ): ActionRowBuilder<ComponentType>

  Creates a new action row from API data.

  Type Parameters

  • ComponentType extends AnyComponentBuilder

  Parameters

  • Optionaldata: Partial<APIActionRowComponent<APIComponentInActionRow>>

    The API data to create this action row with

  Returns ActionRowBuilder<ComponentType>

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

  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);
  Copy

Readonlycomponents

addComponents

• addComponents(...components: RestOrArray<ComponentType>): this

  Adds components to this action row.

  Parameters

  • ...components: RestOrArray<ComponentType>

    The components to add

  Returns this

setComponents

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

  Sets components for this action row.

  Parameters

  • ...components: RestOrArray<ComponentType>

    The components to set

  Returns this

toJSON

• toJSON(): APIActionRowComponent<ReturnType<ComponentType["toJSON"]>>

  Serializes this builder to API-compatible JSON data.

  Returns APIActionRowComponent<ReturnType<ComponentType["toJSON"]>>

  Remarks

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