PropertyWidget

Defined in: src/obsidian/internals/PropertyWidget.d.ts:6

Type Parameters

• T

Properties

icon

icon: string

Defined in: src/obsidian/internals/PropertyWidget.d.ts:10

Lucide-dev icon associated with the widget

---

reservedKeys?

optional reservedKeys: string[]

Defined in: src/obsidian/internals/PropertyWidget.d.ts:14

Reserved keys for the widget

---

type

type: string

Defined in: src/obsidian/internals/PropertyWidget.d.ts:18

Identifier for the widget

Methods

default()

default(): T

Defined in: src/obsidian/internals/PropertyWidget.d.ts:23

Get the default value for the property widget

Returns

T

---

name()

name(): string

Defined in: src/obsidian/internals/PropertyWidget.d.ts:27

Returns the I18N name of the widget

Returns

string

---

render()

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

Defined in: src/obsidian/internals/PropertyWidget.d.ts:31

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

Defined in: src/obsidian/internals/PropertyWidget.d.ts:35

Validate whether the input value to the widget is correct

Parameters

value

T

Returns

boolean