discord.js | ButtonBuilder

Search...

ButtonBuilder

export declare class ButtonBuilder extends ComponentBuilder<APIButtonComponent>

export declare class ButtonBuilder extends ComponentBuilder<APIButtonComponent>

A builder that creates API-compatible JSON data for buttons.

Extends

ComponentBuilder<APIButtonComponent>

constructor(data?)

Creates a new button from API data.

Example

Creating a button from an API data object:

const button = new ButtonBuilder({
	custom_id: 'a cool button',
	style: ButtonStyle.Primary,
	label: 'Click Me',
	emoji: {
		name: 'smile',
		id: '123456789012345678',
	},
});

const button = new ButtonBuilder({
	custom_id: 'a cool button',
	style: ButtonStyle.Primary,
	label: 'Click Me',
	emoji: {
		name: 'smile',
		id: '123456789012345678',
	},
});

Example

Creating a button using setters and API data:

const button = new ButtonBuilder({
	style: ButtonStyle.Secondary,
	label: 'Click Me',
})
	.setEmoji({ name: '🙂' })
	.setCustomId('another cool button');

const button = new ButtonBuilder({
	style: ButtonStyle.Secondary,
	label: 'Click Me',
})
	.setEmoji({ name: '🙂' })
	.setCustomId('another cool button');

Name	Type	Optional	Description
data	Partial<APIButtonComponent>	Yes	The API data to create this button with

Readonly

data:Partial<APIButtonComponent>

The API data associated with this component.

Inherited from ComponentBuilder

setCustomId(customId):this

Sets the custom id for this button.

Remarks

This method is only applicable to buttons that are not using the Link button style.

Name	Type	Optional	Description
customId	string	No	The custom id to use

setDisabled(disabled?):this

Sets whether this button is disabled.

Name	Type	Optional	Description
disabled	boolean	Yes	Whether to disable this button

setEmoji(emoji):this

Sets the emoji to display on this button.

Name	Type	Optional	Description
emoji	APIMessageComponentEmoji	No	The emoji to use

setLabel(label):this

Sets the label for this button.

Name	Type	Optional	Description
label	string	No	The label to use

setSKUId(skuId):this

Sets the SKU id that represents a purchasable SKU for this button.

Remarks

Only available when using premium-style buttons.

Name	Type	Optional	Description
skuId	Snowflake	No	The SKU id to use

setStyle(style):this

Sets the style of this button.

Name	Type	Optional	Description
style	ButtonStyle	No	The style to use

setURL(url):this

Sets the URL for this button.

Remarks

This method is only available to buttons using the Link button style. Only three types of URL schemes are currently supported: https://, http://, and discord://.

Name	Type	Optional	Description
url	string	No	The URL to use

toJSON():APIButtonComponent

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.