Skip to main content

DiscordRoleSelectComponent

Documentation

Documentation / @discordeno/types / DiscordRoleSelectComponent

Interface: DiscordRoleSelectComponent

Defined in: discord/components.ts:388

https://docs.discord.com/developers/components/reference#role-select-role-select-structure

Extends​

Properties​

custom_id​

custom_id: string

Defined in: discord/components.ts:392

A custom identifier for this component. Maximum 100 characters.

default_values?​

optional default_values?: DiscordSelectMenuDefaultValue[]

Defined in: discord/components.ts:399

List of default values for auto-populated select menu components The number of default values must be in the range defined by minValues and maxValues

disabled?​

optional disabled?: boolean

Defined in: discord/components.ts:421

Whether select menu is disabled

Remarks​

This value cannot be set for select menus in modals

Default​

false

id?​

optional id?: number

Defined in: discord/components.ts:100

32 bit integer used as an optional identifier for component

Inherited from​

DiscordBaseComponent.id

max_values?​

optional max_values?: number

Defined in: discord/components.ts:403

The maximum number of items that can be selected. Default 1. Max 25.

min_values?​

optional min_values?: number

Defined in: discord/components.ts:401

The minimum number of items that must be selected. Default 1. Between 0-25.

placeholder?​

optional placeholder?: string

Defined in: discord/components.ts:394

A custom placeholder text if nothing is selected. Maximum 150 characters.

required?​

optional required?: boolean

Defined in: discord/components.ts:412

Whether this component is required to be filled

Remarks​

This value is only valid for string select menus in modals

Default​

true

type​

type: RoleSelect

Defined in: discord/components.ts:389

The type of the component

Overrides​

DiscordBaseComponent.type