Skip to content

PropertyWidget

Type Parameters

T

Properties

icon

icon: string

Lucide-dev icon associated with the widget


reservedKeys?

optional reservedKeys: string[]

Reserved keys for the widget


type

type: string

Identifier for the widget

Methods

default()

default(): T

Get the default value for the property widget

Returns

T


name()

name(): string

Returns the I18N name of the widget

Returns

string


render()

render(containerEl, data, context): void | Component

Render function for the widget on field container given context and data

Parameters

containerEl: HTMLElement

data: PropertyEntryData<T>

context: PropertyRenderContext

Returns

void | Component


validate()

validate(value): boolean

Validate whether the input value to the widget is correct

Parameters

value: T

Returns

boolean