diff --git a/docs/desktop_widgets.md b/docs/desktop_widgets.md index 5d62879..314ea8b 100644 --- a/docs/desktop_widgets.md +++ b/docs/desktop_widgets.md @@ -52,10 +52,10 @@ class ExampleClockWidget(Box): DesktopWidgetRegistry.register( - "example", # unique key (used in desktop.toml) - ExampleClockWidget, # GTK widget class - (174, 174), # size (width, height) in pixels - (0.45, 0.45), # default position (px, py) as 0.0–1.0 fractions + "example", # unique key (used in desktop.toml) + ExampleClockWidget, # GTK widget class + (174, 174), # size (width, height) in pixels + (0.45, 0.45), # default position (px, py) as 0.0–1.0 fractions ) ``` @@ -175,6 +175,7 @@ class LiveClockWidget(Box): def _update(self) -> bool: import datetime + now = datetime.datetime.now() self.label.set_label(now.strftime("%H:%M")) return True diff --git a/docs/plugins.md b/docs/plugins.md index 422c160..c3c5856 100644 --- a/docs/plugins.md +++ b/docs/plugins.md @@ -62,17 +62,17 @@ def search(self, query: str, token: Any) -> list[SearchResult]: ```python SearchResult( - id="unique_id", # Unique within your plugin - title="Display Title", # Main text - subtitle="Description", # Secondary text - icon_name="", # GTK icon name (optional) - icon_data=None, # Raw image bytes for custom icons (optional) - score=80.0, # 0-100, higher = better match - render_type="default", # Controls rendering (see below) - action=lambda: ..., # Called when user selects this result - plugin_name="", # Auto-filled by spotlight - plugin_id="", # Auto-filled by spotlight - metadata={}, # Arbitrary data for renderers + id="unique_id", # Unique within your plugin + title="Display Title", # Main text + subtitle="Description", # Secondary text + icon_name="", # GTK icon name (optional) + icon_data=None, # Raw image bytes for custom icons (optional) + score=80.0, # 0-100, higher = better match + render_type="default", # Controls rendering (see below) + action=lambda: ..., # Called when user selects this result + plugin_name="", # Auto-filled by spotlight + plugin_id="", # Auto-filled by spotlight + metadata={}, # Arbitrary data for renderers ) ``` @@ -159,6 +159,7 @@ class HelloPlugin(SpotlightPlugin): ) ] + PLUGIN = HelloPlugin ``` @@ -190,7 +191,7 @@ class GooglePlugin(SpotlightPlugin): q = query.strip() if q: url = f"https://www.google.com/search?q={urllib.parse.quote(q)}" - spawn_detached(["xdg-open", url]) # no shell injection risk + spawn_detached(["xdg-open", url]) # no shell injection risk PLUGIN = GooglePlugin