Code at the speed of thought – Zed is a high-performance, multiplayer code editor from the creators of Atom and Tree-sitter.
workspace: Keep focus on menus and pickers with focus follows mouse (#66173)
Smit Barmasea72cb6a214e0
diff --git a/crates/editor/src/editor.rs b/crates/editor/src/editor.rsindex 5f665ebf048..e112f71ba75 100644--- a/crates/editor/src/editor.rs+++ b/crates/editor/src/editor.rs@@ -265,7 +265,10 @@ use theme::{use theme_settings::{ThemeSettings, observe_buffer_font_size_adjustment};use ui::{Avatar, ContextMenu, Disclosure, IconButtonShape, Indicator, Key, KeyBinding, Tooltip,- prelude::*, scrollbars::ScrollbarAutoHide, tooltip_container, utils::WithRemSize,+ prelude::*,+ scrollbars::ScrollbarAutoHide,+ tooltip_container,+ utils::{RetainedFocusExt as _, WithRemSize},};use ui_input::ErasedEditor;use util::{RangeExt, ResultExt, TryFutureExt, maybe, post_inc};@@ -2327,7 +2330,11 @@ impl Editor {let inlay_hint_settings =inlay_hint_settings(selections.newest_anchor().head(), &buffer_snapshot, cx);- let focus_handle = cx.focus_handle();+ let focus_handle = if mode.is_single_line() {+ cx.retained_focus_handle()+ } else {+ cx.focus_handle()+ };if !is_minimap {cx.on_focus(&focus_handle, window, Self::handle_focus).detach();diff --git a/crates/picker/src/head.rs b/crates/picker/src/head.rsindex 74f99bdaad7..c4640b0bbdf 100644--- a/crates/picker/src/head.rs+++ b/crates/picker/src/head.rs@@ -1,7 +1,7 @@use std::sync::Arc;use gpui::{App, Entity, FocusHandle, Focusable, prelude::*};-use ui::prelude::*;+use ui::{prelude::*, utils::RetainedFocusExt as _};use ui_input::{ErasedEditor, ErasedEditorEvent};/// The head of a [`Picker`](crate::Picker).@@ -65,9 +65,8 @@ pub(crate) struct EmptyHead {impl EmptyHead {fn new(cx: &mut Context<Self>) -> Self {- Self {- focus_handle: cx.focus_handle(),- }+ let focus_handle = cx.retained_focus_handle();+ Self { focus_handle }}}diff --git a/crates/project_panel/src/project_panel_tests.rs b/crates/project_panel/src/project_panel_tests.rsindex 6baec76e4d6..d995cd66404 100644--- a/crates/project_panel/src/project_panel_tests.rs+++ b/crates/project_panel/src/project_panel_tests.rs@@ -12840,7 +12840,9 @@ async fn test_focus_follows_mouse_into_blank_area(cx: &mut gpui::TestAppContext)}#[gpui::test]-async fn test_focus_follows_mouse_keeps_rename_editor_focused(cx: &mut gpui::TestAppContext) {+async fn test_focus_follows_mouse_keeps_rename_and_context_menu_open(+ cx: &mut gpui::TestAppContext,+) {init_test_with_editor(cx);cx.update(|cx| {cx.update_global::<SettingsStore, _>(|store, cx| {@@ -12883,6 +12885,29 @@ async fn test_focus_follows_mouse_keeps_rename_editor_focused(cx: &mut gpui::Tes&["v root", " [EDITOR: 'a.txt'] <== selected"],"Hovering the project panel should not cancel the rename");++ let entry_id = find_project_entry(&panel, "root/a.txt", cx).unwrap();+ panel.update_in(cx, |panel, window, cx| {+ panel.cancel(&menu::Cancel, window, cx);+ panel.deploy_context_menu(+ ContextMenuPlacement::AtMouse(point(px(1700.), px(30.))),+ entry_id,+ window,+ cx,+ );+ });+ cx.run_until_parked();++ cx.simulate_mouse_move(point(px(400.), px(400.)), None, Modifiers::none());+ cx.executor().advance_clock(Duration::from_millis(200));+ cx.run_until_parked();++ panel.read_with(cx, |panel, _| {+ assert!(+ panel.context_menu.is_some(),+ "Hovering a pane should not close the context menu"+ );+ });}pub(crate) fn init_test(cx: &mut TestAppContext) {diff --git a/crates/ui/src/components/context_menu.rs b/crates/ui/src/components/context_menu.rsindex 82bfecdebe9..e692c7cbbf2 100644--- a/crates/ui/src/components/context_menu.rs+++ b/crates/ui/src/components/context_menu.rs@@ -1,6 +1,8 @@use crate::{ButtonCommon, ButtonStyle, IconButtonShape, KeyBinding, List, ListItem, ListItemSpacing,- ListSeparator, ListSubHeader, Tooltip, prelude::*, utils::WithRemSize,+ ListSeparator, ListSubHeader, Tooltip,+ prelude::*,+ utils::{RetainedFocusExt as _, WithRemSize},};use gpui::{Action, Anchor, AnchoredPositionMode, AnyElement, App, Bounds, DismissEvent, Entity,@@ -303,7 +305,7 @@ impl ContextMenu {cx.new(|cx| {let builder = Rc::new(builder);- let focus_handle = cx.focus_handle();+ let focus_handle = cx.retained_focus_handle();let _on_blur_subscription = cx.on_blur(&focus_handle,window,@@ -389,7 +391,7 @@ impl ContextMenu {};// The way we rebuild the menu is a bit of a hack.- let focus_handle = cx.focus_handle();+ let focus_handle = cx.retained_focus_handle();let new_menu = (builder.clone())(Self {builder: Some(builder),@@ -1255,7 +1257,7 @@ impl ContextMenu {cx: &mut App,) -> Entity<ContextMenu> {cx.new(|cx| {- let focus_handle = cx.focus_handle();+ let focus_handle = cx.retained_focus_handle();let _on_blur_subscription = cx.on_blur(&focus_handle,@@ -2125,7 +2127,7 @@ impl ContextMenu {#[inline(never)]fn new_inner(window: &mut Window, cx: &mut Context<Self>) -> Self {- let focus_handle = cx.focus_handle();+ let focus_handle = cx.retained_focus_handle();let _on_blur_subscription = cx.on_blur(&focus_handle,window,diff --git a/crates/ui/src/utils.rs b/crates/ui/src/utils.rsindex c63a7cd27c5..1cfcb6d2500 100644--- a/crates/ui/src/utils.rs+++ b/crates/ui/src/utils.rs@@ -9,6 +9,7 @@ mod constants;mod control_characters;mod corner_solver;mod format_distance;+mod retained_focus;mod search_input;mod with_rem_size;@@ -18,6 +19,7 @@ pub use constants::*;pub use control_characters::*;pub use corner_solver::{CornerSolver, inner_corner_radius};pub use format_distance::*;+pub use retained_focus::*;pub use search_input::*;pub use with_rem_size::*;diff --git a/crates/ui/src/utils/retained_focus.rs b/crates/ui/src/utils/retained_focus.rsnew file mode 100644index 00000000000..d11aa74da74--- /dev/null+++ b/crates/ui/src/utils/retained_focus.rs@@ -0,0 +1,29 @@+use gpui::{App, FocusHandle, Global, WeakFocusHandle};++#[derive(Default)]+struct RetainedFocusRegistry {+ handles: Vec<WeakFocusHandle>,+}++impl Global for RetainedFocusRegistry {}++pub trait RetainedFocusExt {+ /// Creates a focus handle that keeps focus when focus would move implicitly, e.g. with focus follows mouse.+ fn retained_focus_handle(&mut self) -> FocusHandle;+}++impl RetainedFocusExt for App {+ fn retained_focus_handle(&mut self) -> FocusHandle {+ let focus_handle = self.focus_handle();+ let registry = self.default_global::<RetainedFocusRegistry>();+ registry.handles.retain(|handle| handle.upgrade().is_some());+ registry.handles.push(focus_handle.downgrade());+ focus_handle+ }+}++/// Returns whether this handle was created with [`RetainedFocusExt::retained_focus_handle`].+pub fn retains_focus(focus_handle: &FocusHandle, cx: &App) -> bool {+ cx.try_global::<RetainedFocusRegistry>()+ .is_some_and(|registry| registry.handles.iter().any(|handle| handle == focus_handle))+}diff --git a/crates/workspace/src/focus_follows_mouse.rs b/crates/workspace/src/focus_follows_mouse.rsindex 06f3f9dd5da..f5c9bd35cfa 100644--- a/crates/workspace/src/focus_follows_mouse.rs+++ b/crates/workspace/src/focus_follows_mouse.rs@@ -1,7 +1,8 @@use gpui::{AnyWindowHandle, AppContext as _, Context, FocusHandle, Focusable, Global,- StatefulInteractiveElement, Task, Window,+ StatefulInteractiveElement, Task,};+use ui::utils::retains_focus;use crate::workspace_settings;@@ -51,7 +52,10 @@ pub trait FocusFollowsMouse<E: Focusable>: StatefulInteractiveElement {};let _ = cx.update_window(window, move |_view, window, cx| {- if is_single_line_editor_focused(window) {+ if window+ .focused(cx)+ .is_some_and(|focused| retains_focus(&focused, cx))+ {return;}window.focus(&focus, cx);@@ -72,12 +76,3 @@ pub trait FocusFollowsMouse<E: Focusable>: StatefulInteractiveElement {}impl<E: Focusable, T: StatefulInteractiveElement> FocusFollowsMouse<E> for T {}--fn is_single_line_editor_focused(window: &Window) -> bool {- window.context_stack().last().is_some_and(|context| {- context.contains("Editor")- && context- .get("mode")- .is_some_and(|mode| mode.as_ref() == "single_line")- })-}