Merge pull request #837 from BowDown097/master

JakeStanger · web-flow · commit 49ab7e0c7bc8 · 2025-02-15T22:43:46.000Z
feat: icon overrides
diff --git a/docs/Configuration guide.md b/docs/Configuration guide.md
@@ -280,10 +280,11 @@ Check [here](config) for an example config file for a fully configured bar in ea
 
 The following table lists each of the top-level bar config options:
 
-| Name               | Type                                    | Default | Description                                                   |
-|--------------------|-----------------------------------------|---------|---------------------------------------------------------------|
-| `ironvar_defaults` | `Map<string, string>`                   | `{}`    | Map of [ironvar](ironvars) keys against their default values. |
-| `monitors`         | `Map<string, BarConfig or BarConfig[]>` | `null`  | Map of monitor names against bar configs.                     |
+| Name               | Type                                    | Default | Description                                                                   |
+|--------------------|-----------------------------------------|---------|-------------------------------------------------------------------------------|
+| `ironvar_defaults` | `Map<string, string>`                   | `{}`    | Map of [ironvar](ironvars) keys against their default values.                 |
+| `monitors`         | `Map<string, BarConfig or BarConfig[]>` | `null`  | Map of monitor names against bar configs.                                     |
+| `icon_overrides`   | `Map<string, string>`                   | `{}`    | Map of app IDs (or classes) to icon names, overriding the app's default icon. |
 
 > [!TIP]
 > `monitors` is only required if you are following **2b** or **2c** (ie not the same bar across all monitors).
@@ -353,4 +354,4 @@ For information on the `Script` type, and embedding scripts in strings, see [her
 | `name`    | `string` | `null`  | Sets the unique widget name, allowing you to style it using `#name`.              |
 | `class`   | `string` | `null`  | Sets one or more CSS classes, allowing you to style it using `.class`.            |
 
-For more information on styling, please see the [styling guide](styling-guide).
+For more information on styling, please see the [styling guide](styling-guide).
diff --git a/docs/modules/Launcher.md b/docs/modules/Launcher.md
@@ -15,7 +15,7 @@ Optionally displays a launchable set of favourites.
 
 |                             | Type                                        | Default  | Description                                                                                                              |
 |-----------------------------|---------------------------------------------|----------|--------------------------------------------------------------------------------------------------------------------------|
-| `favorites`                 | `string[]`                                  | `[]`     | List of app IDs (or classes) to always show at the start of the launcher                                                 |
+| `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).                                                                               |
diff --git a/src/bar.rs b/src/bar.rs
@@ -8,7 +8,9 @@ use gtk::gdk::Monitor;
 use gtk::prelude::*;
 use gtk::{Application, ApplicationWindow, IconTheme, Orientation, Window, WindowType};
 use gtk_layer_shell::LayerShell;
+use std::collections::HashMap;
 use std::rc::Rc;
+use std::sync::Arc;
 use std::time::Duration;
 use tracing::{debug, info};
 
@@ -23,6 +25,7 @@ pub struct Bar {
     name: String,
     monitor_name: String,
     monitor_size: (i32, i32),
+    icon_overrides: Arc<HashMap<String, String>>,
     position: BarPosition,
 
     ironbar: Rc<Ironbar>,
@@ -43,6 +46,7 @@ impl Bar {
         app: &Application,
         monitor_name: String,
         monitor_size: (i32, i32),
+        icon_overrides: Arc<HashMap<String, String>>,
         config: BarConfig,
         ironbar: Rc<Ironbar>,
     ) -> Self {
@@ -92,6 +96,7 @@ impl Bar {
             name,
             monitor_name,
             monitor_size,
+            icon_overrides,
             position,
             ironbar,
             window,
@@ -268,6 +273,7 @@ impl Bar {
                     output_name: &self.monitor_name,
                     location: $location,
                     icon_theme: &icon_theme,
+                    icon_overrides: self.icon_overrides.clone(),
                 }
             };
         }
@@ -398,9 +404,17 @@ pub fn create_bar(
     monitor: &Monitor,
     monitor_name: String,
     monitor_size: (i32, i32),
+    icon_overrides: Arc<HashMap<String, String>>,
     config: BarConfig,
     ironbar: Rc<Ironbar>,
 ) -> Result<Bar> {
-    let bar = Bar::new(app, monitor_name, monitor_size, config, ironbar);
+    let bar = Bar::new(
+        app,
+        monitor_name,
+        monitor_size,
+        icon_overrides,
+        config,
+        ironbar,
+    );
     bar.init(monitor)
 }
diff --git a/src/config/mod.rs b/src/config/mod.rs
@@ -388,6 +388,13 @@ pub struct Config {
     ///
     /// Providing this option overrides the single, global `bar` option.
     pub monitors: Option<HashMap<String, MonitorConfig>>,
+
+    /// Map of app IDs (or classes) to icon names,
+    /// overriding the app's default icon.
+    ///
+    /// **Default**: `{}`
+    #[serde(default)]
+    pub icon_overrides: HashMap<String, String>,
 }
 
 const fn default_layer() -> gtk_layer_shell::Layer {
diff --git a/src/main.rs b/src/main.rs
@@ -383,6 +383,7 @@ fn load_output_bars(
     };
 
     let config = ironbar.config.borrow();
+    let icon_overrides = Arc::new(config.icon_overrides.clone());
     let display = get_display();
 
     // let pos = output.logical_position.unwrap_or_default();
@@ -406,6 +407,7 @@ fn load_output_bars(
                 &monitor,
                 monitor_name.to_string(),
                 output_size,
+                icon_overrides,
                 config.clone(),
                 ironbar.clone(),
             )?]
@@ -418,6 +420,7 @@ fn load_output_bars(
                     &monitor,
                     monitor_name.to_string(),
                     output_size,
+                    icon_overrides.clone(),
                     config.clone(),
                     ironbar.clone(),
                 )
@@ -428,6 +431,7 @@ fn load_output_bars(
             &monitor,
             monitor_name.to_string(),
             output_size,
+            icon_overrides,
             config.bar.clone(),
             ironbar.clone(),
         )?],
diff --git a/src/modules/focused.rs b/src/modules/focused.rs
@@ -132,8 +132,6 @@ impl Module<gtk::Box> for FocusedModule {
         context: WidgetContext<Self::SendMessage, Self::ReceiveMessage>,
         info: &ModuleInfo,
     ) -> Result<ModuleParts<gtk::Box>> {
-        let icon_theme = info.icon_theme;
-
         let container = gtk::Box::new(info.bar_position.orientation(), 5);
 
         let icon = gtk::Image::new();
@@ -152,10 +150,17 @@ impl Module<gtk::Box> for FocusedModule {
         container.add(&label);
 
         {
-            let icon_theme = icon_theme.clone();
+            let icon_overrides = info.icon_overrides.clone();
+            let icon_theme = info.icon_theme.clone();
+
             glib_recv!(context.subscribe(), data => {
-                if let Some((name, id)) = data {
+                if let Some((name, mut id)) = data {
                     if self.show_icon {
+
+                        if let Some(icon) = icon_overrides.get(&id) {
+                            id = icon.clone();
+                        }
+
                         match ImageProvider::parse(&id, &icon_theme, true, self.icon_size)
                             .map(|image| image.load_into_image(&icon))
                         {
diff --git a/src/modules/launcher/item.rs b/src/modules/launcher/item.rs
@@ -24,16 +24,23 @@ pub struct Item {
     pub open_state: OpenState,
     pub windows: IndexMap<usize, Window>,
     pub name: String,
+    pub icon_override: String,
 }
 
 impl Item {
-    pub fn new(app_id: String, open_state: OpenState, favorite: bool) -> Self {
+    pub fn new(
+        app_id: String,
+        icon_override: String,
+        open_state: OpenState,
+        favorite: bool,
+    ) -> Self {
         Self {
             app_id,
             favorite,
             open_state,
             windows: IndexMap::new(),
             name: String::new(),
+            icon_override,
         }
     }
 
@@ -108,6 +115,7 @@ impl From<ToplevelInfo> for Item {
             open_state,
             windows,
             name,
+            icon_override: String::new(),
         }
     }
 }
@@ -167,7 +175,9 @@ impl ItemButton {
         }
 
         if appearance.show_icons {
-            let input = if item.app_id.is_empty() {
+            let input = if !item.icon_override.is_empty() {
+                item.icon_override.clone()
+            } else if item.app_id.is_empty() {
                 item.name.clone()
             } else {
                 item.app_id.clone()
diff --git a/src/modules/launcher/mod.rs b/src/modules/launcher/mod.rs
@@ -138,7 +138,7 @@ impl Module<gtk::Box> for LauncherModule {
 
     fn spawn_controller(
         &self,
-        _info: &ModuleInfo,
+        info: &ModuleInfo,
         context: &WidgetContext<Self::SendMessage, Self::ReceiveMessage>,
         mut rx: mpsc::Receiver<Self::ReceiveMessage>,
     ) -> crate::Result<()> {
@@ -149,18 +149,24 @@ impl Module<gtk::Box> for LauncherModule {
                 favorites
                     .iter()
                     .map(|app_id| {
+                        let icon_override = info
+                            .icon_overrides
+                            .get(app_id)
+                            .map_or_else(String::new, |v| v.to_string());
+
                         (
                             app_id.to_string(),
-                            Item::new(app_id.to_string(), OpenState::Closed, true),
+                            Item::new(app_id.to_string(), icon_override, OpenState::Closed, true),
                         )
                     })
                     .collect::<IndexMap<_, _>>()
             });
 
         let items = arc_mut!(items);
-
         let items2 = Arc::clone(&items);
 
+        let icon_overrides = info.icon_overrides.clone();
+
         let tx = context.tx.clone();
         let tx2 = context.tx.clone();
 
@@ -180,7 +186,13 @@ impl Module<gtk::Box> for LauncherModule {
                         item.merge_toplevel(info.clone());
                     }
                     None => {
-                        items.insert(info.app_id.clone(), Item::from(info.clone()));
+                        let mut item = Item::from(info.clone());
+
+                        if let Some(icon) = icon_overrides.get(&info.app_id) {
+                            item.icon_override = icon.clone();
+                        }
+
+                        items.insert(info.app_id.clone(), item);
                     }
                 }
             }
@@ -210,7 +222,11 @@ impl Module<gtk::Box> for LauncherModule {
                             let item = items.get_mut(&info.app_id);
                             match item {
                                 None => {
-                                    let item: Item = info.into();
+                                    let mut item: Item = info.into();
+
+                                    if let Some(icon) = icon_overrides.get(&app_id) {
+                                        item.icon_override = icon.clone();
+                                    }
 
                                     items.insert(app_id.clone(), item.clone());
 
diff --git a/src/modules/mod.rs b/src/modules/mod.rs
@@ -1,3 +1,4 @@
+use std::collections::HashMap;
 use std::fmt::Debug;
 use std::rc::Rc;
 use std::sync::Arc;
@@ -71,6 +72,7 @@ pub struct ModuleInfo<'a> {
     pub monitor: &'a Monitor,
     pub output_name: &'a str,
     pub icon_theme: &'a IconTheme,
+    pub icon_overrides: Arc<HashMap<String, String>>,
 }
 
 #[derive(Debug, Clone)]

Original file line number	Diff line number	Diff line change
`@@ -24,16 +24,23 @@ pub struct Item {`
`24`	`24`	`pub open_state: OpenState,`
`25`	`25`	`pub windows: IndexMap<usize, Window>,`
`26`	`26`	`pub name: String,`
	`27`	`+ pub icon_override: String,`
`27`	`28`	`}`
`28`	`29`
`29`	`30`	`impl Item {`
`30`		`- pub fn new(app_id: String, open_state: OpenState, favorite: bool) -> Self {`
	`31`	`+ pub fn new(`
	`32`	`+ app_id: String,`
	`33`	`+ icon_override: String,`
	`34`	`+ open_state: OpenState,`
	`35`	`+ favorite: bool,`
	`36`	`+ ) -> Self {`
`31`	`37`	`Self {`
`32`	`38`	`app_id,`
`33`	`39`	`favorite,`
`34`	`40`	`open_state,`
`35`	`41`	`windows: IndexMap::new(),`
`36`	`42`	`name: String::new(),`
	`43`	`+ icon_override,`
`37`	`44`	`}`
`38`	`45`	`}`
`39`	`46`
`@@ -108,6 +115,7 @@ impl From<ToplevelInfo> for Item {`
`108`	`115`	`open_state,`
`109`	`116`	`windows,`
`110`	`117`	`name,`
	`118`	`+ icon_override: String::new(),`
`111`	`119`	`}`
`112`	`120`	`}`
`113`	`121`	`}`
`@@ -167,7 +175,9 @@ impl ItemButton {`
`167`	`175`	`}`
`168`	`176`
`169`	`177`	`if appearance.show_icons {`
`170`		`- let input = if item.app_id.is_empty() {`
	`178`	`+ let input = if !item.icon_override.is_empty() {`
	`179`	`+ item.icon_override.clone()`
	`180`	`+ } else if item.app_id.is_empty() {`
`171`	`181`	`item.name.clone()`
`172`	`182`	`} else {`
`173`	`183`	`item.app_id.clone()`