Skip to main content
Version: Next

APIChannelSelectComponent

A Channel Select is an interactive component that allows users to select one or more channels in a message. Options are automatically populated based on available channels in the server and can be filtered by channel types.

Channel Selects can be configured for both single-select and multi-select behavior. When a user finishes making their choice(s) your app receives an interaction.

Channel Selects must be placed inside an Action Row and are only available in messages. An Action Row can contain only one select menu and cannot contain buttons if it has a select menu.

@see

Hierarchy

Index

Properties

optionalchannel_types

channel_types?: ChannelType[]

List of channel types to include in the ChannelSelect component

inheritedcustom_id

custom_id: string

A developer-defined identifier for the select menu, max 100 characters

optionalinheriteddefault_values

default_values?: APISelectMenuDefaultValue<Channel>[]

List of default values for auto-populated select menu components

optionalinheriteddisabled

disabled?: boolean

Disable the select

@defaultValue

false

optionalinheritedid

id?: number

32 bit integer used as an optional identifier for component

The id field is optional and is used to identify components in the response from an interaction that aren't interactive components. The id must be unique within the message and is generated sequentially if left empty. Generation of ids won't use another id that exists in the message if you have one defined for another component.

optionalinheritedmax_values

max_values?: number

The maximum number of items that can be chosen; max 25

@defaultValue

1

optionalinheritedmin_values

min_values?: number

The minimum number of items that must be chosen; min 0, max 25

@defaultValue

1

optionalinheritedplaceholder

placeholder?: string

Custom placeholder text if nothing is selected, max 150 characters

inheritedtype

type: ChannelSelect

The type of the component