feat: Add Menu module #609
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -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. | ||
|
|
||
|
There was a problem hiding this comment. Reminder for myself to add an image (no need to action anything) |
||
| ## 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 | | ||
|
There was a problem hiding this comment. If you set this, does it append to or replace the XDG entries? There was a problem hiding this comment. It will replace the default entries. It might be worthwhile to list the default entries in the documentation in case you want some of them but not others. |
||
| | `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]] | ||
|
There was a problem hiding this comment. I'm not actually sure this is correct, the way ironbar handles TOML is a bit confusing to me. There was a problem hiding this comment. Ironbar is just using the standard Generally I write the corn config and then use its CLI to generate the other three formats, which isn't necessarily the most readable but at least ensures they're valid. I think here, you actually want something like (shortened and untested): [[start]]
type = "menu"
[[start.start]]
type = "custom" |
||
| 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). | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Oops, something went wrong.
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
freedesktop_entry_parser is needed to parse .desktop entries which it doesn't seem ironbar was doing until now. There's one other rust library that can do that but this one seemed lighter-weight and more stable.
unicode-segmentation is needed for truncating menu entries which is really needed because some common .desktop files (like the JDK) have really long names. As far as I can tell there's no actually safe way to truncate unicode strings in the Rust stdlib.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
There is .desktop file parsing happening in the
desktop_filemodule already. Did you not spot that, or does that not do what is necessary here?In some other modules (
music,focused) these are already using a (partially) commontruncateoption that hooks into GTK's in-built truncation/elipsize system. I'd prefer to use that here, although I'm open to integratingunicode-segmentationand having awordsmode there.