discord.js | RoleSelectMenuBuilder

Search...

RoleSelectMenuBuilder

export declare class RoleSelectMenuBuilder extends BaseSelectMenuBuilder<APIRoleSelectComponent>

export declare class RoleSelectMenuBuilder extends BaseSelectMenuBuilder<APIRoleSelectComponent>

No summary provided.

constructor(data?)

Creates a new select menu from API data

Creating a select menu from an API data object

const selectMenu = new RoleSelectMenuBuilder({
	custom_id: 'a cool select menu',
	placeholder: 'select an option',
	max_values: 2,
});

const selectMenu = new RoleSelectMenuBuilder({
	custom_id: 'a cool select menu',
	placeholder: 'select an option',
	max_values: 2,
});

Creating a select menu using setters and API data

const selectMenu = new RoleSelectMenuBuilder({
	custom_id: 'a cool select menu',
})
	.setMinValues(1)

const selectMenu = new RoleSelectMenuBuilder({
	custom_id: 'a cool select menu',
})
	.setMinValues(1)

Name	Type	Optional	Description
data	Partial<APIRoleSelectComponent>	Yes	The API data to create this select menu with

Readonly

data:Partial<DataType>

The API data associated with this component

setCustomId(customId):this

Sets the custom id for this select menu

Name	Type	Optional	Description
customId	string	No	The custom id to use for this select menu

setDisabled(disabled?):this

Sets whether this select menu is disabled

Name	Type	Optional	Description
disabled	boolean	Yes	Whether this select menu is disabled

setMaxValues(maxValues):this

Sets the maximum values that must be selected in the select menu

Name	Type	Optional	Description
maxValues	number	No	The maximum values that must be selected

setMinValues(minValues):this

Sets the minimum values that must be selected in the select menu

Name	Type	Optional	Description
minValues	number	No	The minimum values that must be selected

setPlaceholder(placeholder):this

Sets the placeholder for this select menu

Name	Type	Optional	Description
placeholder	string	No	The placeholder to use for this select menu

toJSON():export declare class BaseSelectMenuBuilder<SelectMenuType extends