Add configurable scrollback page shortcuts (fixes #4645)

CHANGELOG.md

@@ -6,6 +6,7 @@ All notable changes to cmux are documented here.
 
 ### Added
 - iPhone companion app (beta): pair an iPhone from the new Mobile Connect window (also in the command palette) and attach to your Mac's terminals from your phone, with a configurable pairing port and opt-in forwarding of terminal notifications; the iOS beta ships on TestFlight as cmux BETA ([#5079](https://github.com/manaflow-ai/cmux/pull/5079), [#5493](https://github.com/manaflow-ai/cmux/pull/5493), [#5489](https://github.com/manaflow-ai/cmux/pull/5489), [#5518](https://github.com/manaflow-ai/cmux/pull/5518))
+- Configurable terminal scrollback shortcuts for page up/down and line up/down, with Shift+Page Up and Shift+Page Down defaults; line scrolling is configurable but unbound by default so shells can receive Shift+Up/Down.
 - Drag a workspace into another window's sidebar to move it between windows, including grouped workspaces ([#5399](https://github.com/manaflow-ai/cmux/pull/5399))
 - Sign In and Sign Out commands in the command palette ([#5529](https://github.com/manaflow-ai/cmux/pull/5529))
 - OMP agent hook integration with notifications and session restore via `cmux hooks omp` ([#5413](https://github.com/manaflow-ai/cmux/pull/5413)) -- thanks @joshrzemien!

Packages/CmuxSettings/Sources/CmuxSettings/Values/ShortcutAction+Defaults.swift

@@ -66,6 +66,10 @@ extension ShortcutAction {
         case .selectWorkspaceByNumber: return ShortcutStroke(key: "1", command: true)
         case .newSurface: return ShortcutStroke(key: "t", command: true)
         case .toggleTerminalCopyMode: return ShortcutStroke(key: "m", command: true, shift: true)
+        case .scrollbackPageUp: return ShortcutStroke(key: "pageup", shift: true)
+        case .scrollbackPageDown: return ShortcutStroke(key: "pagedown", shift: true)
+        case .scrollbackLineUp: return nil
+        case .scrollbackLineDown: return nil
         case .focusTextBoxInput: return ShortcutStroke(key: "a", command: true, shift: true)
         case .attachTextBoxFile: return ShortcutStroke(key: "a", command: true, shift: true, option: true)
         case .toggleRightSidebar: return ShortcutStroke(key: "b", command: true, option: true)

Packages/CmuxSettings/Sources/CmuxSettings/Values/ShortcutAction.swift

@@ -61,6 +61,10 @@ public enum ShortcutAction: String, CaseIterable, Sendable, Hashable, SettingCod
     case reopenClosedBrowserPanel
     case newSurface
     case toggleTerminalCopyMode
+    case scrollbackPageUp
+    case scrollbackPageDown
+    case scrollbackLineUp
+    case scrollbackLineDown
     case focusTextBoxInput
     case attachTextBoxFile
 
@@ -141,6 +145,7 @@ extension ShortcutAction {
              .selectWorkspaceByNumber, .renameTab, .renameWorkspace,
              .editWorkspaceDescription, .closeTab, .closeOtherTabsInPane, .closeWorkspace,
              .reopenClosedBrowserPanel, .newSurface, .toggleTerminalCopyMode,
+             .scrollbackPageUp, .scrollbackPageDown, .scrollbackLineUp, .scrollbackLineDown,
              .focusTextBoxInput, .attachTextBoxFile:
             return .navigation
         case .focusLeft, .focusRight, .focusUp, .focusDown, .splitRight, .splitDown,
@@ -205,6 +210,10 @@ extension ShortcutAction {
         case .reopenClosedBrowserPanel: return "Reopen Last Closed"
         case .newSurface: return "New Surface"
         case .toggleTerminalCopyMode: return "Toggle Terminal Copy Mode"
+        case .scrollbackPageUp: return String(localized: "shortcut.scrollbackPageUp.displayName", defaultValue: "Scrollback Page Up")
+        case .scrollbackPageDown: return String(localized: "shortcut.scrollbackPageDown.displayName", defaultValue: "Scrollback Page Down")
+        case .scrollbackLineUp: return String(localized: "shortcut.scrollbackLineUp.displayName", defaultValue: "Scrollback Line Up")
+        case .scrollbackLineDown: return String(localized: "shortcut.scrollbackLineDown.displayName", defaultValue: "Scrollback Line Down")
         case .focusTextBoxInput: return "Focus TextBox Input"
         case .attachTextBoxFile: return "Attach File to TextBox Input"
         case .focusLeft: return "Focus Pane Left"

Packages/CmuxSettingsUI/Sources/CmuxSettingsUI/Sections/GlobalHotkeySection.swift

@@ -159,6 +159,10 @@ public struct GlobalHotkeySection: View {
             return String(localized: "shortcut.key.tab", defaultValue: "Tab")
         case "space":
             return String(localized: "shortcut.key.space", defaultValue: "Space")
+        case "pageUp", "pageup":
+            return String(localized: "shortcut.key.pageUp", defaultValue: "Page Up")
+        case "pageDown", "pagedown":
+            return String(localized: "shortcut.key.pageDown", defaultValue: "Page Down")
         case "\r":
             return "↩"
         case "media.brightnessDown":

Packages/CmuxSettingsUI/Sources/CmuxSettingsUI/Sections/KeyboardShortcutsSection.swift

@@ -353,6 +353,10 @@ public struct KeyboardShortcutsSection: View {
             return String(localized: "shortcut.key.tab", defaultValue: "Tab")
         case "space":
             return String(localized: "shortcut.key.space", defaultValue: "Space")
+        case "pageUp", "pageup":
+            return String(localized: "shortcut.key.pageUp", defaultValue: "Page Up")
+        case "pageDown", "pagedown":
+            return String(localized: "shortcut.key.pageDown", defaultValue: "Page Down")
         case "\r":
             return "↩"
         case "media.brightnessDown":

Resources/Localizable.xcstrings

@@ -125439,6 +125439,40 @@
         }
       }
     },
+    "shortcut.key.pageDown": {
+      "extractionState": "manual",
+      "localizations": {
+        "en": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "Page Down"
+          }
+        },
+        "ja": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "ページダウン"
+          }
+        }
+      }
+    },
+    "shortcut.key.pageUp": {
+      "extractionState": "manual",
+      "localizations": {
+        "en": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "Page Up"
+          }
+        },
+        "ja": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "ページアップ"
+          }
+        }
+      }
+    },
     "shortcut.key.space": {
       "extractionState": "manual",
       "localizations": {
@@ -128640,6 +128674,142 @@
         }
       }
     },
+    "shortcut.scrollbackPageDown.displayName": {
+      "extractionState": "manual",
+      "localizations": {
+        "en": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "Scrollback Page Down"
+          }
+        },
+        "ja": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "スクロールバックを1ページ下へ"
+          }
+        }
+      }
+    },
+    "shortcut.scrollbackPageDown.label": {
+      "extractionState": "manual",
+      "localizations": {
+        "en": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "Scrollback Page Down"
+          }
+        },
+        "ja": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "スクロールバックを1ページ下へ"
+          }
+        }
+      }
+    },
+    "shortcut.scrollbackLineDown.displayName": {
+      "extractionState": "manual",
+      "localizations": {
+        "en": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "Scrollback Line Down"
+          }
+        },
+        "ja": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "スクロールバックを1行下へ"
+          }
+        }
+      }
+    },
+    "shortcut.scrollbackLineDown.label": {
+      "extractionState": "manual",
+      "localizations": {
+        "en": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "Scrollback Line Down"
+          }
+        },
+        "ja": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "スクロールバックを1行下へ"
+          }
+        }
+      }
+    },
+    "shortcut.scrollbackLineUp.displayName": {
+      "extractionState": "manual",
+      "localizations": {
+        "en": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "Scrollback Line Up"
+          }
+        },
+        "ja": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "スクロールバックを1行上へ"
+          }
+        }
+      }
+    },
+    "shortcut.scrollbackLineUp.label": {
+      "extractionState": "manual",
+      "localizations": {
+        "en": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "Scrollback Line Up"
+          }
+        },
+        "ja": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "スクロールバックを1行上へ"
+          }
+        }
+      }
+    },
+    "shortcut.scrollbackPageUp.displayName": {
+      "extractionState": "manual",
+      "localizations": {
+        "en": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "Scrollback Page Up"
+          }
+        },
+        "ja": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "スクロールバックを1ページ上へ"
+          }
+        }
+      }
+    },
+    "shortcut.scrollbackPageUp.label": {
+      "extractionState": "manual",
+      "localizations": {
+        "en": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "Scrollback Page Up"
+          }
+        },
+        "ja": {
+          "stringUnit": {
+            "state": "translated",
+            "value": "スクロールバックを1ページ上へ"
+          }
+        }
+      }
+    },
     "sidebar.closeWorkspace.tooltip": {
       "extractionState": "manual",
       "localizations": {

Sources/AppDelegate.swift

@@ -13104,6 +13104,26 @@ final class AppDelegate: NSObject, NSApplicationDelegate, UNUserNotificationCent
             return handled
         }
 
+        if matchConfiguredShortcut(event: event, action: .scrollbackPageUp) {
+            let routedManager = preferredMainWindowContextForShortcutRouting(event: event)?.tabManager ?? tabManager
+            return routedManager?.scrollFocusedTerminalScrollbackPage(up: true) ?? false
+        }
+
+        if matchConfiguredShortcut(event: event, action: .scrollbackPageDown) {
+            let routedManager = preferredMainWindowContextForShortcutRouting(event: event)?.tabManager ?? tabManager
+            return routedManager?.scrollFocusedTerminalScrollbackPage(up: false) ?? false
+        }
+
+        if matchConfiguredShortcut(event: event, action: .scrollbackLineUp) {
+            let routedManager = preferredMainWindowContextForShortcutRouting(event: event)?.tabManager ?? tabManager
+            return routedManager?.scrollFocusedTerminalScrollbackLine(up: true) ?? false
+        }
+
+        if matchConfiguredShortcut(event: event, action: .scrollbackLineDown) {
+            let routedManager = preferredMainWindowContextForShortcutRouting(event: event)?.tabManager ?? tabManager
+            return routedManager?.scrollFocusedTerminalScrollbackLine(up: false) ?? false
+        }
+
         if matchConfiguredShortcut(event: event, action: .focusTextBoxInput) {
             let routedManager = preferredMainWindowContextForShortcutRouting(event: event)?.tabManager ?? tabManager
             let handled = routedManager?.focusFocusedTerminalTextBoxInputOrTerminal() ?? false

Sources/KeyboardShortcutContext.swift

@@ -76,7 +76,7 @@ extension KeyboardShortcutSettings.Action {
             return .browserPanel
         case .switchRightSidebarToFiles, .switchRightSidebarToFind, .switchRightSidebarToSessions, .switchRightSidebarToFeed, .switchRightSidebarToDock:
             return .rightSidebarFocus
-        case .renameTab, .renameWorkspace, .sendCtrlFToTerminal:
+        case .renameTab, .renameWorkspace, .scrollbackPageUp, .scrollbackPageDown, .scrollbackLineUp, .scrollbackLineDown, .sendCtrlFToTerminal:
             return .nonBrowserPanel
         case .browserBack, .browserForward, .browserReload, .toggleBrowserDeveloperTools, .showBrowserJavaScriptConsole,
              .browserZoomIn, .browserZoomOut, .browserZoomReset, .toggleBrowserFocusMode: