sankalp/Modus
1
0 Fork 0
Code Issues 2 Pull Requests Actions Packages Projects Releases 1 Wiki Activity

docs(plugins): add icon_data field and fix duplicate heading

Browse Source 
- Add icon_data field to SearchResult documentation
- Remove duplicate 'How It Works' heading
- Fix plugin directory path references
This commit is contained in:
sankalp committed 2026-07-18 19:29:45 +05:45
1 parent 5afada35a4
commit a403b5a649
1 file changed
+1 -2
Download Patch File Download Diff File Expand all files Collapse all files
docs/plugins.md
+1 -2
View File
@@ -14,8 +14,6 @@ Open spotlight and type `hi` or `hello`. The plugin shows a greeting result.
## How It Works ## How It Works
## How It Works
1. On startup, Modus scans `config/plugins/` for `.py` files and package directories. 1. On startup, Modus scans `config/plugins/` for `.py` files and package directories.
2. Each file is imported. The `PLUGIN` module-level variable is extracted (must be a `SpotlightPlugin` subclass). 2. Each file is imported. The `PLUGIN` module-level variable is extracted (must be a `SpotlightPlugin` subclass).
3. Plugins are instantiated, initialized, and registered. 3. Plugins are instantiated, initialized, and registered.
@@ -68,6 +66,7 @@ SearchResult(
title="Display Title", # Main text title="Display Title", # Main text
subtitle="Description", # Secondary text subtitle="Description", # Secondary text
icon_name="", # GTK icon name (optional) icon_name="", # GTK icon name (optional)
icon_data=None, # Raw image bytes for custom icons (optional)
score=80.0, # 0-100, higher = better match score=80.0, # 0-100, higher = better match
render_type="default", # Controls rendering (see below) render_type="default", # Controls rendering (see below)
action=lambda: ..., # Called when user selects this result action=lambda: ..., # Called when user selects this result