Skip to main content

Component

@discordeno/bot

Documentation / @discordeno/bot / Component

Interface: Component

Defined in: packages/bot/src/transformers/types.ts:510

Properties​

channelTypes?​

optional channelTypes: ChannelTypes[]

Defined in: packages/bot/src/transformers/types.ts:530

List of channel types to include in a channel select menu options list

components?​

optional components: Component[]

Defined in: packages/bot/src/transformers/types.ts:544

a list of child components

customId?​

optional customId: string

Defined in: packages/bot/src/transformers/types.ts:514

a developer-defined identifier for the component, max 100 characters

defaultValues?​

optional defaultValues: DiscordComponentDefaultValue[]

Defined in: packages/bot/src/transformers/types.ts:546

List of default values for auto-populated select menu components; number of default values must be in the range defined by min_values and max_values

disabled?​

optional disabled: boolean

Defined in: packages/bot/src/transformers/types.ts:518

whether the component is disabled, default false

emoji?​

optional emoji: Pick<Partial<Emoji>, "id" | "name" | "animated">

Defined in: packages/bot/src/transformers/types.ts:526

Emoji object that includes fields of name, id, and animated supporting unicode and custom emojis.

label?​

optional label: string

Defined in: packages/bot/src/transformers/types.ts:522

text that appears on the button (max 80 characters)

maxLength?​

optional maxLength: number

Defined in: packages/bot/src/transformers/types.ts:542

The maximum input length for a text input. Between 1-4000.

maxValues?​

optional maxValues: number

Defined in: packages/bot/src/transformers/types.ts:538

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

minLength?​

optional minLength: number

Defined in: packages/bot/src/transformers/types.ts:540

The minimum input length for a text input. Between 0-4000.

minValues?​

optional minValues: number

Defined in: packages/bot/src/transformers/types.ts:536

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

options?​

optional options: SelectOption[]

Defined in: packages/bot/src/transformers/types.ts:532

The choices! Maximum of 25 items.

placeholder?​

optional placeholder: string

Defined in: packages/bot/src/transformers/types.ts:534

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

required?​

optional required: boolean

Defined in: packages/bot/src/transformers/types.ts:516

whether this component is required to be filled, default true

skuId?​

optional skuId: bigint

Defined in: packages/bot/src/transformers/types.ts:548

Identifier for a purchasable SKU, only available when using premium-style buttons

style?​

optional style: ButtonStyles | TextStyles

Defined in: packages/bot/src/transformers/types.ts:520

For different styles/colors of the buttons

type​

type: MessageComponentTypes

Defined in: packages/bot/src/transformers/types.ts:512

component type

url?​

optional url: string

Defined in: packages/bot/src/transformers/types.ts:528

optional url for link-style buttons that can navigate a user to the web. Only type 5 Link buttons can have a url

value?​

optional value: string

Defined in: packages/bot/src/transformers/types.ts:524

the dev-define value of the option, max 100 characters for select or 4000 for input.