class StringSelectMenuBuilder

export declare class StringSelectMenuBuilder extends BaseSelectMenuBuilder<APIStringSelectComponent>

Represents a string select menu component

Constructors

constructor(
data?: Partial<APIStringSelectComponent>
)

Creates a new select menu from API data

readonly
data : Partial<DataType>

The API data associated with this component

Inherited from: ComponentBuilder

readonly
options : StringSelectMenuOptionBuilder[]

The options within this select menu

addOptions(
options: RestOrArray<APISelectMenuOption | StringSelectMenuOptionBuilder>
) : this

Adds options to this select menu

setCustomId(
customId: string
) : this

Sets the custom id for this select menu

Inherited from: BaseSelectMenuBuilder

setDisabled(
disabled?: boolean
) : this

Sets whether this select menu is disabled

Inherited from: BaseSelectMenuBuilder

setMaxValues(
maxValues: number
) : this

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

Inherited from: BaseSelectMenuBuilder

setMinValues(
minValues: number
) : this

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

Inherited from: BaseSelectMenuBuilder

setOptions(
options: RestOrArray<APISelectMenuOption | StringSelectMenuOptionBuilder>
) : this

Sets the options on this select menu

setPlaceholder(
placeholder: string
) : this

Sets the placeholder for this select menu

Inherited from: BaseSelectMenuBuilder

spliceOptions(
index: number
deleteCount: number
options: RestOrArray<APISelectMenuOption | StringSelectMenuOptionBuilder>
) : this

Removes, replaces, or inserts options in the string select menu.

Examples: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);

toJSON() : APIStringSelectComponent

Serializes this component to an API-compatible JSON object