discord.js | UserSelectMenuBuilder

Search...

UserSelectMenuBuilder

export declare class UserSelectMenuBuilder extends BaseSelectMenuBuilder<APIUserSelectComponent>

export declare class UserSelectMenuBuilder extends BaseSelectMenuBuilder<APIUserSelectComponent>

A builder that creates API-compatible JSON data for user select menus.

constructor(data?)

Creates a new select menu from API data.

Creating a select menu from an API data object:

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

const selectMenu = new UserSelectMenuBuilder({
	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 UserSelectMenuBuilder({
	custom_id: 'a cool select menu',
})
	.setMinValues(1);

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

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

ProtectedReadonly

addDefaultUsers(...users):this

Adds default users to this auto populated select menu.

Name	Type	Optional	Description
...users	RestOrArray<Snowflake>	No	The users to add

clearPlaceholder():this

Clears the placeholder for this select menu.

setCustomId(customId):this

Sets the custom id for this select menu.

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

setDefaultUsers(...users):this

Sets default users for this auto populated select menu.

Name	Type	Optional	Description
...users	RestOrArray<Snowflake>	No	The users to set

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

toJSON(validationOverride?):APIUserSelectComponent

Serializes this builder to API-compatible JSON data.

Note that by disabling validation, there is no guarantee that the resulting object will be valid.

Name	Type	Optional	Description
validationOverride	boolean	Yes	Force validation to run/not run regardless of your global preference