StringSelectMenuKit

StringSelectMenuKit extends StringSelectMenuBuilder

new StringSelectMenuKit(data)

Parameter	Type	Optional
data	Partial<APIStringSelectComponent | StringSelectMenuComponentData>	✅

Properties

public data: any

The API data associated with this component.

public options: any

The options within this select menu.

Methods

public addOptions(options): this

Adds options to this select menu.

Parameter	Type	Optional	Description
options	RestOrArray<StringSelectMenuOptionBuilder	SelectMenuComponentOptionData	APISelectMenuOption>

public clearId(): this

Clears the id of this component, defaulting to a default incremented id.

public dispose(): StringSelectMenuKit

• Source

public filter(predicate): this

Sets a filter for the interaction collector.

Parameter	Type	Optional	Description
predicate	SelectMenuKitPredicate<StringSelectMenuInteraction>	❌	The filter to use for the interaction collector.

• Source

public onEnd(handler): this

Sets the handler to run when the interaction collector ends.

Parameter	Type	Optional	Description
handler	CommandKitSelectMenuBuilderOnEnd	❌	The handler to run when the interaction collector ends.

• Source

public onError(handler): this

Sets the handler to run when the interaction collector ends.

Parameter	Type	Optional	Description
handler	EventInterceptorErrorHandler	❌	The handler to run when the interaction collector ends.

• Source

public onSelect(handler, data?): this

Sets the handler to run when the modal is submitted.

const modal = new StringSelectMenuKit()
 .setTitle('My Modal')
 .setCustomId('my-modal')
 .filter((interaction) => interaction.user.id === '1234567890')
 .onSelect(async (interaction) => {
    await interaction.reply('You submitted the modal!');
  })
  .addComponents(actionRow1, actionRow2);

Parameter	Type	Optional	Description
handler	CommandKitSelectMenuBuilderInteractionCollectorDispatch<StringSelectMenuInteraction	StringSelectMenuKit>	❌
data	CommandKitSelectMenuBuilderInteractionCollectorDispatchContextData	✅	The context data for the interaction collector.

• Source

public setCustomId(customId): this

Sets the custom id for this select menu.

Parameter	Type	Optional	Description
customId	string	❌	The custom id to use

public setDisabled(disabled?): this

Sets whether this select menu is disabled.

Parameter	Type	Optional	Description
disabled	boolean	✅	Whether this select menu is disabled

public setId(id): this

Sets the id (not the custom id) for this component.

Parameter	Type	Optional	Description
id	number	❌	The id for this component

public setMaxValues(maxValues): this

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

Parameter	Type	Optional	Description
maxValues	number	❌	The maximum values that must be selected

public setMinValues(minValues): this

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

Parameter	Type	Optional	Description
minValues	number	❌	The minimum values that must be selected

public setOptions(options): this

Sets the options for this select menu.

Parameter	Type	Optional	Description
options	RestOrArray<StringSelectMenuOptionBuilder	SelectMenuComponentOptionData	APISelectMenuOption>

public setPlaceholder(placeholder): this

Sets the placeholder for this select menu.

Parameter	Type	Optional	Description
placeholder	string	❌	The placeholder to use

public spliceOptions(index, deleteCount, options): this

Removes, replaces, or inserts options for this select menu.

Remove the first option:

selectMenu.spliceOptions(0, 1);

Remove the first n option:

const n = 4;
selectMenu.spliceOptions(0, n);

Remove the last option:

selectMenu.spliceOptions(-1, 1);

Parameter	Type	Optional	Description
index	number	❌	The index to start at
deleteCount	number	❌	The number of options to remove
options	RestOrArray<StringSelectMenuOptionBuilder	APISelectMenuOption>	❌

public toJSON(): APIStringSelectComponent

BaseSelectMenuBuilder.toJSON

public static from(other): StringSelectMenuBuilder

Parameter	Type	Optional
other	APIStringSelectComponent	JSONEncodable<APIStringSelectComponent>