Skip to main content

ButtonComponent

@discordeno/bot


Documentation / @discordeno/bot / ButtonComponent

Interface: ButtonComponent

Defined in: packages/types/dist/types/discordeno.d.ts:79

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

Extends

Properties

customId?

optional customId: string

Defined in: packages/types/dist/types/discordeno.d.ts:84

a dev-defined unique string sent on click (max 100 characters). type 5 Link buttons can not have a custom_id


disabled?

optional disabled: boolean

Defined in: packages/types/dist/types/discordeno.d.ts:101

Whether or not this button is disabled


emoji?

optional emoji: object

Defined in: packages/types/dist/types/discordeno.d.ts:88

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

animated?

optional animated: boolean

Whether this emoji is animated

id?

optional id: bigint

Emoji id

name?

optional name: string

Emoji name


id?

optional id: number

Defined in: packages/types/dist/types/discordeno.d.ts:65

32 bit integer used as an optional identifier for component

Inherited from

BaseComponent.id


label?

optional label: string

Defined in: packages/types/dist/types/discordeno.d.ts:82

for what the button says (max 80 characters)


skuId?

optional skuId: BigString

Defined in: packages/types/dist/types/discordeno.d.ts:97

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


style

style: ButtonStyles

Defined in: packages/types/dist/types/discordeno.d.ts:86

For different styles/colors of the buttons


type

type: Button

Defined in: packages/types/dist/types/discordeno.d.ts:80

The type of the component

Overrides

BaseComponent.type


url?

optional url: string

Defined in: packages/types/dist/types/discordeno.d.ts:99

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