summaryrefslogtreecommitdiff
path: root/raveos-hyprland-theme/theme-data/DankMaterialShell/quickshell/PLUGINS/LauncherImageExample/README.md
blob: 13b608db0cf1428435308c8483cf71940becb9ff (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
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.