-
Notifications
You must be signed in to change notification settings - Fork 1.8k
Move overview highlight with scroll wheel #1436
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
steipete
merged 3 commits into
steipete:main
from
joshuavial:jv/overview-scroll-highlight
Jun 11, 2026
Merged
Changes from all commits
Commits
Show all changes
3 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
125 changes: 125 additions & 0 deletions
125
Sources/CodexBar/StatusItemController+OverviewScroll.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,125 @@ | ||
| import AppKit | ||
|
|
||
| enum OverviewScrollStep { | ||
| case up | ||
| case down | ||
| } | ||
|
|
||
| extension StatusItemController { | ||
| /// Pixel distance per highlight step for trackpads and other precise devices. | ||
| private static let preciseScrollStepThreshold: CGFloat = 24 | ||
| /// Line distance per highlight step for classic scroll wheels. | ||
| private static let lineScrollStepThreshold: CGFloat = 0.9 | ||
| /// A single fast flick should not race the highlight through the whole list. | ||
| private static let maxScrollStepsPerEvent = 3 | ||
|
|
||
| /// Scrolling the wheel while the overview tab is open moves the row highlight up/down. | ||
| /// Steps are delivered as mouse-move events over the custom card views so AppKit's | ||
| /// native menu highlight and submenu behavior stay intact. | ||
| @discardableResult | ||
| func handleOverviewScrollWheel(_ event: NSEvent, menu: NSMenu) -> Bool { | ||
| guard self.menuHasOverviewRows(menu) else { | ||
| self.overviewScrollAccumulatedDelta = 0 | ||
| return false | ||
| } | ||
| // Leave the wheel alone while a row submenu is open (e.g. scrollable charts); | ||
| // only the root overview list translates scrolling into highlight movement. | ||
| guard self.openMenus.count <= 1 else { | ||
| self.overviewScrollAccumulatedDelta = 0 | ||
| return false | ||
| } | ||
| // Momentum-phase events after a flick would keep moving the highlight long after | ||
| // the fingers left the trackpad; swallow them without stepping. | ||
| guard event.momentumPhase.isEmpty else { return true } | ||
| let delta = event.scrollingDeltaY | ||
| guard delta != 0 else { return false } | ||
|
|
||
| if self.overviewScrollAccumulatedDelta != 0, | ||
| (delta > 0) != (self.overviewScrollAccumulatedDelta > 0) | ||
| { | ||
| self.overviewScrollAccumulatedDelta = 0 | ||
| } | ||
| self.overviewScrollAccumulatedDelta += delta | ||
|
|
||
| let threshold = event.hasPreciseScrollingDeltas | ||
| ? Self.preciseScrollStepThreshold | ||
| : Self.lineScrollStepThreshold | ||
| var steps = 0 | ||
| while abs(self.overviewScrollAccumulatedDelta) >= threshold, steps < Self.maxScrollStepsPerEvent { | ||
| let movingUp = self.overviewScrollAccumulatedDelta > 0 | ||
| self.overviewScrollAccumulatedDelta += movingUp ? -threshold : threshold | ||
| self.postOverviewScrollNavigation(movingUp ? .up : .down, menu: menu) | ||
| steps += 1 | ||
| } | ||
|
joshuavial marked this conversation as resolved.
|
||
| // Discard the remainder once the cap is hit, otherwise the leftover delta from a | ||
| // fast flick would keep emitting capped batches on the next small scroll. | ||
| if steps == Self.maxScrollStepsPerEvent { | ||
| self.overviewScrollAccumulatedDelta = 0 | ||
| } | ||
| return true | ||
| } | ||
|
|
||
| func menuHasOverviewRows(_ menu: NSMenu) -> Bool { | ||
| menu.items.contains { item in | ||
| (item.representedObject as? String)?.hasPrefix(Self.overviewRowIdentifierPrefix) == true | ||
| } | ||
| } | ||
|
|
||
| func resetOverviewScrollAccumulation() { | ||
| self.overviewScrollAccumulatedDelta = 0 | ||
| } | ||
|
|
||
| private func postOverviewScrollNavigation(_ step: OverviewScrollStep, menu: NSMenu) { | ||
| if let handler = self.overviewScrollNavigationHandlerForTesting { | ||
| handler(step) | ||
| return | ||
| } | ||
| guard let target = self.overviewScrollTargetItem(in: menu, step: step) else { return } | ||
| let menuID = ObjectIdentifier(menu) | ||
| guard self.highlightedMenuItems[menuID] !== target else { return } | ||
|
|
||
| // Advance local state immediately so a capped multi-step flick can target successive rows | ||
| // before AppKit drains the synthetic mouse-move events. | ||
| self.menu(menu, willHighlight: target) | ||
|
|
||
| guard let view = target.view, | ||
| let window = view.window | ||
| else { return } | ||
| let location = view.convert( | ||
| NSPoint(x: view.bounds.midX, y: view.bounds.midY), | ||
| to: nil) | ||
| guard let event = NSEvent.mouseEvent( | ||
| with: .mouseMoved, | ||
| location: location, | ||
| modifierFlags: [], | ||
| timestamp: ProcessInfo.processInfo.systemUptime, | ||
| windowNumber: window.windowNumber, | ||
| context: nil, | ||
| eventNumber: 0, | ||
| clickCount: 0, | ||
| pressure: 0) | ||
| else { return } | ||
| NSApp.postEvent(event, atStart: false) | ||
| } | ||
|
|
||
| func overviewScrollTargetItem(in menu: NSMenu, step: OverviewScrollStep) -> NSMenuItem? { | ||
| let rows = menu.items.filter { item in | ||
| (item.representedObject as? String)?.hasPrefix(Self.overviewRowIdentifierPrefix) == true | ||
| } | ||
| guard !rows.isEmpty else { return nil } | ||
|
|
||
| guard let current = self.highlightedMenuItems[ObjectIdentifier(menu)], | ||
| let currentIndex = rows.firstIndex(where: { $0 === current }) | ||
| else { | ||
| return step == .down ? rows.first : rows.last | ||
| } | ||
|
|
||
| let targetIndex: Int = switch step { | ||
| case .up: | ||
| max(0, currentIndex - 1) | ||
| case .down: | ||
| min(rows.count - 1, currentIndex + 1) | ||
| } | ||
| return rows[targetIndex] | ||
| } | ||
| } | ||
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
216 changes: 216 additions & 0 deletions
216
Tests/CodexBarTests/StatusMenuOverviewScrollTests.swift
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,216 @@ | ||
| import AppKit | ||
| import CodexBarCore | ||
| import Foundation | ||
| import Testing | ||
| @testable import CodexBar | ||
|
|
||
| @MainActor | ||
| struct StatusMenuOverviewScrollTests { | ||
| private func makeController(suiteName: String) -> StatusItemController { | ||
| _ = NSApplication.shared | ||
| let settings = SettingsStore( | ||
| configStore: testConfigStore(suiteName: suiteName), | ||
| zaiTokenStore: NoopZaiTokenStore(), | ||
| syntheticTokenStore: NoopSyntheticTokenStore()) | ||
| settings.statusChecksEnabled = false | ||
| settings.refreshFrequency = .manual | ||
| let fetcher = UsageFetcher() | ||
| let store = UsageStore( | ||
| fetcher: fetcher, | ||
| browserDetection: BrowserDetection(cacheTTL: 0), | ||
| settings: settings) | ||
| return StatusItemController( | ||
| store: store, | ||
| settings: settings, | ||
| account: fetcher.loadAccountInfo(), | ||
| updater: DisabledUpdaterController(), | ||
| preferencesSelection: PreferencesSelection(), | ||
| statusBar: .system) | ||
| } | ||
|
|
||
| private func makeOverviewMenu() -> NSMenu { | ||
| let menu = NSMenu() | ||
| for provider in ["claude", "codex"] { | ||
| let item = NSMenuItem() | ||
| item.representedObject = "\(StatusItemController.overviewRowIdentifierPrefix)\(provider)" | ||
| item.isEnabled = true | ||
| menu.addItem(item) | ||
| } | ||
| return menu | ||
| } | ||
|
|
||
| private func makeScrollEvent(deltaY: Double, precise: Bool) -> NSEvent? { | ||
| guard let cgEvent = CGEvent( | ||
| scrollWheelEvent2Source: nil, | ||
| units: precise ? .pixel : .line, | ||
| wheelCount: 1, | ||
| wheel1: Int32(deltaY), | ||
| wheel2: 0, | ||
| wheel3: 0) | ||
| else { return nil } | ||
| return NSEvent(cgEvent: cgEvent) | ||
| } | ||
|
|
||
| @Test | ||
| func `scroll steps move highlight and respect direction`() throws { | ||
| let controller = self.makeController(suiteName: "OverviewScroll-Direction") | ||
| defer { controller.releaseStatusItemsForTesting() } | ||
| let menu = self.makeOverviewMenu() | ||
|
|
||
| var steps: [OverviewScrollStep] = [] | ||
| controller.overviewScrollNavigationHandlerForTesting = { steps.append($0) } | ||
|
|
||
| let scrollUp = try #require(self.makeScrollEvent(deltaY: 30, precise: true)) | ||
| #expect(controller.handleOverviewScrollWheel(scrollUp, menu: menu)) | ||
| #expect(steps == [.up]) | ||
|
|
||
| steps = [] | ||
| let scrollDown = try #require(self.makeScrollEvent(deltaY: -30, precise: true)) | ||
| #expect(controller.handleOverviewScrollWheel(scrollDown, menu: menu)) | ||
| #expect(steps == [.down]) | ||
| } | ||
|
|
||
| @Test | ||
| func `navigation targets only overview rows`() { | ||
| let controller = self.makeController(suiteName: "OverviewScroll-Targets") | ||
| defer { controller.releaseStatusItemsForTesting() } | ||
| let menu = self.makeOverviewMenu() | ||
| let refresh = NSMenuItem(title: "Refresh", action: nil, keyEquivalent: "") | ||
| refresh.isEnabled = true | ||
| menu.addItem(refresh) | ||
| let rows = Array(menu.items.prefix(2)) | ||
|
|
||
| #expect(controller.overviewScrollTargetItem(in: menu, step: .down) === rows[0]) | ||
| #expect(controller.overviewScrollTargetItem(in: menu, step: .up) === rows[1]) | ||
|
|
||
| controller.highlightedMenuItems[ObjectIdentifier(menu)] = rows[0] | ||
| #expect(controller.overviewScrollTargetItem(in: menu, step: .down) === rows[1]) | ||
| #expect(controller.overviewScrollTargetItem(in: menu, step: .up) === rows[0]) | ||
|
|
||
| controller.highlightedMenuItems[ObjectIdentifier(menu)] = rows[1] | ||
| #expect(controller.overviewScrollTargetItem(in: menu, step: .down) === rows[1]) | ||
| #expect(controller.overviewScrollTargetItem(in: menu, step: .up) === rows[0]) | ||
|
|
||
| controller.highlightedMenuItems[ObjectIdentifier(menu)] = refresh | ||
| #expect(controller.overviewScrollTargetItem(in: menu, step: .down) === rows[0]) | ||
| } | ||
|
|
||
| @Test | ||
| func `small precise deltas accumulate before stepping`() throws { | ||
| let controller = self.makeController(suiteName: "OverviewScroll-Accumulate") | ||
| defer { controller.releaseStatusItemsForTesting() } | ||
| let menu = self.makeOverviewMenu() | ||
|
|
||
| var steps: [OverviewScrollStep] = [] | ||
| controller.overviewScrollNavigationHandlerForTesting = { steps.append($0) } | ||
|
|
||
| let smallScroll = try #require(self.makeScrollEvent(deltaY: 10, precise: true)) | ||
| #expect(controller.handleOverviewScrollWheel(smallScroll, menu: menu)) | ||
| #expect(steps.isEmpty) | ||
| #expect(controller.handleOverviewScrollWheel(smallScroll, menu: menu)) | ||
| #expect(steps.isEmpty) | ||
| #expect(controller.handleOverviewScrollWheel(smallScroll, menu: menu)) | ||
| #expect(steps == [.up]) | ||
| } | ||
|
|
||
| @Test | ||
| func `direction change resets accumulated distance`() throws { | ||
| let controller = self.makeController(suiteName: "OverviewScroll-Flip") | ||
| defer { controller.releaseStatusItemsForTesting() } | ||
| let menu = self.makeOverviewMenu() | ||
|
|
||
| var steps: [OverviewScrollStep] = [] | ||
| controller.overviewScrollNavigationHandlerForTesting = { steps.append($0) } | ||
|
|
||
| let upBelowThreshold = try #require(self.makeScrollEvent(deltaY: 20, precise: true)) | ||
| #expect(controller.handleOverviewScrollWheel(upBelowThreshold, menu: menu)) | ||
| #expect(steps.isEmpty) | ||
|
|
||
| let downBelowThreshold = try #require(self.makeScrollEvent(deltaY: -20, precise: true)) | ||
| #expect(controller.handleOverviewScrollWheel(downBelowThreshold, menu: menu)) | ||
| #expect(steps.isEmpty) | ||
| #expect(controller.handleOverviewScrollWheel(downBelowThreshold, menu: menu)) | ||
| #expect(steps == [.down]) | ||
| } | ||
|
|
||
| @Test | ||
| func `coarse wheel lines step immediately`() throws { | ||
| let controller = self.makeController(suiteName: "OverviewScroll-Wheel") | ||
| defer { controller.releaseStatusItemsForTesting() } | ||
| let menu = self.makeOverviewMenu() | ||
|
|
||
| var steps: [OverviewScrollStep] = [] | ||
| controller.overviewScrollNavigationHandlerForTesting = { steps.append($0) } | ||
|
|
||
| let wheelNotch = try #require(self.makeScrollEvent(deltaY: -1, precise: false)) | ||
| #expect(controller.handleOverviewScrollWheel(wheelNotch, menu: menu)) | ||
| #expect(steps == [.down]) | ||
| } | ||
|
|
||
| @Test | ||
| func `fast flick is capped per event`() throws { | ||
| let controller = self.makeController(suiteName: "OverviewScroll-Cap") | ||
| defer { controller.releaseStatusItemsForTesting() } | ||
| let menu = self.makeOverviewMenu() | ||
|
|
||
| var steps: [OverviewScrollStep] = [] | ||
| controller.overviewScrollNavigationHandlerForTesting = { steps.append($0) } | ||
|
|
||
| let flick = try #require(self.makeScrollEvent(deltaY: 500, precise: true)) | ||
| #expect(controller.handleOverviewScrollWheel(flick, menu: menu)) | ||
| #expect(steps == [.up, .up, .up]) | ||
| } | ||
|
|
||
| @Test | ||
| func `capped flick discards leftover distance`() throws { | ||
| let controller = self.makeController(suiteName: "OverviewScroll-CapRemainder") | ||
| defer { controller.releaseStatusItemsForTesting() } | ||
| let menu = self.makeOverviewMenu() | ||
|
|
||
| var steps: [OverviewScrollStep] = [] | ||
| controller.overviewScrollNavigationHandlerForTesting = { steps.append($0) } | ||
|
|
||
| let flick = try #require(self.makeScrollEvent(deltaY: 500, precise: true)) | ||
| #expect(controller.handleOverviewScrollWheel(flick, menu: menu)) | ||
| #expect(steps == [.up, .up, .up]) | ||
|
|
||
| steps = [] | ||
| let smallScroll = try #require(self.makeScrollEvent(deltaY: 10, precise: true)) | ||
| #expect(controller.handleOverviewScrollWheel(smallScroll, menu: menu)) | ||
| #expect(steps.isEmpty) | ||
| } | ||
|
|
||
| @Test | ||
| func `open submenu suspends scroll navigation`() throws { | ||
| let controller = self.makeController(suiteName: "OverviewScroll-Submenu") | ||
| defer { controller.releaseStatusItemsForTesting() } | ||
| let menu = self.makeOverviewMenu() | ||
| let submenu = NSMenu() | ||
| controller.openMenus[ObjectIdentifier(menu)] = menu | ||
| controller.openMenus[ObjectIdentifier(submenu)] = submenu | ||
| defer { controller.openMenus.removeAll() } | ||
|
|
||
| var steps: [OverviewScrollStep] = [] | ||
| controller.overviewScrollNavigationHandlerForTesting = { steps.append($0) } | ||
|
|
||
| let scroll = try #require(self.makeScrollEvent(deltaY: 30, precise: true)) | ||
| #expect(!controller.handleOverviewScrollWheel(scroll, menu: menu)) | ||
| #expect(steps.isEmpty) | ||
| } | ||
|
|
||
| @Test | ||
| func `menus without overview rows ignore scrolling`() throws { | ||
| let controller = self.makeController(suiteName: "OverviewScroll-NonOverview") | ||
| defer { controller.releaseStatusItemsForTesting() } | ||
| let menu = NSMenu() | ||
| menu.addItem(NSMenuItem(title: "Refresh", action: nil, keyEquivalent: "")) | ||
|
|
||
| var steps: [OverviewScrollStep] = [] | ||
| controller.overviewScrollNavigationHandlerForTesting = { steps.append($0) } | ||
|
|
||
| let scroll = try #require(self.makeScrollEvent(deltaY: 30, precise: true)) | ||
| #expect(!controller.handleOverviewScrollWheel(scroll, menu: menu)) | ||
| #expect(steps.isEmpty) | ||
| #expect(!menu.items.isEmpty) | ||
| } | ||
| } |
Oops, something went wrong.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
When a menu stays open and the user switches between a precise device and a line-based wheel, this accumulator combines values measured in different units while the threshold below is chosen from only the current event. For example, a leftover
20pixel trackpad delta followed by one wheel notch with the same sign is compared against the0.9line threshold and emits the capped 3 steps instead of one, so users with an external mouse/trackpad can see the highlight jump unexpectedly. Track the lasthasPreciseScrollingDeltasmode and clear the remainder when it changes, or keep separate accumulators per unit.Useful? React with 👍 / 👎.