PropertyWidget<ComponentType>
Unofficial
Property widget.
Import:
import type { PropertyWidget } from '@obsidian-typings/obsidian-public-latest';Signature:
export interface PropertyWidget<ComponentType extends PropertyWidgetComponentBase = PropertyWidgetComponentBase>Properties
| Property | Type | Description | |
|---|---|---|---|
| icon | string | Lucide-dev icon associated with the widget. | |
| reservedKeys? | string[] | Reserved keys for the widget. | |
| type | string | Identifier for the widget. |
Methods
| Method | Returns | Description | |
|---|---|---|---|
| name() | string | Returns the I18N name of the widget. | |
| render(containerEl, data, context) | ComponentType | Render function for the widget on field container given context and data. | |
| validate(value) | boolean | Validate whether the input value to the widget is correct. |
Links to this page: