use gpui::prelude::FluentBuilder as _; use std::rc::Rc; use gpui::{ Animation, AnimationExt as _, AnyElement, App, DefiniteLength, ElementId, InteractiveElement as _, IntoElement, KeyDownEvent, MouseButton, ParentElement as _, RenderOnce, Role, ScrollHandle, SharedString, StatefulInteractiveElement as _, StyleRefinement, Styled as _, Window, canvas, deferred, div, ease_out_quint, relative, }; use gpui_native_icons::IconRole; use gpui_native_theme::{ActiveTheme as _, DIALOG_MIN_WIDTH, TextRole, Typeset as _}; use crate::button::{Button, ButtonVariant}; use crate::common::{DIALOG_LAYER, Sizable, StyledExt as _, v_flex}; use crate::grain::grain; use crate::scroll_area::ScrollArea; /// Requests the dialog's close: `false` closes. pub type ChangeHandler = Rc; type ContentFn = Box AnyElement>; type ActionsFn = Box Vec>; /// A centred panel over a dim scrim: the platform's modal. #[derive(IntoElement)] #[must_use] pub struct Dialog { id: ElementId, open: bool, alert: bool, grain: bool, title: Option, a11y_label: Option, on_change: Option, content: Option, actions: Option, min_width: Option, height: Option, style: StyleRefinement, } impl Dialog { /// Creates a closed dialog. pub fn new(id: I) -> Self where I: Into, { Self { id: id.into(), open: false, alert: false, grain: false, title: None, a11y_label: None, on_change: None, content: None, actions: None, min_width: None, height: None, style: StyleRefinement::default(), } } /// Sets the current open state. pub fn open(mut self, open: bool) -> Self { self.open = open; self } /// Sets the alert mode. pub fn alert(mut self, alert: bool) -> Self { self.alert = alert; self } /// Textures the scrim with a film-grain overlay. pub fn grain(mut self, grain: bool) -> Self { self.grain = grain; self } /// Requests close through `on_change` on escape, scrim clicks, and the close button. pub fn on_change(mut self, handler: F) -> Self where F: Fn(bool, &mut Window, &mut App) + 'static, { self.on_change = Some(Rc::new(handler)); self } /// Sets the dialog's title. pub fn title(mut self, title: L) -> Self where L: Into, { self.title = Some(title.into()); self } /// Sets the body content between the title and the actions. pub fn content(mut self, content: F) -> Self where F: Fn(&mut Window, &mut App) -> AnyElement + 'static, { self.content = Some(Box::new(content)); self } /// Sets the footer actions, laid out right-aligned in the given order. pub fn actions(mut self, actions: F) -> Self where F: Fn(&mut Window, &mut App) -> Vec + 'static, { self.actions = Some(Box::new(actions)); self } /// Overrides the accessibility label of the panel. pub fn accessibility_label(mut self, label: L) -> Self where L: Into, { self.a11y_label = Some(label.into()); self } /// Sets the panel's minimum width, defaults to the standard dialog width. pub fn min_width(mut self, width: W) -> Self where W: Into, { self.min_width = Some(width.into()); self } /// Sets the panel's height, body content taller than the panel scrolls. pub fn height(mut self, height: H) -> Self where H: Into, { self.height = Some(height.into()); self } } impl gpui::Styled for Dialog { fn style(&mut self) -> &mut StyleRefinement { &mut self.style } } impl RenderOnce for Dialog { fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement { let root = div().absolute().inset_0(); if !self.open { return root.into_any_element(); } let (scrim_color, border, foreground, surface, radius, shadows, enter_duration) = { let theme = cx.theme(); ( theme.colors.overlay, theme.colors.border, theme.colors.foreground, theme.colors.surface, theme.radius.overlay, theme.elevations.dialog.shadows(), theme.motion.overlay, ) }; let role = if self.alert { Role::AlertDialog } else { Role::Dialog }; let label = self .a11y_label .clone() .or_else(|| self.title.clone()) .unwrap_or_else(|| SharedString::from(self.id.to_string())); let on_change = self.on_change.clone(); let alert = self.alert; let show_close = !alert && on_change.is_some(); // Keyboard focus rides the panel across frames. let focus = gpui_native_utils::focus_handle(&self.id, window, cx); let content = self.content.map(|build| build(window, cx)); let actions = self.actions.map(|build| build(window, cx)); let height = self.height; let scroll = window .use_keyed_state("dialog-content-scroll", cx, |_, _| ScrollHandle::new()) .read(cx) .clone(); let panel = v_flex() .id("dialog-panel") .track_focus(&focus) .role(role) .aria_label(label) .when_some(self.min_width, |panel, width| panel.min_w(width)) .when(self.min_width.is_none(), |panel| { panel.min_w(DIALOG_MIN_WIDTH) }) .max_w(relative(0.9)) .when_some(height, |panel, height| panel.h(height)) .p_4() .gap_4() .bg(surface) .text_color(foreground) .rounded(radius) .border_1() .border_color(border) .shadow(shadows) .overflow_hidden() .on_mouse_down(MouseButton::Left, |_, _, cx| cx.stop_propagation()) .on_key_down({ let on_change = on_change.clone(); move |event: &KeyDownEvent, window, cx| { if event.keystroke.key == "escape" && !alert && let Some(on_change) = &on_change { on_change(false, window, cx); } cx.stop_propagation(); } }) .when(self.title.is_some() || show_close, |panel| { panel.child( div() .flex() .items_center() .justify_end() .gap_2() .when_some(self.title.clone(), |row, title| { row.child(div().flex_1().typeset(TextRole::Title3, cx).child(title)) }) .when(show_close, |row| { row.child( Button::new("dialog-close") .icon(IconRole::Close) .variant(ButtonVariant::Ghost) .xsmall() .debug_selector(|| "dialog-close".to_string()) .accessibility_label("Close") .on_click({ let on_change = on_change.clone(); move |_, window, cx| { if let Some(on_change) = &on_change { on_change(false, window, cx); } } }), ) }), ) }) .when_some(content, |panel, content| { panel.map(|this| { if height.is_some() { this.child( ScrollArea::new("dialog-content") .handle(scroll) .flex_1() .min_h_0() .child(content), ) } else { this.child(content) } }) }) .when_some(actions, |panel, actions| { panel.child(div().flex().justify_end().gap_3().children(actions)) }) .child( canvas(|_, _, _| {}, { move |_, _, window, cx| { if !focus.contains_focused(window, cx) { window.focus(&focus, cx); } } }) .absolute() .inset_0(), ); let scrim = div() .absolute() .inset_0() .bg(scrim_color) .occlude() .when(self.grain, |scrim| scrim.child(grain())) .when(!alert, |scrim| { scrim.on_mouse_down(MouseButton::Left, { let on_change = on_change.clone(); move |_, _window, cx| { if let Some(on_change) = &on_change { on_change(false, _window, cx); } cx.stop_propagation(); } }) }); deferred( root.flex() .items_center() .justify_center() .p_4() .refine_style(&self.style) .child(scrim.with_animation( "dialog-scrim-enter", Animation::new(enter_duration).with_easing(ease_out_quint()), |scrim, delta| scrim.opacity(delta), )) .child(panel.with_animation( "dialog-enter", Animation::new(enter_duration).with_easing(ease_out_quint()), |panel, delta| panel.opacity(delta), )), ) .with_priority(DIALOG_LAYER) .into_any_element() } }