Component
@discordeno/bot • Docs
Documentation / @discordeno/bot / Component
Interface: Component
Properties
channelTypes?
optionalchannelTypes:ChannelTypes[]
List of channel types to include in a channel select menu options list
Defined in
packages/bot/src/transformers/types.ts:531
components?
optionalcomponents:Component[]
a list of child components
Defined in
packages/bot/src/transformers/types.ts:545
customId?
optionalcustomId:string
a developer-defined identifier for the component, max 100 characters
Defined in
packages/bot/src/transformers/types.ts:515
defaultValues?
optionaldefaultValues:DiscordComponentDefaultValue[]
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
Defined in
packages/bot/src/transformers/types.ts:547
disabled?
optionaldisabled:boolean
whether the component is disabled, default false
Defined in
packages/bot/src/transformers/types.ts:519
emoji?
optionalemoji:Pick<Partial<Emoji>,"id"|"name"|"animated">
Emoji object that includes fields of name, id, and animated supporting unicode and custom emojis.
Defined in
packages/bot/src/transformers/types.ts:527
label?
optionallabel:string
text that appears on the button (max 80 characters)
Defined in
packages/bot/src/transformers/types.ts:523
maxLength?
optionalmaxLength:number
The maximum input length for a text input. Between 1-4000.
Defined in
packages/bot/src/transformers/types.ts:543
maxValues?
optionalmaxValues:number
The maximum number of items that can be selected. Default 1. Between 1-25.
Defined in
packages/bot/src/transformers/types.ts:539
minLength?
optionalminLength:number
The minimum input length for a text input. Between 0-4000.
Defined in
packages/bot/src/transformers/types.ts:541
minValues?
optionalminValues:number
The minimum number of items that must be selected. Default 1. Between 1-25.
Defined in
packages/bot/src/transformers/types.ts:537
options?
optionaloptions:SelectOption[]
The choices! Maximum of 25 items.
Defined in
packages/bot/src/transformers/types.ts:533
placeholder?
optionalplaceholder:string
A custom placeholder text if nothing is selected. Maximum 150 characters.
Defined in
packages/bot/src/transformers/types.ts:535
required?
optionalrequired:boolean
whether this component is required to be filled, default true
Defined in
packages/bot/src/transformers/types.ts:517
skuId?
optionalskuId:bigint
Identifier for a purchasable SKU, only available when using premium-style buttons
Defined in
packages/bot/src/transformers/types.ts:549
style?
optionalstyle:ButtonStyles|TextStyles
For different styles/colors of the buttons
Defined in
packages/bot/src/transformers/types.ts:521
type
type:
MessageComponentTypes
component type
Defined in
packages/bot/src/transformers/types.ts:513
url?
optionalurl:string
optional url for link-style buttons that can navigate a user to the web. Only type 5 Link buttons can have a url
Defined in
packages/bot/src/transformers/types.ts:529
value?
optionalvalue:string
the dev-define value of the option, max 100 characters for select or 4000 for input.