Skip to main content
Version: Next

CustomWidget

@devvit/public-api v0.12.14-dev

Class: CustomWidget

Extends​

Constructors​

new CustomWidget()​

new CustomWidget(widgetData, subredditName, metadata): CustomWidget

Parameters​

widgetData​

GetWidgetsResponse_WidgetItem

subredditName​

string

metadata​

undefined | Metadata

Returns​

CustomWidget

Overrides​

Widget.constructor

Accessors​

css​

Get Signature​

get css(): string

Returns​

string

height​

Get Signature​

get height(): number

Returns​

number

id​

Get Signature​

get id(): string

Returns​

string

Inherited from​

Widget.id

images​

Get Signature​

get images(): WidgetImage[]

Returns​

WidgetImage[]

name​

Get Signature​

get name(): string

Returns​

string

Inherited from​

Widget.name

stylesheetUrl​

Get Signature​

get stylesheetUrl(): string

Returns​

string

subredditName​

Get Signature​

get subredditName(): string

Returns​

string

Inherited from​

Widget.subredditName

text​

Get Signature​

get text(): string

Returns​

string

Methods​

delete()​

delete(): Promise<void>

Returns​

Promise<void>

Inherited from​

Widget.delete

toJSON()​

toJSON(): Pick<Widget, "subredditName" | "id" | "name"> & Pick<CustomWidget, "text" | "height" | "images" | "stylesheetUrl" | "css">

Returns​

Pick<Widget, "subredditName" | "id" | "name"> & Pick<CustomWidget, "text" | "height" | "images" | "stylesheetUrl" | "css">

Overrides​

Widget.toJSON