Skip to main content

ButtonComponent

Documentation

Documentation / @discordeno/types / ButtonComponent

Interface: ButtonComponent

Defined in: discordeno/components.ts:70

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

Extends​

Properties​

customId?​

optional customId?: string

Defined in: discordeno/components.ts:87

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: discordeno/components.ts:100

Whether or not this button is disabled

emoji?​

optional emoji?: object

Defined in: discordeno/components.ts:78

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?: BigString

Emoji id

name?​

optional name?: string

Emoji name

id?​

optional id?: number

Defined in: discordeno/components.ts:42

32 bit integer used as an optional identifier for component

Inherited from​

BaseComponent.id

label?​

optional label?: string

Defined in: discordeno/components.ts:76

for what the button says (max 80 characters)

skuId?​

optional skuId?: BigString

Defined in: discordeno/components.ts:89

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

style​

style: ButtonStyles

Defined in: discordeno/components.ts:74

For different styles/colors of the buttons

type​

type: Button

Defined in: discordeno/components.ts:71

The type of the component

Overrides​

BaseComponent.type

url?​

optional url?: string

Defined in: discordeno/components.ts:98

optional url for link-style buttons that can navigate a user to the web.

Remarks​

Only Link buttons can have a url.

Maximum 512 characters.