ZIm/crates/workspace/src/modal_layer.rs
redforks 6d2bdc3bac
editor: Hide mouse context menu when modal is opened (#29127)
Closes #28787 

The context menu appears before the modal because it is a Deferred
element, which is always displayed above normal elements.

Release Notes:

Previously, the editor context menu appeared before the Command Palette.
This commit ensures the editor context menu is hidden when a modal,
including the Command Palette, is opened.
2025-04-21 20:13:26 +05:30

208 lines
6 KiB
Rust

use gpui::{
AnyView, DismissEvent, Entity, EventEmitter, FocusHandle, Focusable as _, ManagedView,
MouseButton, Subscription,
};
use ui::prelude::*;
#[derive(Debug)]
pub enum DismissDecision {
Dismiss(bool),
Pending,
}
pub trait ModalView: ManagedView {
fn on_before_dismiss(
&mut self,
_window: &mut Window,
_: &mut Context<Self>,
) -> DismissDecision {
DismissDecision::Dismiss(true)
}
fn fade_out_background(&self) -> bool {
false
}
}
trait ModalViewHandle {
fn on_before_dismiss(&mut self, window: &mut Window, cx: &mut App) -> DismissDecision;
fn view(&self) -> AnyView;
fn fade_out_background(&self, cx: &mut App) -> bool;
}
impl<V: ModalView> ModalViewHandle for Entity<V> {
fn on_before_dismiss(&mut self, window: &mut Window, cx: &mut App) -> DismissDecision {
self.update(cx, |this, cx| this.on_before_dismiss(window, cx))
}
fn view(&self) -> AnyView {
self.clone().into()
}
fn fade_out_background(&self, cx: &mut App) -> bool {
self.read(cx).fade_out_background()
}
}
pub struct ActiveModal {
modal: Box<dyn ModalViewHandle>,
_subscriptions: [Subscription; 2],
previous_focus_handle: Option<FocusHandle>,
focus_handle: FocusHandle,
}
pub struct ModalLayer {
active_modal: Option<ActiveModal>,
dismiss_on_focus_lost: bool,
}
pub(crate) struct ModalOpenedEvent;
impl EventEmitter<ModalOpenedEvent> for ModalLayer {}
impl Default for ModalLayer {
fn default() -> Self {
Self::new()
}
}
impl ModalLayer {
pub fn new() -> Self {
Self {
active_modal: None,
dismiss_on_focus_lost: false,
}
}
pub fn toggle_modal<V, B>(&mut self, window: &mut Window, cx: &mut Context<Self>, build_view: B)
where
V: ModalView,
B: FnOnce(&mut Window, &mut Context<V>) -> V,
{
if let Some(active_modal) = &self.active_modal {
let is_close = active_modal.modal.view().downcast::<V>().is_ok();
let did_close = self.hide_modal(window, cx);
if is_close || !did_close {
return;
}
}
let new_modal = cx.new(|cx| build_view(window, cx));
self.show_modal(new_modal, window, cx);
cx.emit(ModalOpenedEvent);
}
fn show_modal<V>(&mut self, new_modal: Entity<V>, window: &mut Window, cx: &mut Context<Self>)
where
V: ModalView,
{
let focus_handle = cx.focus_handle();
self.active_modal = Some(ActiveModal {
modal: Box::new(new_modal.clone()),
_subscriptions: [
cx.subscribe_in(
&new_modal,
window,
|this, _, _: &DismissEvent, window, cx| {
this.hide_modal(window, cx);
},
),
cx.on_focus_out(&focus_handle, window, |this, _event, window, cx| {
if this.dismiss_on_focus_lost {
this.hide_modal(window, cx);
}
}),
],
previous_focus_handle: window.focused(cx),
focus_handle,
});
cx.defer_in(window, move |_, window, cx| {
window.focus(&new_modal.focus_handle(cx));
});
cx.notify();
}
pub fn hide_modal(&mut self, window: &mut Window, cx: &mut Context<Self>) -> bool {
let Some(active_modal) = self.active_modal.as_mut() else {
self.dismiss_on_focus_lost = false;
return false;
};
match active_modal.modal.on_before_dismiss(window, cx) {
DismissDecision::Dismiss(dismiss) => {
self.dismiss_on_focus_lost = !dismiss;
if !dismiss {
return false;
}
}
DismissDecision::Pending => {
self.dismiss_on_focus_lost = false;
return false;
}
}
if let Some(active_modal) = self.active_modal.take() {
if let Some(previous_focus) = active_modal.previous_focus_handle {
if active_modal.focus_handle.contains_focused(window, cx) {
previous_focus.focus(window);
}
}
cx.notify();
}
true
}
pub fn active_modal<V>(&self) -> Option<Entity<V>>
where
V: 'static,
{
let active_modal = self.active_modal.as_ref()?;
active_modal.modal.view().downcast::<V>().ok()
}
pub fn has_active_modal(&self) -> bool {
self.active_modal.is_some()
}
}
impl Render for ModalLayer {
fn render(&mut self, _: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
let Some(active_modal) = &self.active_modal else {
return div();
};
div()
.occlude()
.absolute()
.size_full()
.top_0()
.left_0()
.when(active_modal.modal.fade_out_background(cx), |el| {
let mut background = cx.theme().colors().elevated_surface_background;
background.fade_out(0.2);
el.bg(background)
})
.on_mouse_down(
MouseButton::Left,
cx.listener(|this, _, window, cx| {
this.hide_modal(window, cx);
}),
)
.child(
v_flex()
.h(px(0.0))
.top_20()
.flex()
.flex_col()
.items_center()
.track_focus(&active_modal.focus_handle)
.child(
h_flex()
.occlude()
.child(active_modal.modal.view())
.on_mouse_down(MouseButton::Left, |_, _, cx| {
cx.stop_propagation();
}),
),
)
}
}