ComponentThumbnail

Implementation of Discord’s Thumbnail component as a Luau builder. This is a Components V2 layout component, distinct from the embed thumbnail.

https://discord.com/developers/docs/components/reference#thumbnail

Summary

Properties

ComponentThumbnail.url :: string?ComponentThumbnail.description :: string?ComponentThumbnail.spoiler :: boolean?

Methods

ComponentThumbnail:setUrl(url: string) → ComponentThumbnailComponentThumbnail:setDescription(description: string) → ComponentThumbnailComponentThumbnail:setSpoiler(spoiler: boolean) → ComponentThumbnailComponentThumbnail:build() → JSON

Functions

ComponentThumbnail.new(resource: { url: string?, description: string?, spoiler: boolean?, }?) → ComponentThumbnail

Properties

url

ComponentThumbnail.url  :: string?

---

The URL of the media to display. Use attachment://filename for uploaded files.

description

ComponentThumbnail.description  :: string?

---

Alt text for the thumbnail image.

spoiler

ComponentThumbnail.spoiler  :: boolean?

---

Whether the thumbnail is blurred as a spoiler.

Methods

setUrl

ComponentThumbnail : setUrl ( url )  -> ComponentThumbnail

Sets the media URL for the thumbnail.

Parameters

url: string

Returns

ComponentThumbnail

setDescription

ComponentThumbnail : setDescription ( description )  -> ComponentThumbnail

Sets the alt text description for the thumbnail.

Parameters

description: string

Returns

ComponentThumbnail

setSpoiler

ComponentThumbnail : setSpoiler ( spoiler )  -> ComponentThumbnail

Sets whether the thumbnail is blurred as a spoiler.

Parameters

spoiler: boolean

Returns

ComponentThumbnail

build

ComponentThumbnail : build ( )  -> JSON

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

Returns

JSON

Functions

new

ComponentThumbnail . new ( resource )  -> ComponentThumbnail

Responsible for creating a new ComponentThumbnail.

Parameters

resource: { url: string?, description: string?, spoiler: boolean?, }

Returns

ComponentThumbnail