summaryrefslogtreecommitdiff
path: root/raveos-hyprland-theme/theme-data/DankMaterialShell/quickshell/PLUGINS/LauncherImageExample/README.md
diff options
context:
space:
mode:
authorAlexanderCurl <alexc@alexc.hu>2026-04-18 17:46:06 +0100
committerAlexanderCurl <alexc@alexc.hu>2026-04-18 17:46:06 +0100
commit70ca3fef77ee8bdc6e3ac28589a6fa08c024cc69 (patch)
treeab1123d4067c1b086dd6faa7ee4ea643236b565a /raveos-hyprland-theme/theme-data/DankMaterialShell/quickshell/PLUGINS/LauncherImageExample/README.md
parent5d94c0a7d44a2255b81815a52a7056a94a39842d (diff)
downloadRaveOS-PKGBUILD-70ca3fef77ee8bdc6e3ac28589a6fa08c024cc69.tar.gz
RaveOS-PKGBUILD-70ca3fef77ee8bdc6e3ac28589a6fa08c024cc69.zip
Replaced file structures for themes in the correct format
Diffstat (limited to 'raveos-hyprland-theme/theme-data/DankMaterialShell/quickshell/PLUGINS/LauncherImageExample/README.md')
-rw-r--r--raveos-hyprland-theme/theme-data/DankMaterialShell/quickshell/PLUGINS/LauncherImageExample/README.md43
1 files changed, 43 insertions, 0 deletions
diff --git a/raveos-hyprland-theme/theme-data/DankMaterialShell/quickshell/PLUGINS/LauncherImageExample/README.md b/raveos-hyprland-theme/theme-data/DankMaterialShell/quickshell/PLUGINS/LauncherImageExample/README.md
new file mode 100644
index 0000000..13b608d
--- /dev/null
+++ b/raveos-hyprland-theme/theme-data/DankMaterialShell/quickshell/PLUGINS/LauncherImageExample/README.md
@@ -0,0 +1,43 @@
+# LauncherImageExample
+
+Example launcher plugin demonstrating tile mode with URL-based images.
+
+## Features
+
+- **Tile Mode**: Uses `viewMode: "tile"` in plugin.json to display results as image tiles
+- **Enforced View Mode**: Uses `viewModeEnforced: true` to lock the view to tile mode (users cannot change it)
+- **URL Images**: Demonstrates using `imageUrl` property for remote images
+
+## Usage
+
+1. Open the launcher (DankLauncherV2)
+2. Type `img` to activate the plugin
+3. Browse DankMaterialShell screenshots in tile view
+
+## Plugin Configuration
+
+```json
+{
+ "viewMode": "tile",
+ "viewModeEnforced": true
+}
+```
+
+- `viewMode`: Sets the default view mode ("list", "grid", or "tile")
+- `viewModeEnforced`: When true, users cannot switch view modes for this plugin
+
+## Item Data Structure
+
+To display images in tile mode, set `imageUrl` directly on the item:
+
+```javascript
+{
+ name: "Image Title",
+ icon: "material:image",
+ comment: "Image description",
+ categories: ["Category"],
+ imageUrl: "https://example.com/image.png"
+}
+```
+
+The `imageUrl` property supports remote URLs or local files, use `file://` prefix for local files.