declare class StringSelectMenuBuilder extends BaseSelectMenuBuilder<APIStringSelectComponent>
A builder that creates API-compatible JSON data for string select menus.
Constructors
data?: Partial<APIStringSelectComponent>)
constructor(Creates a new select menu from API data.
const selectMenu = new StringSelectMenuBuilder({
custom_id: 'a cool select menu',
placeholder: 'select an option',
max_values: 2,
options: [
{ label: 'option 1', value: '1' },
{ label: 'option 2', value: '2' },
{ label: 'option 3', value: '3' },
],
});
const selectMenu = new StringSelectMenuBuilder({
custom_id: 'a cool select menu',
})
.setMinValues(1)
.addOptions({
label: 'Catchy',
value: 'catch',
});
protectedreadonlyexternalStringSelectMenuData data :
readonlyexternalreadonly StringSelectMenuOptionBuilder[] options :
The options for this select menu.
external addOptions...options: RestOrArray<APISelectMenuOption | StringSelectMenuOptionBuilder | ((builder: StringSelectMenuOptionBuilder) => StringSelectMenuOptionBuilder)>) : this (
Adds options to this select menu.
Clears the id of this component, defaulting to a default incremented id.
Inherited from: ComponentBuilder
Clears the placeholder for this select menu.
Inherited from: BaseSelectMenuBuilder
external setCustomIdcustomId: string) : this (
Sets the custom id for this select menu.
Inherited from: BaseSelectMenuBuilder
external setDisableddisabled?: boolean) : this (
Sets whether this select menu is disabled.
Inherited from: BaseSelectMenuBuilder
external setMaxValuesmaxValues: number) : this (
Sets the maximum values that must be selected in the select menu.
Inherited from: BaseSelectMenuBuilder
external setMinValuesminValues: number) : this (
Sets the minimum values that must be selected in the select menu.
Inherited from: BaseSelectMenuBuilder
external setOptions...options: RestOrArray<APISelectMenuOption | StringSelectMenuOptionBuilder | ((builder: StringSelectMenuOptionBuilder) => StringSelectMenuOptionBuilder)>) : this (
Sets the options for this select menu.
external setPlaceholderplaceholder: string) : this (
Sets the placeholder for this select menu.
Inherited from: BaseSelectMenuBuilder
external spliceOptionsindex: numberdeleteCount: number...options: (APISelectMenuOption | StringSelectMenuOptionBuilder | ((builder: StringSelectMenuOptionBuilder) => StringSelectMenuOptionBuilder))[]) : this (
Removes, replaces, or inserts options for this select menu.
selectMenu.spliceOptions(0, 1);
const n = 4;
selectMenu.spliceOptions(0, n);
selectMenu.spliceOptions(-1, 1);
external toJSONvalidationOverride?: boolean) : APIStringSelectComponent (
Serializes this builder to API-compatible JSON data.Note that by disabling validation, there is no guarantee that the resulting object will be valid.