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, ) -> DismissDecision { DismissDecision::Dismiss(true) } fn fade_out_background(&self) -> bool { false } fn render_bare(&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; fn render_bare(&self, cx: &mut App) -> bool; } impl ModalViewHandle for Entity { 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() } fn render_bare(&self, cx: &mut App) -> bool { self.read(cx).render_bare() } } pub struct ActiveModal { modal: Box, _subscriptions: [Subscription; 2], previous_focus_handle: Option, focus_handle: FocusHandle, } pub struct ModalLayer { active_modal: Option, dismiss_on_focus_lost: bool, } pub(crate) struct ModalOpenedEvent; impl EventEmitter 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, } } /// Toggles a modal of type `V`. If a modal of the same type is currently active, /// it will be hidden. If a different modal is active, it will be replaced with the new one. /// If no modal is active, the new modal will be shown. /// /// If closing the current modal fails (e.g., due to `on_before_dismiss` returning /// `DismissDecision::Dismiss(false)` or `DismissDecision::Pending`), the new modal /// will not be shown. pub fn toggle_modal(&mut self, window: &mut Window, cx: &mut Context, build_view: B) where V: ModalView, B: FnOnce(&mut Window, &mut Context) -> V, { if let Some(active_modal) = &self.active_modal { let should_close = active_modal.modal.view().downcast::().is_ok(); let did_close = self.hide_modal(window, cx); if should_close || !did_close { return; } } let new_modal = cx.new(|cx| build_view(window, cx)); self.show_modal(new_modal, window, cx); cx.emit(ModalOpenedEvent); } /// Shows a modal and sets up subscriptions for dismiss events and focus tracking. /// The modal is automatically focused after being shown. fn show_modal(&mut self, new_modal: Entity, window: &mut Window, cx: &mut Context) 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); }); cx.notify(); } /// Attempts to hide the currently active modal. /// /// The modal's `on_before_dismiss` method is called to determine if dismissal should proceed. /// If dismissal is allowed, the modal is removed and focus is restored to the previously /// focused element. /// /// Returns `true` if the modal was successfully hidden, `false` otherwise. pub fn hide_modal(&mut self, window: &mut Window, cx: &mut Context) -> 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(should_dismiss) => { if !should_dismiss { self.dismiss_on_focus_lost = !should_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 && active_modal.focus_handle.contains_focused(window, cx) { previous_focus.focus(window, cx); } cx.notify(); } self.dismiss_on_focus_lost = false; true } /// Returns the currently active modal if it is of type `V`. pub fn active_modal(&self) -> Option> where V: 'static, { let active_modal = self.active_modal.as_ref()?; active_modal.modal.view().downcast::().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) -> impl IntoElement { let Some(active_modal) = &self.active_modal else { return div().into_any_element(); }; if active_modal.modal.render_bare(cx) { return active_modal.modal.view().into_any_element(); } div() .absolute() .size_full() .inset_0() .occlude() .when(active_modal.modal.fade_out_background(cx), |this| { let mut background = cx.theme().colors().elevated_surface_background; background.fade_out(0.2); this.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() .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(); }), ), ) .into_any_element() } }