zedfrigg/ironbar
1
0
Fork 0
mirror of https://github.com/Zedfrigg/ironbar.git synced 2025-08-16 22:31:03 +02:00
Code Activity

Merge pull request #1047 from postsolar/feat/volume-input-truncate

Browse source 
feat(volume): Add `truncate` option for `volume` popup
This commit is contained in:
Jake Stanger 2025-06-16 09:55:08 +01:00 • committed by GitHub
commit ff9f4477bb
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 28 additions and 10 deletions
Download patch file Download diff file Expand all files Collapse all files

27
docs/modules/Volume.md
View file

@ -1,6 +1,7 @@
Displays the current volume level. Displays the current volume level.
Clicking on the widget opens a volume mixer, which allows you to change the device output level, Clicking on the widget opens a volume mixer, which allows you to change the device output level,
the default playback device, and control application volume levels individually. the default playback device, and control application volume levels individually.
Use `truncate` option to control the display of application titles in the volume mixer.
This requires PulseAudio to function (`pipewire-pulse` is supported). This requires PulseAudio to function (`pipewire-pulse` is supported).
@ -10,14 +11,18 @@ This requires PulseAudio to function (`pipewire-pulse` is supported).
> Type: `volume` > Type: `volume`
| Name | Type | Default | Description | | Name | Type | Default | Description |
|-----------------------|----------|------------------------|----------------------------------------------------------------------------------------------------------------| |-----------------------|------------------------------------------------------|------------------------|----------------------------------------------------------------------------------------------------------------|
| `format` | `string` | `{icon} {percentage}%` | Format string to use for the widget button label. | | `format` | `string` | `{icon} {percentage}%` | Format string to use for the widget button label. |
| `max_volume` | `float` | `100` | Maximum value to allow volume sliders to reach. Pulse supports values > 100 but this may result in distortion. | | `max_volume` | `float` | `100` | Maximum value to allow volume sliders to reach. Pulse supports values > 100 but this may result in distortion. |
| `icons.volume_high` | `string` | `󰕾` | Icon to show for high volume levels. | | `icons.volume_high` | `string` | `󰕾` | Icon to show for high volume levels. |
| `icons.volume_medium` | `string` | `󰖀` | Icon to show for medium volume levels. | | `icons.volume_medium` | `string` | `󰖀` | Icon to show for medium volume levels. |
| `icons.volume_low` | `string` | `󰕿` | Icon to show for low volume levels. | | `icons.volume_low` | `string` | `󰕿` | Icon to show for low volume levels. |
| `icons.muted` | `string` | `󰝟` | Icon to show for muted outputs. | | `icons.muted` | `string` | `󰝟` | Icon to show for muted outputs. |
| `truncate` | `'start'` or `'middle'` or `'end'` or `off` or `Map` | `off` | 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` | The location of the ellipses and where to truncate text from. Leave null to avoid truncating. |
| `truncate.length` | `integer` | `null` | The fixed width (in chars) of the widget. Leave blank to let GTK automatically handle. |
| `truncate.max_length` | `integer` | `null` | The maximum number of characters before truncating. Leave blank to let GTK automatically handle. |
<details> <details>
<summary>JSON</summary> <summary>JSON</summary>
@ -29,6 +34,7 @@ This requires PulseAudio to function (`pipewire-pulse` is supported).
"type": "volume", "type": "volume",
"format": "{icon} {percentage}%", "format": "{icon} {percentage}%",
"max_volume": 100, "max_volume": 100,
"truncate": "middle",
"icons": { "icons": {
"volume_high": "󰕾", "volume_high": "󰕾",
"volume_medium": "󰖀", "volume_medium": "󰖀",
@ -51,6 +57,7 @@ This requires PulseAudio to function (`pipewire-pulse` is supported).
type = "volume" type = "volume"
format = "{icon} {percentage}%" format = "{icon} {percentage}%"
max_volume = 100 max_volume = 100
truncate = "middle"
[end.icons] [end.icons]
volume_high = "󰕾" volume_high = "󰕾"
@ -69,6 +76,7 @@ end:
- type: "volume" - type: "volume"
format: "{icon} {percentage}%" format: "{icon} {percentage}%"
max_volume: 100 max_volume: 100
truncate: "middle"
icons: icons:
volume_high: "󰕾" volume_high: "󰕾"
volume_medium: "󰖀" volume_medium: "󰖀"
@ -88,6 +96,7 @@ end:
type = "volume" type = "volume"
format = "{icon} {percentage}%" format = "{icon} {percentage}%"
max_volume = 100 max_volume = 100
truncate = "end"
icons.volume_high = "󰕾" icons.volume_high = "󰕾"
icons.volume_medium = "󰖀" icons.volume_medium = "󰖀"
icons.volume_low = "󰕿" icons.volume_low = "󰕿"
@ -125,4 +134,4 @@ The following tokens can be used in the `format` config option:
| `.popup-volume .apps-box .app-box .slider` | Application volume slider. | | `.popup-volume .apps-box .app-box .slider` | Application volume slider. |
| `.popup-volume .apps-box .app-box .btn-mute` | Application volume mute toggle button. | | `.popup-volume .apps-box .app-box .btn-mute` | Application volume mute toggle button. |
For more information on styling, please see the [styling guide](styling-guide). For more information on styling, please see the [styling guide](styling-guide).

11
src/modules/volume.rs
View file

@ -1,6 +1,6 @@
use crate::channels::{AsyncSenderExt, BroadcastReceiverExt}; use crate::channels::{AsyncSenderExt, BroadcastReceiverExt};
use crate::clients::volume::{self, Event}; use crate::clients::volume::{self, Event};
use crate::config::{CommonConfig, LayoutConfig}; use crate::config::{CommonConfig, LayoutConfig, TruncateMode};
use crate::gtk_helpers::{IronbarGtkExt, IronbarLabelExt}; use crate::gtk_helpers::{IronbarGtkExt, IronbarLabelExt};
use crate::modules::{ use crate::modules::{
Module, ModuleInfo, ModuleParts, ModulePopup, ModuleUpdateEvent, PopupButton, WidgetContext, Module, ModuleInfo, ModuleParts, ModulePopup, ModuleUpdateEvent, PopupButton, WidgetContext,
@ -39,6 +39,11 @@ pub struct VolumeModule {
icons: Icons, icons: Icons,
// -- Common -- // -- Common --
/// See [truncate options](module-level-options#truncate-mode).
///
/// **Default**: `null`
pub(crate) truncate: Option<TruncateMode>,
/// See [layout options](module-level-options#layout) /// See [layout options](module-level-options#layout)
#[serde(default, flatten)] #[serde(default, flatten)]
layout: LayoutConfig, layout: LayoutConfig,
@ -403,6 +408,10 @@ impl Module<Button> for VolumeModule {
let label = Label::new(Some(&info.name)); let label = Label::new(Some(&info.name));
label.add_class("title"); label.add_class("title");
if let Some(truncate) = self.truncate {
label.truncate(truncate);
};
let slider = Scale::builder().sensitive(info.can_set_volume).build(); let slider = Scale::builder().sensitive(info.can_set_volume).build();
slider.set_range(0.0, self.max_volume); slider.set_range(0.0, self.max_volume);
slider.set_value(info.volume); slider.set_value(info.volume);