Skip to content

Commit

Permalink
feat(docs): add image_icon_size option and usage note for application…
Browse files Browse the repository at this point in the history
…s widget
  • Loading branch information
amnweb committed Dec 29, 2024
1 parent 30b55ac commit d5b4c4c
Showing 1 changed file with 6 additions and 1 deletion.
7 changes: 6 additions & 1 deletion docs/widgets/(Widget)-Applications.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,6 +3,7 @@
|------------|--------|---------|-----------------------------------------------------------------------------|
| `label` | string | {data} | The label for the applications widget. |
| `class_name` | string | `""` | The CSS class name for styling the widget. Optional. |
| `image_icon_size` | int | `14` | The size of the icon in pixels if the icon is an image. |
| `app_list` | list | `[]`| Application list with command. |
| `container_padding` | dict | `{'top': 0, 'left': 0, 'bottom': 0, 'right': 0}` | Explicitly set padding inside widget container.

Expand All @@ -18,7 +19,7 @@ apps:
- {icon: "\ueb51", launch: "quick_settings"}
- {icon: "\uf422", launch: "search"}
- {icon: "\uf489", launch: "wt"}
- {icon: "\udb82\ude1e", launch: "C:\\Users\\Username\\AppData\\Local\\Programs\\Microsoft VS Code\\Code.exe"}
- {icon: "C:\\Users\\marko\\icons\\vscode.png", launch: "C:\\Users\\Username\\AppData\\Local\\Programs\\Microsoft VS Code\\Code.exe"}
container_padding:
top: 0
left: 8
Expand All @@ -29,9 +30,13 @@ apps:
## Description of Options
- **label:** The label for the applications widget.
- **class_name:** The CSS class name for styling the widget. Optional.
- **image_icon_size:** The size of the icon in pixels if the icon is an image.
- **app_list:** A list of applications to display. Each application should be a dictionary with [`icon`] and [`launch`] keys. As launch you can call `quick_settings`, `notification_center`, `search`, `widget`, `launcher (launcher will trigger ALT+SPACE)`.
- **container_padding:** Explicitly set padding inside widget container.

> [!NOTE]
> If you use image as icon, you need to provide the full path to the image. Recommended to use small images.

## Example Style
```css
.apps-widget {}
Expand Down

0 comments on commit d5b4c4c

Please sign in to comment.