19 lines
866 B
Markdown
19 lines
866 B
Markdown
|
# Example Desktop Widget Template
|
||
|
|
|
||
|
|
A minimal free-floating, user-movable and resizable widget that lives on the desktop background layer.
|
||
|
|
|
||
|
|
## Key Points
|
||
|
|
|
||
|
|
- Uses `DesktopPluginComponent` (not `PluginComponent`)
|
||
|
|
- Set `minWidth`/`minHeight` (and optionally defaults)
|
||
|
|
- Read `widgetWidth`, `widgetHeight` for responsive behavior
|
||
|
|
- Position and size are persisted automatically per screen
|
||
|
|
- User interaction: right-click + drag anywhere to move, right-click + drag the bottom-right corner to resize
|
||
|
|
|
||
|
|
## Usage
|
||
|
|
|
||
|
|
Copy the folder, update `plugin.json`, customize the visual content.
|
||
|
|
|
||
|
|
Add real settings as needed. The template already demonstrates `PluginSettings` + `StringSetting` + `SliderSetting`.
|
||
|
|
|
||
|
|
See the official development guide for the full `DesktopPluginComponent` surface (including `getData`/`setData` helpers and time-based update patterns using `SystemClock`).
|