Class Dropdown

constructor

• new Dropdown(): Dropdown

  Creates a dropdown component.

  Returns Dropdown

channel_types

custom_id

default_values

disabled

max_values

min_values

options

placeholder

type

addChannelTypes

• addChannelTypes(channelTypes: ChannelType[]): Dropdown

  Sets which channel types are selectable by the user.

  Parameters

  • channelTypes: ChannelType[]

    An array of channel types to offer as a choice.

  Returns Dropdown

  See

  https://discord.com/developers/docs/resources/channel#channel-object-channel-types

addDefaultOption

• addDefaultOption(option: DropdownDefaultOption): Dropdown

  Adds a default option to the dropdown.

  Parameters

  • option: DropdownDefaultOption

    The default option to add to the dropdown.

  Returns Dropdown

addOption

• addOption(option: DropdownOptionBuilder): Dropdown

  Adds an option to the dropdown.

  Parameters

  • option: DropdownOptionBuilder

    Adds an option to the dropdown.

  Returns Dropdown

setCustomID

• setCustomID(id: string): Dropdown

  Set the custom id of the dropdown.

  Parameters

  • id: string

    The custom id of the dropdown.

  Returns Dropdown

  See

  https://discord.com/developers/docs/interactions/message-components#custom-id

setDisabled

• setDisabled(isDisabled: boolean): Dropdown

  Disables the dropdown from being clickable.

  Parameters

  • isDisabled: boolean

  Returns Dropdown

setMaxValue

• setMaxValue(value: number): Dropdown

  Sets the maximum value the user may enter.

  Parameters

  • value: number

    The maximum number value that the user may enter.

  Returns Dropdown

setMinValue

• setMinValue(value: number): Dropdown

  Sets the minimum value the user may enter.

  Parameters

  • value: number

    The minimum number value that the user may enter.

  Returns Dropdown

setPlaceholder

• setPlaceholder(placeholder: string): Dropdown

  Sets the placeholder text.

  Parameters

  • placeholder: string

    Placeholder text if nothing is selected.

  Returns Dropdown

setType

• setType(
      type:
          | StringSelect
          | UserSelect
          | RoleSelect
          | MentionableSelect
          | ChannelSelect,
  ): Dropdown

  Sets the option type.

  Parameters

  • type: StringSelect | UserSelect | RoleSelect | MentionableSelect | ChannelSelect

    The option type.

  Returns Dropdown

  See

  https://discord.com/developers/docs/interactions/message-components#component-object-component-types

toJSON

• toJSON(
      format?: JsonTypes,
      __namedParameters?: { suppressValidation: boolean },
  ): {
      channel_types: undefined | ChannelType[];
      custom_id: string;
      default_values: DropdownDefaultOption[];
      disabled: undefined | boolean;
      max_values: undefined | number;
      min_values: undefined | number;
      options: (
          | DropdownOptionBuilderCacheJSON
          | DropdownOptionBuilderStorageJSON
          | DropdownOptionBuilderDiscordJSON
      )[];
      placeholder: undefined
      | string;
      type:
          | StringSelect
          | UserSelect
          | RoleSelect
          | MentionableSelect
          | ChannelSelect;
  }

  Returns the correct Discord format for a dropdown.

  Parameters

  • Optionalformat: JsonTypes
  • __namedParameters: { suppressValidation: boolean } = ...

  Returns {
      channel_types: undefined | ChannelType[];
      custom_id: string;
      default_values: DropdownDefaultOption[];
      disabled: undefined | boolean;
      max_values: undefined | number;
      min_values: undefined | number;
      options: (
          | DropdownOptionBuilderCacheJSON
          | DropdownOptionBuilderStorageJSON
          | DropdownOptionBuilderDiscordJSON
      )[];
      placeholder: undefined
      | string;
      type:
          | StringSelect
          | UserSelect
          | RoleSelect
          | MentionableSelect
          | ChannelSelect;
  }