mirror of
https://github.com/Zedfrigg/ironbar.git
synced 2025-08-16 06:11:03 +02:00
Update docs to mention {app_name} in launch_command
This commit is contained in:
Username404-59
parent
d2f46a59b4
commit
8dfca4303d
2 changed files with 33 additions and 33 deletions
|
|
@ -13,24 +13,24 @@ Optionally displays a launchable set of favourites.
|
|||
|
||||
> Type: `launcher`
|
||||
|
||||
| | Type | Default | Description |
|
||||
|-----------------------------|---------------------------------------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `favorites` | `string[]` | `[]` | List of app IDs (or classes) to always show at the start of the launcher. |
|
||||
| `show_names` | `boolean` | `false` | Whether to show app names on the button label. Names will still show on tooltips when set to false. |
|
||||
| `show_icons` | `boolean` | `true` | Whether to show app icons on the button. |
|
||||
| `icon_size` | `integer` | `32` | Size to render icon at (image icons only). |
|
||||
| `launch_command` | `string` | `gtk-launch` | Command used to launch applications. |
|
||||
| `reversed` | `boolean` | `false` | Whether to reverse the order of favorites/items |
|
||||
| `minimize_focused` | `boolean` | `true` | Whether to minimize a focused window when its icon is clicked. Only minimizes single windows. |
|
||||
| `truncate.mode` | `'start'` or `'middle'` or `'end'` or `off` | `end` | Location of the ellipses and where to truncate text from. Applies to application names when `show_names` is enabled. |
|
||||
| `truncate.length` | `integer` | `null` | Fixed width (in chars) of the widget. Leave blank to let GTK automatically handle. |
|
||||
| `truncate.max_length` | `integer` | `null` | Maximum number of characters before truncating. Leave blank to let GTK automatically handle. |
|
||||
| `truncate_popup.mode` | `'start'` or `'middle'` or `'end'` or `off` | `middle` | Location of the ellipses and where to truncate text from. Applies to window names within a group popup. |
|
||||
| `truncate_popup.length` | `integer` | `null` | Fixed width (in chars) of the widget. Leave blank to let GTK automatically handle. |
|
||||
| `truncate_popup.max_length` | `integer` | `25` | Maximum number of characters before truncating. Leave blank to let GTK automatically handle. |
|
||||
| `page_size` | `integer` | `1000` | Number of items to show on a page. When the number of items is reached, controls appear which can be used to move forward/back through the list of items. |
|
||||
| `icons.page_back` | `string` or [image](images) | `` | Icon to show for page back button. |
|
||||
| `icons.page_forward` | `string` or [image](images) | `` | Icon to show for page forward button. |
|
||||
| | Type | Default | Description |
|
||||
|-----------------------------|---------------------------------------------|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `favorites` | `string[]` | `[]` | List of app IDs (or classes) to always show at the start of the launcher. |
|
||||
| `show_names` | `boolean` | `false` | Whether to show app names on the button label. Names will still show on tooltips when set to false. |
|
||||
| `show_icons` | `boolean` | `true` | Whether to show app icons on the button. |
|
||||
| `icon_size` | `integer` | `32` | Size to render icon at (image icons only). |
|
||||
| `launch_command` | `string` | `gtk-launch {app_name}` | Command used to launch applications. |
|
||||
| `reversed` | `boolean` | `false` | Whether to reverse the order of favorites/items |
|
||||
| `minimize_focused` | `boolean` | `true` | Whether to minimize a focused window when its icon is clicked. Only minimizes single windows. |
|
||||
| `truncate.mode` | `'start'` or `'middle'` or `'end'` or `off` | `end` | Location of the ellipses and where to truncate text from. Applies to application names when `show_names` is enabled. |
|
||||
| `truncate.length` | `integer` | `null` | Fixed width (in chars) of the widget. Leave blank to let GTK automatically handle. |
|
||||
| `truncate.max_length` | `integer` | `null` | Maximum number of characters before truncating. Leave blank to let GTK automatically handle. |
|
||||
| `truncate_popup.mode` | `'start'` or `'middle'` or `'end'` or `off` | `middle` | Location of the ellipses and where to truncate text from. Applies to window names within a group popup. |
|
||||
| `truncate_popup.length` | `integer` | `null` | Fixed width (in chars) of the widget. Leave blank to let GTK automatically handle. |
|
||||
| `truncate_popup.max_length` | `integer` | `25` | Maximum number of characters before truncating. Leave blank to let GTK automatically handle. |
|
||||
| `page_size` | `integer` | `1000` | Number of items to show on a page. When the number of items is reached, controls appear which can be used to move forward/back through the list of items. |
|
||||
| `icons.page_back` | `string` or [image](images) | `` | Icon to show for page back button. |
|
||||
| `icons.page_forward` | `string` or [image](images) | `` | Icon to show for page forward button. |
|
||||
<details>
|
||||
<summary>JSON</summary>
|
||||
|
||||
|
|
|
|||
|
|
@ -10,21 +10,21 @@ It is also possible to add custom categories and actions into the menu.
|
|||
|
||||
## Configuration
|
||||
|
||||
| | Type | Default | Description |
|
||||
|-----------------------|------------------------------------------------------|------------------|-------------------------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `start` | `MenuEntry[]` | `[]` | Items to add to the start of the main menu. |
|
||||
| `center` | `MenuEntry[]` | Default XDG menu | Items to add to the centre of the main menu. By default this shows a number of XDG entries that should cover all common applications. |
|
||||
| `end` | `MenuEntry[]` | `[]` | Items to add to the end of the main menu. |
|
||||
| `height` | `integer` | `null` | Height of the menu. Leave null to resize dynamically. |
|
||||
| `width` | `integer` | `null` | Width of the menu. Leave null to resize dynamically. |
|
||||
| `label` | `string` | `≡` | Label to show on the menu button on the bar. |
|
||||
| `label_icon` | `string` | `null` | Icon to show on the menu button on the bar. |
|
||||
| `label_icon_size` | `integer` | `16` | Size of the label_icon image. |
|
||||
| `launch_command` | `string` | `gtk-launch` | Command used to launch applications. |
|
||||
| `truncate` | `'start'` or `'middle'` or `'end'` or `off` or `Map` | `off` | Applies to popup. The location of the ellipses and where to truncate text from. Leave null to avoid truncating. Use the long-hand `Map` version if specifying a length. |
|
||||
| `truncate.mode` | `'start'` or `'middle'` or `'end'` or `off` | `off` | Applies to popup. The location of the ellipses and where to truncate text from. Leave null to avoid truncating. |
|
||||
| `truncate.length` | `integer` | `null` | Applies to popup. The fixed width (in chars) of the widget. Leave blank to let GTK automatically handle. |
|
||||
| `truncate.max_length` | `integer` | `null` | Applies to popup. The maximum number of characters before truncating. Leave blank to let GTK automatically handle. |
|
||||
| | Type | Default | Description |
|
||||
|-----------------------|------------------------------------------------------|-------------------------|-----------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `start` | `MenuEntry[]` | `[]` | Items to add to the start of the main menu. |
|
||||
| `center` | `MenuEntry[]` | Default XDG menu | Items to add to the centre of the main menu. By default this shows a number of XDG entries that should cover all common applications. |
|
||||
| `end` | `MenuEntry[]` | `[]` | Items to add to the end of the main menu. |
|
||||
| `height` | `integer` | `null` | Height of the menu. Leave null to resize dynamically. |
|
||||
| `width` | `integer` | `null` | Width of the menu. Leave null to resize dynamically. |
|
||||
| `label` | `string` | `≡` | Label to show on the menu button on the bar. |
|
||||
| `label_icon` | `string` | `null` | Icon to show on the menu button on the bar. |
|
||||
| `label_icon_size` | `integer` | `16` | Size of the label_icon image. |
|
||||
| `launch_command` | `string` | `gtk-launch {app_name}` | Command used to launch applications. |
|
||||
| `truncate` | `'start'` or `'middle'` or `'end'` or `off` or `Map` | `off` | Applies to popup. The location of the ellipses and where to truncate text from. Leave null to avoid truncating. Use the long-hand `Map` version if specifying a length. |
|
||||
| `truncate.mode` | `'start'` or `'middle'` or `'end'` or `off` | `off` | Applies to popup. The location of the ellipses and where to truncate text from. Leave null to avoid truncating. |
|
||||
| `truncate.length` | `integer` | `null` | Applies to popup. The fixed width (in chars) of the widget. Leave blank to let GTK automatically handle. |
|
||||
| `truncate.max_length` | `integer` | `null` | Applies to popup. The maximum number of characters before truncating. Leave blank to let GTK automatically handle. |
|
||||
|
||||
|
||||
### `MenuEntry`
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue