feat: add menu module

Adds a new Menu module which allows users to create XDG or custom menus that open after clicking on a button.

Resolves JakeStanger#534

Co-authored-by: Jake Stanger <mail@jstanger.dev>

Author: ClaireNeveu

.github/workflows/build.yml

@@ -113,6 +113,7 @@ jobs:
           - keyboard+hyprland
           - label
           - launcher
+          - menu
           - music+all
           - music+mpris
           - music+mpd

Cargo.lock

@@ -23,6 +23,7 @@ default = [
     "keyboard+all",
     "launcher",
     "label",
+    "menu",
     "music+all",
     "network_manager",
     "notifications",
@@ -76,6 +77,8 @@ label = []
 
 launcher = []
 
+menu = ["dep:freedesktop_entry_parser", "dep:unicode-segmentation"]
+
 music = ["dep:regex"]
 "music+all" = ["music", "music+mpris", "music+mpd"]
 "music+mpris" = ["music", "mpris"]
@@ -159,6 +162,10 @@ chrono = { version = "0.4.41", optional = true, default-features = false, featur
 colpetto = { version = "0.6.0", features = ["tokio", "tracing"], optional = true }
 evdev-rs = { version = "0.6.1", optional = true }
 
+# menu
+freedesktop_entry_parser = { version = "1.3.0", optional = true }
+unicode-segmentation = { version = "1.11.0", optional = true }
+
 # music
 mpd-utils = { version = "0.2.1", optional = true }
 mpris = { version = "2.0.1", optional = true }

Cargo.toml

@@ -0,0 +1,133 @@
+Application menu that shows installed programs and optionally custom entries. Clicking the menu button will open the main menu, clicking on any application category will open a sub-menu with any installed applications that match.
+
+## Configuration
+
+> Type: `menu`
+
+|              | Type       | Default | Description                                                                                         |
+|--------------|------------|---------|-----------------------------------------------------------------------------------------------------|
+| `start`  | `MenuEntry[]` | `[]`    | List of menu entries |
+| `center` | `MenuEntry[]`  | default XDG menu | List of menu entries. By default this shows a number of XDG entries that should cover all common applications |
+| `end` | `MenuEntry[]` | `[]`    | List of menu entries |
+| `height`  | `integer | null`  | `null`    | The height of the menu, leave null for it to resize dynamically |
+| `width`   | `integer | null`  | `null` | The width of the menu, leave null for it to resize dynamically |
+| `max_label_length`   | `integer`  | `25` | Maximum length for the label of an XDG entry |
+| `label`   | `string | null`  | `≡` | The label of the button that opens the menu |
+| `label_icon`   | `string | null`  | `null` | An icon (from icon theme) to display on the button which opens the application menu |
+| `label_icon_size`   | `integer`  | `16` | Size of the label_icon if one is supplied |
+
+
+> Type: `MenuEntry`
+
+|              | Type       | Default | Description                                                                                         |
+|--------------|------------|---------|-----------------------------------------------------------------------------------------------------|
+| `type`  | `xdg_entry | xdg_other | custom` |    | Type of the entry |
+| `label` | `string`  | | Label of the entry's button |
+| `icon` | `string | null` | `null` | Icon for the entry's button |
+| `categories`  | `string[]` | | If `xdg_entry` this is is the list of freedesktop.org categories to include in this entry's sub menu |
+| `on_click`   | `string`  | | If `custom` this is a shell command to execute when the entry's button is clicked |
+
+<details>
+
+<summary>JSON</summary>
+
+```json
+{
+  "start": [
+    {
+      "type": "menu",
+      "start": [
+        {
+            "type": "custom",
+            "label": "Terminal",
+            "on_click": "xterm",
+        }
+      ],
+      "height": 440,
+      "width": 200,
+      "icon": "archlinux",
+      "label": null
+    }
+  ]
+}
+
+
+```
+
+</details>
+
+<details>
+<summary>TOML</summary>
+
+```toml
+[[start.menu]]
+height = 400
+width = 200
+icon = "archlinux"
+label = null
+
+[[start.menu.start]]
+type = "custom"
+label = "Terminal"
+on_click = "xterm"
+```
+
+</details>
+
+<details>
+<summary>YAML</summary>
+
+```yaml
+start:
+  - type: "menu"
+    start:
+      - type: custom
+        label: Terminal
+        on_click: xterm
+    height: 440
+    width: 200
+    icon: archlinux
+    label: null
+```
+
+</details>
+
+<details>
+<summary>Corn</summary>
+
+```corn
+{
+  start = [
+    {
+      type = "menu"
+      start = [
+        {
+            type = "custom"
+            label = "Terminal"
+            on_click = "xterm"
+        }
+      ]
+      height = 440
+      width = 200
+      icon = "archlinux"
+      label = null
+    }
+  ]
+}
+```
+
+</details>
+
+## Styling
+
+| Selector                      | Description                    |
+|-------------------------------|--------------------------------|
+| `.menu`                       | Menu button                    |
+| `.menu-popup`                 | Main container of the popup    |
+| `.menu-popup_main`            | Main menu of the menu          |
+| `.menu-popup_main_start`      | Container for `start` entries  |
+| `.menu-popup_main_center`     | Container for `center` entries |
+| `.menu-popup_main_end`        | Container for `end` entries    |
+| `.menu-popup_sub-menu`        | All sub-menues                 |
+
+For more information on styling, please see the [styling guide](styling-guide).

docs/modules/Menu.md

@@ -21,6 +21,8 @@ use crate::modules::keyboard::KeyboardModule;
 use crate::modules::label::LabelModule;
 #[cfg(feature = "launcher")]
 use crate::modules::launcher::LauncherModule;
+#[cfg(feature = "menu")]
+use crate::modules::menu::MenuModule;
 #[cfg(feature = "music")]
 use crate::modules::music::MusicModule;
 #[cfg(feature = "network_manager")]
@@ -75,6 +77,8 @@ pub enum ModuleConfig {
     Label(Box<LabelModule>),
     #[cfg(feature = "launcher")]
     Launcher(Box<LauncherModule>),
+    #[cfg(feature = "menu")]
+    Menu(Box<MenuModule>),
     #[cfg(feature = "music")]
     Music(Box<MusicModule>),
     #[cfg(feature = "network_manager")]
@@ -127,6 +131,8 @@ impl ModuleConfig {
             Self::Label(module) => create!(module),
             #[cfg(feature = "launcher")]
             Self::Launcher(module) => create!(module),
+            #[cfg(feature = "menu")]
+            Self::Menu(module) => create!(module),
             #[cfg(feature = "music")]
             Self::Music(module) => create!(module),
             #[cfg(feature = "network_manager")]

src/config/mod.rs

@@ -47,7 +47,7 @@ fn find_application_dirs() -> Vec<PathBuf> {
 }
 
 /// Finds all the desktop files
-fn find_desktop_files() -> Vec<PathBuf> {
+pub fn find_desktop_files() -> Vec<PathBuf> {
     let dirs = find_application_dirs();
     dirs.into_iter()
         .flat_map(|dir| {