Button

Implementation of discords Button object as a Luau builder.

https://discord.com/developers/docs/interactions/message-components#buttons

Summary

Properties

Button.style :: apiTypes.ButtonStyleButton.label :: string?Button.emoji :: Builders.Emoji?Button.customId :: string?Button.skuId :: string?Button.url :: string?Button.disabled :: boolean?

Methods

Button:setStyle(buttonStyle: apiTypes.ButtonStyle) → ButtonButton:setLabel(label: string) → ButtonButton:setEmoji(emoji: emoji.JSON) → ButtonButton:setCustomId(customId: string) → ButtonButton:setSkuId(skuId: string) → ButtonButton:setUrl(url: string) → ButtonButton:setDisabled(disabled: boolean) → ButtonButton:build() → JSON

Functions

Button.new(resource: { style: apiTypes.ButtonStyle, label: string?, emoji: emoji.JSON?, customId: string?, skuId: string?, url: string?, disabled: boolean?, }?) → Button

Properties

style

Button.style  :: ButtonStyle

---

The style of the button that determines its appearance and behavior.

label

Button.label  :: string?

---

The text that appears on the button.

emoji

Button.emoji  :: Emoji?

---

The emoji that appears on the button.

customId

Button.customId  :: string?

---

A developer-defined identifier for the button.

skuId

Button.skuId  :: string?

---

The SKU ID for purchase buttons.

url

Button.url  :: string?

---

The URL that the button will navigate to when clicked.

disabled

Button.disabled  :: boolean?

---

Whether the button is disabled and cannot be clicked.

Methods

setStyle

Button : setStyle ( buttonStyle )  -> Button

Sets the style of the button. This determines the button’s appearance and behavior.

Parameters

buttonStyle: ButtonStyle

Returns

Button

setLabel

Button : setLabel ( label )  -> Button

Sets the text that appears on the button. Must be between 1-80 characters.

Parameters

label: string

Returns

Button

setEmoji

Button : setEmoji ( emoji )  -> Button

Sets the emoji that appears on the button.

Parameters

emoji: JSON

Returns

Button

setCustomId

Button : setCustomId ( customId )  -> Button

Sets a developer-defined identifier for the button that will be sent when the button is clicked.

Parameters

customId: string

Returns

Button

setSkuId

Button : setSkuId ( skuId )  -> Button

Sets the SKU ID for the button, used for purchase buttons.

Parameters

skuId: string

Returns

Button

setUrl

Button : setUrl ( url )  -> Button

Sets the URL that the button will navigate to when clicked.

Parameters

url: string

Returns

Button

setDisabled

Button : setDisabled ( disabled )  -> Button

Sets whether the button is disabled and cannot be clicked.

Parameters

disabled: boolean

Returns

Button

build

Button : build ( )  -> JSON

Responsible for building the Button JSON that can be parsed by the Discord API.

Returns

JSON

Functions

new

Button . new ( resource )  -> Button

Responsible for creating a new Button.

local button = Button.new({
  style = "Primary",
  label = "Click me!",
  customId = "my_button"
})

Parameters

resource: { style: apiTypes.ButtonStyle, label: string?, emoji: emoji.JSON?, customId: string?, skuId: string?, url: string?, disabled: boolean?, }

Returns

Button