feat(ui): resize shortcuts (#4003)

* feat(ui): show resize and focus shortcuts when relevant * update serialization and snapshots * update e2e tests * style(fmt): rustfmt
zellij-org · Feb 18, 2025 · 544982d · 544982d
1 parent 5b6a0e6
commit 544982d
Show file tree

Hide file tree

Showing 52 changed files with 241 additions and 89 deletions.
diff --git a/default-plugins/status-bar/src/one_line_ui.rs b/default-plugins/status-bar/src/one_line_ui.rs
@@ -682,9 +682,22 @@ fn render_secondary_info(
     }
 }
 
+fn should_show_focus_and_resize_shortcuts(tab_info: Option<&TabInfo>) -> bool {
+    let Some(tab_info) = tab_info else {
+        return false;
+    };
+    let are_floating_panes_visible = tab_info.are_floating_panes_visible;
+    if are_floating_panes_visible {
+        tab_info.selectable_floating_panes_count > 1
+    } else {
+        tab_info.selectable_tiled_panes_count > 1
+    }
+}
+
 fn secondary_keybinds(help: &ModeInfo, tab_info: Option<&TabInfo>, max_len: usize) -> LinePart {
     let mut secondary_info = LinePart::default();
     let binds = &help.get_mode_keybinds();
+    let should_show_focus_and_resize_shortcuts = should_show_focus_and_resize_shortcuts(tab_info);
     // New Pane
     let new_pane_action_key = action_key(binds, &[Action::NewPane(None, None, false)]);
     let mut new_pane_key_to_display = new_pane_action_key
@@ -698,6 +711,25 @@ fn secondary_keybinds(help: &ModeInfo, tab_info: Option<&TabInfo>, max_len: usiz
             vec![]
         };
 
+    // Resize
+    let resize_increase_action_key = action_key(binds, &[Action::Resize(Resize::Increase, None)]);
+    let resize_increase_key = resize_increase_action_key
+        .iter()
+        .find(|k| k.bare_key == BareKey::Char('+'))
+        .or_else(|| resize_increase_action_key.iter().next());
+    let resize_decrease_action_key = action_key(binds, &[Action::Resize(Resize::Decrease, None)]);
+    let resize_decrease_key = resize_decrease_action_key
+        .iter()
+        .find(|k| k.bare_key == BareKey::Char('-'))
+        .or_else(|| resize_increase_action_key.iter().next());
+    let mut resize_shortcuts = vec![];
+    if let Some(resize_increase_key) = resize_increase_key {
+        resize_shortcuts.push(resize_increase_key.clone());
+    }
+    if let Some(resize_decrease_key) = resize_decrease_key {
+        resize_shortcuts.push(resize_decrease_key.clone());
+    }
+
     // Move focus
     let mut move_focus_shortcuts: Vec<KeyWithModifier> = vec![];
 
@@ -757,6 +789,7 @@ fn secondary_keybinds(help: &ModeInfo, tab_info: Option<&TabInfo>, max_len: usiz
         [
             new_pane_key_to_display.clone(),
             move_focus_shortcuts.clone(),
+            resize_shortcuts.clone(),
             toggle_floating_key_to_display.clone(),
         ]
         .iter()
@@ -773,13 +806,22 @@ fn secondary_keybinds(help: &ModeInfo, tab_info: Option<&TabInfo>, max_len: usiz
             false,
             Some(0),
         ));
-        secondary_info.append(&add_shortcut(
-            help,
-            "Change Focus",
-            &move_focus_shortcuts,
-            false,
-            Some(0),
-        ));
+        if should_show_focus_and_resize_shortcuts {
+            secondary_info.append(&add_shortcut(
+                help,
+                "Change Focus",
+                &move_focus_shortcuts,
+                false,
+                Some(0),
+            ));
+            secondary_info.append(&add_shortcut(
+                help,
+                "Resize",
+                &resize_shortcuts,
+                false,
+                Some(0),
+            ));
+        }
         secondary_info.append(&add_shortcut(
             help,
             "Floating",
@@ -808,6 +850,10 @@ fn secondary_keybinds(help: &ModeInfo, tab_info: Option<&TabInfo>, max_len: usiz
             .iter()
             .map(|k| k.strip_common_modifiers(&common_modifiers))
             .collect();
+        let resize_shortcuts: Vec<KeyWithModifier> = resize_shortcuts
+            .iter()
+            .map(|k| k.strip_common_modifiers(&common_modifiers))
+            .collect();
         let toggle_floating_key_to_display: Vec<KeyWithModifier> = toggle_floating_key_to_display
             .iter()
             .map(|k| k.strip_common_modifiers(&common_modifiers))
@@ -818,12 +864,20 @@ fn secondary_keybinds(help: &ModeInfo, tab_info: Option<&TabInfo>, max_len: usiz
             new_pane_key_to_display,
             false,
         ));
-        secondary_info.append(&add_shortcut_with_inline_key(
-            help,
-            "Change Focus",
-            move_focus_shortcuts,
-            false,
-        ));
+        if should_show_focus_and_resize_shortcuts {
+            secondary_info.append(&add_shortcut_with_inline_key(
+                help,
+                "Change Focus",
+                move_focus_shortcuts,
+                false,
+            ));
+            secondary_info.append(&add_shortcut_with_inline_key(
+                help,
+                "Resize",
+                resize_shortcuts,
+                false,
+            ));
+        }
         secondary_info.append(&add_shortcut_with_inline_key(
             help,
             "Floating",
@@ -844,13 +898,22 @@ fn secondary_keybinds(help: &ModeInfo, tab_info: Option<&TabInfo>, max_len: usiz
                 false,
                 Some(0),
             ));
-            short_line.append(&add_shortcut(
-                help,
-                "Focus",
-                &move_focus_shortcuts,
-                false,
-                Some(0),
-            ));
+            if should_show_focus_and_resize_shortcuts {
+                short_line.append(&add_shortcut(
+                    help,
+                    "Focus",
+                    &move_focus_shortcuts,
+                    false,
+                    Some(0),
+                ));
+                short_line.append(&add_shortcut(
+                    help,
+                    "Resize",
+                    &resize_shortcuts,
+                    false,
+                    Some(0),
+                ));
+            }
             short_line.append(&add_shortcut(
                 help,
                 "Floating",
@@ -879,6 +942,10 @@ fn secondary_keybinds(help: &ModeInfo, tab_info: Option<&TabInfo>, max_len: usiz
                 .iter()
                 .map(|k| k.strip_common_modifiers(&common_modifiers))
                 .collect();
+            let resize_shortcuts: Vec<KeyWithModifier> = resize_shortcuts
+                .iter()
+                .map(|k| k.strip_common_modifiers(&common_modifiers))
+                .collect();
             let toggle_floating_key_to_display: Vec<KeyWithModifier> =
                 toggle_floating_key_to_display
                     .iter()
@@ -890,20 +957,42 @@ fn secondary_keybinds(help: &ModeInfo, tab_info: Option<&TabInfo>, max_len: usiz
                 new_pane_key_to_display,
                 false,
             ));
-            short_line.append(&add_shortcut_with_inline_key(
-                help,
-                "Focus",
-                move_focus_shortcuts,
-                false,
-            ));
+            if should_show_focus_and_resize_shortcuts {
+                short_line.append(&add_shortcut_with_inline_key(
+                    help,
+                    "Focus",
+                    move_focus_shortcuts,
+                    false,
+                ));
+                short_line.append(&add_shortcut_with_inline_key(
+                    help,
+                    "Resize",
+                    resize_shortcuts,
+                    false,
+                ));
+            }
             short_line.append(&add_shortcut_with_inline_key(
                 help,
                 "Floating",
                 toggle_floating_key_to_display,
                 are_floating_panes_visible,
             ));
         }
-        short_line
+        if short_line.len <= max_len {
+            short_line
+        } else {
+            let part = serialize_text(
+                &Text::new(format!(
+                    "{:>width$}",
+                    "...",
+                    width = max_len.saturating_sub(3)
+                ))
+                .color_range(0, ..)
+                .opaque(),
+            );
+            let len = max_len.saturating_sub(3);
+            LinePart { part, len }
+        }
     }
 }
 
@@ -982,6 +1071,7 @@ fn add_shortcut_with_inline_key(
         "←→" => "",
         "↓↑" => "",
         "[]" => "",
+        "+-" => "",
         _ => "|",
     };
 

diff --git a/src/tests/e2e/snapshots/zellij__tests__e2e__cases__bracketed_paste.snap b/src/tests/e2e/snapshots/zellij__tests__e2e__cases__bracketed_paste.snap
@@ -1,6 +1,6 @@
 ---
 source: src/tests/e2e/cases.rs
-assertion_line: 1975
+assertion_line: 2000
 expression: last_snapshot
 ---
  Zellij (e2e-test)  Tab #1 
@@ -26,4 +26,4 @@ expression: last_snapshot
 │                                                                                                                      │
 │                                                                                                                      │
 └──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
- Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT           
+ Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT       ... 
diff --git a/...sts__e2e__cases__cannot_split_terminals_vertically_when_active_terminal_is_too_small.snap b/...sts__e2e__cases__cannot_split_terminals_vertically_when_active_terminal_is_too_small.snap
@@ -1,6 +1,6 @@
 ---
 source: src/tests/e2e/cases.rs
-assertion_line: 243
+assertion_line: 239
 expression: last_snapshot
 ---
  Zellij 
@@ -22,4 +22,4 @@ expression: last_snapshot
 │      │
 │      │
 └──────┘
- Ctrl +
+...     
diff --git a/src/tests/e2e/snapshots/zellij__tests__e2e__cases__close_pane.snap b/src/tests/e2e/snapshots/zellij__tests__e2e__cases__close_pane.snap
@@ -1,6 +1,6 @@
 ---
 source: src/tests/e2e/cases.rs
-assertion_line: 707
+assertion_line: 714
 expression: last_snapshot
 ---
  Zellij (e2e-test)  Tab #1 
@@ -26,4 +26,4 @@ expression: last_snapshot
 │                                                                                                                      │
 │                                                                                                                      │
 └──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
- Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT           
+ Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT       ... 
diff --git a/src/tests/e2e/snapshots/zellij__tests__e2e__cases__detach_and_attach_session.snap b/src/tests/e2e/snapshots/zellij__tests__e2e__cases__detach_and_attach_session.snap
@@ -1,6 +1,6 @@
 ---
 source: src/tests/e2e/cases.rs
-assertion_line: 1138
+assertion_line: 1154
 expression: last_snapshot
 ---
  Zellij (e2e-test)  Tab #1 
@@ -26,4 +26,4 @@ expression: last_snapshot
 │                                                          ││                                                          │
 │                                                          ││                                                          │
 └──────────────────────────────────────────────────────────┘└──────────────────────────────────────────────────────────┘
- Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT           
+ Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT       ... 
diff --git a/src/tests/e2e/snapshots/zellij__tests__e2e__cases__focus_pane_with_mouse.snap b/src/tests/e2e/snapshots/zellij__tests__e2e__cases__focus_pane_with_mouse.snap
@@ -1,6 +1,6 @@
 ---
 source: src/tests/e2e/cases.rs
-assertion_line: 1352
+assertion_line: 1373
 expression: last_snapshot
 ---
  Zellij (e2e-test)  Tab #1 
@@ -26,4 +26,4 @@ expression: last_snapshot
 │                                                          ││                                                          │
 │                                                          ││                                                          │
 └──────────────────────────────────────────────────────────┘└──────────────────────────────────────────────────────────┘
- Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT           
+ Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT       ... 
diff --git a/...tests/e2e/snapshots/zellij__tests__e2e__cases__load_plugins_in_background_on_startup.snap b/...tests/e2e/snapshots/zellij__tests__e2e__cases__load_plugins_in_background_on_startup.snap
@@ -1,6 +1,6 @@
 ---
 source: src/tests/e2e/cases.rs
-assertion_line: 2426
+assertion_line: 2424
 expression: last_snapshot
 ---
  Zellij (e2e-test)  Tab #1 
@@ -26,4 +26,4 @@ expression: last_snapshot
 │                                                                                                                      │
 │                                                                                                                      │
 └──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
- Ctrl g  UNLOCK                                         Alt +  <n> New Pane  <←↓↑→> Change Focus  <f> Floating  
+ Ctrl g  UNLOCK                                                                Alt +  <n> New Pane  <f> Floating  
diff --git a/src/tests/e2e/snapshots/zellij__tests__e2e__cases__mirrored_sessions.snap b/src/tests/e2e/snapshots/zellij__tests__e2e__cases__mirrored_sessions.snap
@@ -1,6 +1,6 @@
 ---
 source: src/tests/e2e/cases.rs
-assertion_line: 1624
+assertion_line: 1650
 expression: first_runner_snapshot
 ---
  Zellij (mirrored_sessions)  Tab #1  Tab #2 
@@ -26,4 +26,4 @@ expression: first_runner_snapshot
 │                                                          ││                                                          │
 │                                                          ││                                                          │
 └──────────────────────────────────────────────────────────┘└──────────────────────────────────────────────────────────┘
- Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT           
+ Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT       ... 
diff --git a/src/tests/e2e/snapshots/zellij__tests__e2e__cases__move_tab_to_left.snap b/src/tests/e2e/snapshots/zellij__tests__e2e__cases__move_tab_to_left.snap
@@ -1,6 +1,6 @@
 ---
 source: src/tests/e2e/cases.rs
-assertion_line: 558
+assertion_line: 562
 expression: account_for_races_in_snapshot(last_snapshot)
 ---
  Zellij (e2e-test)  Tab #1  Tab #3  Tab #2 
@@ -26,4 +26,4 @@ expression: account_for_races_in_snapshot(last_snapshot)
 │                                                                                                                      │
 │                                                                                                                      │
 └──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
- Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT           
+ Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT       ... 
diff --git a/...ests/e2e/snapshots/zellij__tests__e2e__cases__move_tab_to_left_until_it_wraps_around.snap b/...ests/e2e/snapshots/zellij__tests__e2e__cases__move_tab_to_left_until_it_wraps_around.snap
@@ -1,6 +1,6 @@
 ---
 source: src/tests/e2e/cases.rs
-assertion_line: 620
+assertion_line: 624
 expression: account_for_races_in_snapshot(last_snapshot)
 ---
  Zellij (e2e-test)  Tab #2  Tab #1  Tab #3 
@@ -26,4 +26,4 @@ expression: account_for_races_in_snapshot(last_snapshot)
 │                                                                                                                      │
 │                                                                                                                      │
 └──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
- Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT           
+ Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT       ... 
diff --git a/src/tests/e2e/snapshots/zellij__tests__e2e__cases__move_tab_to_right.snap b/src/tests/e2e/snapshots/zellij__tests__e2e__cases__move_tab_to_right.snap
@@ -1,6 +1,6 @@
 ---
 source: src/tests/e2e/cases.rs
-assertion_line: 592
+assertion_line: 596
 expression: account_for_races_in_snapshot(last_snapshot)
 ---
  Zellij (e2e-test)  Tab #1  Tab #3  Tab #2 
@@ -26,4 +26,4 @@ expression: account_for_races_in_snapshot(last_snapshot)
 │                                                                                                                      │
 │                                                                                                                      │
 └──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
- Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT           
+ Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT       ... 
diff --git a/...sts/e2e/snapshots/zellij__tests__e2e__cases__move_tab_to_right_until_it_wraps_around.snap b/...sts/e2e/snapshots/zellij__tests__e2e__cases__move_tab_to_right_until_it_wraps_around.snap
@@ -1,6 +1,6 @@
 ---
 source: src/tests/e2e/cases.rs
-assertion_line: 644
+assertion_line: 648
 expression: account_for_races_in_snapshot(last_snapshot)
 ---
  Zellij (e2e-test)  Tab #3  Tab #2  Tab #1 
@@ -26,4 +26,4 @@ expression: account_for_races_in_snapshot(last_snapshot)
 │                                                                                                                      │
 │                                                                                                                      │
 └──────────────────────────────────────────────────────────────────────────────────────────────────────────────────────┘
- Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT           
+ Ctrl + <g> LOCK  <p> PANE  <t> TAB  <n> RESIZE  <h> MOVE  <s> SEARCH  <o> SESSION  <q> QUIT       ...