feat: hide_empty_workspaces (#28)

amrbashir · web-flow · commit 3d5247519d49 · 2026-02-02T01:00:11.000+02:00
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -6,16 +6,17 @@
 
 - Added new config at `~/.config/komorebi-switcher.toml`
 - Added new "Settings" menu item in Right click menu and tray icon.
-- Added button to show active workspace layout and click to cycle through available layouts (Enable it through Settings or config).
+- Added `show_layout_button` option to show a button for active workspace layout, click to cycle through available layouts.
+- Added `hide_empty_workspaces` option to hide empty workspaces from the switcher.
 
 ### Changed
 
-- Migrated config options stored in Windows Registry to the new TOML config.
-- Active workspace indicator will no longer appear on top of the switcher button and will always be at the bottom of it.
+- **Windows** Migrated config options stored in Windows Registry to the new TOML config.
+- **Windows** Active workspace indicator will no longer appear on top of the switcher button and will always be at the bottom of it.
 
 ### Removed
 
-- Removed "Move and Resize" menu items from Right click menu and tray icon.
+- **Windows** Removed "Move and Resize" menu items from Right click menu and tray icon. Use the new "Settings" menu item.
 
 ## [0.9.2] - 2026-01-06
 
diff --git a/README.md b/README.md
@@ -37,6 +37,7 @@ or use the settings window accessible from the context menu.
 ```toml
 # Global settings
 show_layout_button = false
+hide_empty_workspaces = false
 
 # Settings for each monitor (Windows only for now)
 #   Syntax is [monitors.<id>] where <id> is one of:
@@ -53,6 +54,7 @@ height = 65
 auto_width = true
 auto_height = true
 show_layout_button = false # Can be removed to use the global setting
+hide_empty_workspaces = false # Can be removed to use the global setting
 ```
 
 ## Development
diff --git a/src/config.rs b/src/config.rs
@@ -14,6 +14,8 @@ pub struct WindowConfig {
     pub auto_height: bool,
     #[serde(default)]
     pub show_layout_button: Option<bool>,
+    #[serde(default)]
+    pub hide_empty_workspaces: Option<bool>,
 }
 
 #[derive(Debug, Clone, Serialize, Deserialize, Default)]
@@ -23,6 +25,9 @@ pub struct Config {
 
     #[serde(default)]
     pub show_layout_button: bool,
+
+    #[serde(default)]
+    pub hide_empty_workspaces: bool,
 }
 
 impl Config {
@@ -139,6 +144,7 @@ impl Config {
                     auto_width,
                     auto_height,
                     show_layout_button: None,
+                    hide_empty_workspaces: None,
                 },
             );
         }
diff --git a/src/macos/mod.rs b/src/macos/mod.rs
@@ -139,6 +139,10 @@ impl AppDelegate {
         };
 
         for workspace in &monitor.workspaces {
+            if config.hide_empty_workspaces && workspace.is_empty && !workspace.focused {
+                continue;
+            }
+
             let workspace_button = WorkspaceButton::new(mtm, workspace);
             stack_view.addArrangedSubview(&workspace_button);
             views.push(workspace_button.downcast().unwrap());
diff --git a/src/macos/windows/settings/view_controller.rs b/src/macos/windows/settings/view_controller.rs
@@ -39,13 +39,15 @@ define_class!(
 pub struct SettingsViewControllerIvars {
     config: RefCell<crate::config::Config>,
     show_layout_button_checkbox: RefCell<Option<Retained<NSButton>>>,
+    hide_empty_workspaces_checkbox: RefCell<Option<Retained<NSButton>>>,
 }
 
 impl SettingsViewControllerIvars {
     fn new(config: crate::config::Config) -> Self {
         Self {
             config: RefCell::new(config),
             show_layout_button_checkbox: RefCell::new(None),
+            hide_empty_workspaces_checkbox: RefCell::new(None),
         }
     }
 }
@@ -112,25 +114,34 @@ impl SettingsViewController {
         header
     }
 
-    fn create_global_settings_ui(&self) -> Retained<NSStackView> {
+    fn create_checkbox(&self, title: &str, initial_state: bool) -> Retained<NSButton> {
         let mtm = self.mtm();
 
-        let vstack = self.create_vstack();
-
         let checkbox = NSButton::new(mtm);
         checkbox.setButtonType(NSButtonType::Switch);
-        checkbox.setTitle(&NSString::from_str("Show layout button"));
-
-        let config = self.ivars().config.borrow();
-        checkbox.setState(if config.show_layout_button {
+        checkbox.setTitle(&NSString::from_str(title));
+        checkbox.setState(if initial_state {
             NSControlStateValueOn
         } else {
             NSControlStateValueOff
         });
 
-        vstack.addArrangedSubview(&checkbox);
+        checkbox
+    }
 
-        *self.ivars().show_layout_button_checkbox.borrow_mut() = Some(checkbox);
+    fn create_global_settings_ui(&self) -> Retained<NSStackView> {
+        let config = self.ivars().config.borrow();
+
+        let vstack = self.create_vstack();
+
+        let layout = self.create_checkbox("Show layout button", config.show_layout_button);
+        vstack.addArrangedSubview(&layout);
+        *self.ivars().show_layout_button_checkbox.borrow_mut() = Some(layout);
+
+        let label = "Hide empty workspaces";
+        let empty_workspace = self.create_checkbox(label, config.hide_empty_workspaces);
+        vstack.addArrangedSubview(&empty_workspace);
+        *self.ivars().hide_empty_workspaces_checkbox.borrow_mut() = Some(empty_workspace);
 
         vstack
     }
@@ -163,6 +174,14 @@ impl SettingsViewController {
         if let Some(checkbox) = self.ivars().show_layout_button_checkbox.borrow().as_ref() {
             config.show_layout_button = checkbox.state() == NSControlStateValueOn;
         }
+        if let Some(checkbox) = self
+            .ivars()
+            .hide_empty_workspaces_checkbox
+            .borrow()
+            .as_ref()
+        {
+            config.hide_empty_workspaces = checkbox.state() == NSControlStateValueOn;
+        }
         config.save()?;
         Ok(())
     }
diff --git a/src/windows/windows/settings.rs b/src/windows/windows/settings.rs
@@ -85,46 +85,62 @@ impl SettingsWindowView {
             &mut self.config.show_layout_button,
             "Show layout button",
         ));
+
+        ui.add(egui::Checkbox::new(
+            &mut self.config.hide_empty_workspaces,
+            "Hide empty workspaces",
+        ));
     }
 
-    fn layout_button_ui(&mut self, ui: &mut egui::Ui, monitor_id: &str) {
+    fn show_layout_button_ui(&mut self, ui: &mut egui::Ui, monitor_id: &str) {
         let monitor_config = self.config.get_monitor_or_default(monitor_id);
 
         ui.label("Show layout button");
 
-        #[derive(Copy, Clone, PartialEq, strum::Display)]
-        enum ShowLayoutButton {
-            Inherit,
-            Show,
-            Hide,
+        let mut selected: ActivationOption = monitor_config.show_layout_button.into();
+
+        let before = selected;
+
+        egui::ComboBox::new("show_layout_button", "")
+            .selected_text(format!("{}", selected))
+            .show_ui(ui, |ui| {
+                for option in [
+                    ActivationOption::Inherit,
+                    ActivationOption::Enable,
+                    ActivationOption::Disable,
+                ] {
+                    ui.selectable_value(&mut selected, option, format!("{}", option));
+                }
+            });
+
+        if before != selected {
+            monitor_config.show_layout_button = selected.into();
         }
+    }
 
-        let mut selected = match monitor_config.show_layout_button {
-            None => ShowLayoutButton::Inherit,
-            Some(true) => ShowLayoutButton::Show,
-            Some(false) => ShowLayoutButton::Hide,
-        };
+    fn hide_empty_workspaces_ui(&mut self, ui: &mut egui::Ui, monitor_id: &str) {
+        let monitor_config = self.config.get_monitor_or_default(monitor_id);
+
+        ui.label("Hide empty workspaces");
+
+        let mut selected: ActivationOption = monitor_config.hide_empty_workspaces.into();
 
         let before = selected;
 
-        egui::ComboBox::from_label("")
+        egui::ComboBox::new("hide_empty_workspaces", "")
             .selected_text(format!("{}", selected))
             .show_ui(ui, |ui| {
                 for option in [
-                    ShowLayoutButton::Inherit,
-                    ShowLayoutButton::Show,
-                    ShowLayoutButton::Hide,
+                    ActivationOption::Inherit,
+                    ActivationOption::Enable,
+                    ActivationOption::Disable,
                 ] {
                     ui.selectable_value(&mut selected, option, format!("{}", option));
                 }
             });
 
         if before != selected {
-            monitor_config.show_layout_button = match selected {
-                ShowLayoutButton::Inherit => None,
-                ShowLayoutButton::Show => Some(true),
-                ShowLayoutButton::Hide => Some(false),
-            };
+            monitor_config.hide_empty_workspaces = selected.into();
         }
     }
 
@@ -159,7 +175,10 @@ impl SettingsWindowView {
         });
         ui.end_row();
 
-        self.layout_button_ui(ui, monitor_id);
+        self.show_layout_button_ui(ui, monitor_id);
+        ui.end_row();
+
+        self.hide_empty_workspaces_ui(ui, monitor_id);
         ui.end_row();
     }
 
@@ -227,3 +246,31 @@ impl EguiView for SettingsWindowView {
         egui::CentralPanel::default().show(ctx, |ui| self.ui(ui));
     }
 }
+
+/// Represents an activation option for a setting: Inherit, Enable, or Disable.
+#[derive(Copy, Clone, PartialEq, strum::Display)]
+enum ActivationOption {
+    Inherit,
+    Enable,
+    Disable,
+}
+
+impl From<ActivationOption> for Option<bool> {
+    fn from(option: ActivationOption) -> Self {
+        match option {
+            ActivationOption::Inherit => None,
+            ActivationOption::Enable => Some(false),
+            ActivationOption::Disable => Some(true),
+        }
+    }
+}
+
+impl From<Option<bool>> for ActivationOption {
+    fn from(option: Option<bool>) -> Self {
+        match option {
+            None => ActivationOption::Inherit,
+            Some(true) => ActivationOption::Disable,
+            Some(false) => ActivationOption::Enable,
+        }
+    }
+}
diff --git a/src/windows/windows/switcher/mod.rs b/src/windows/windows/switcher/mod.rs
@@ -224,8 +224,19 @@ impl SwitcherWindowView {
             ui.scope(|ui| {
                 ui.style_mut().spacing.item_spacing = egui::vec2(4., 4.);
 
+                let config = self.effective_config();
+                let monitor_config = config.get_monitor(&self.monitor_state.id);
+                let hide_empty_workspaces = match monitor_config.hide_empty_workspaces {
+                    Some(hide) => hide,
+                    None => config.hide_empty_workspaces,
+                };
+
                 // show workspace buttons
                 for workspace in self.monitor_state.workspaces.iter() {
+                    if hide_empty_workspaces && workspace.is_empty && !workspace.focused {
+                        continue;
+                    }
+
                     let btn = WorkspaceButton::new(workspace)
                         .dark_mode(Some(self.is_system_dark_mode()))
                         .line_focused_color_opt(self.line_focused_color())
@@ -240,8 +251,6 @@ impl SwitcherWindowView {
                 }
 
                 // show layout button for focused workspace
-                let config = self.effective_config();
-                let monitor_config = config.get_monitor(&self.monitor_state.id);
                 let show_layout_button = match monitor_config.show_layout_button {
                     Some(show) => show,
                     None => config.show_layout_button,
