gpui-box-kit 0.1.1

GPUI Box Kit design-system components and interaction primitives
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371

//! A modal that asks one question and reports the answer.
//!
//! Open state and the element that had the keyboard before opening both
//! outlive a frame, so a dialog is a view rather than a builder. The body is
//! a callback instead of a stored element because an `AnyElement` can be
//! consumed once, while the dialog re-renders for as long as it stays open.

use std::rc::Rc;

use gpui::{
    AnyElement, App, Context, EventEmitter, FocusHandle, Focusable, InteractiveElement,
    IntoElement, KeyDownEvent, ParentElement, Render, SharedString, Styled, Window, div, px,
};
use gpui_kit_semantics::{NodeSpec, Role, Semantic};
use gpui_kit_theme::{ActiveTheme, Elevation, Space};

use crate::controls::button::{Button, ButtonVariant};
use crate::foundation::{Ident, StyledExt};
use crate::overlay::focus::FocusTrap;
use crate::overlay::layer::{Overlay, surface};
use crate::overlay::panel::{self, Body};

/// What the dialog reports. The owner decides what any of it means.
///
/// An outcome is always followed by [`DialogEvent::Closed`], so a subscriber
/// that only cares that the dialog went away has one event to watch.
#[derive(Debug, Clone, Copy, PartialEq, Eq)]
pub enum DialogEvent {
    Opened,
    /// The primary action was taken.
    Confirmed,
    /// The cancel action was taken.
    Cancelled,
    /// The dialog was waved away, by escape or by the scrim.
    Dismissed,
    Closed,
}

impl EventEmitter<DialogEvent> for Dialog {}

/// A composed modal: scrim, focus trap, title, body, and up to two actions.
pub struct Dialog {
    ident: Ident,
    focus_handle: FocusHandle,
    confirm_focus: FocusHandle,
    cancel_focus: FocusHandle,
    title: SharedString,
    description: Option<SharedString>,
    body: Option<Body>,
    confirm_label: Option<SharedString>,
    cancel_label: Option<SharedString>,
    dismissable: bool,
    destructive: bool,
    open: bool,
    /// Set by `open`, cleared by the first frame that can act on it.
    pending_focus: bool,
    trap: FocusTrap,
}

impl std::fmt::Debug for Dialog {
    fn fmt(&self, formatter: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        formatter
            .debug_struct("Dialog")
            .field("ident", &self.ident)
            .field("title", &self.title)
            .field("has_body", &self.body.is_some())
            .field("dismissable", &self.dismissable)
            .field("destructive", &self.destructive)
            .field("open", &self.open)
            .finish()
    }
}

impl Dialog {
    pub fn new(ident: impl Into<Ident>, _window: &mut Window, cx: &mut Context<Self>) -> Self {
        Self {
            ident: ident.into(),
            focus_handle: cx.focus_handle(),
            confirm_focus: cx.focus_handle(),
            cancel_focus: cx.focus_handle(),
            title: SharedString::default(),
            description: None,
            body: None,
            confirm_label: None,
            cancel_label: None,
            dismissable: true,
            destructive: false,
            open: false,
            pending_focus: false,
            trap: FocusTrap::new(),
        }
    }

    pub fn title(mut self, title: impl Into<SharedString>) -> Self {
        self.title = title.into();
        self
    }

    pub fn description(mut self, description: impl Into<SharedString>) -> Self {
        self.description = Some(description.into());
        self
    }

    /// Supplies the body, rebuilt on every frame the dialog is open.
    pub fn content(mut self, body: impl Fn(&mut Window, &mut App) -> AnyElement + 'static) -> Self {
        self.body = Some(Rc::new(body));
        self
    }

    /// Whether escape and the scrim close the dialog. A dialog that is not
    /// dismissable installs neither handler.
    pub fn dismissable(mut self, dismissable: bool) -> Self {
        self.dismissable = dismissable;
        self
    }

    /// Marks the primary action as one that destroys something.
    pub fn destructive(mut self, destructive: bool) -> Self {
        self.destructive = destructive;
        self
    }

    pub fn confirm_label(mut self, label: impl Into<SharedString>) -> Self {
        self.confirm_label = Some(label.into());
        self
    }

    pub fn cancel_label(mut self, label: impl Into<SharedString>) -> Self {
        self.cancel_label = Some(label.into());
        self
    }

    pub fn is_open(&self) -> bool {
        self.open
    }

    pub fn is_dismissable(&self) -> bool {
        self.dismissable
    }

    pub fn set_title(&mut self, title: impl Into<SharedString>, cx: &mut Context<Self>) {
        self.title = title.into();
        cx.notify();
    }

    pub fn set_description(&mut self, description: Option<SharedString>, cx: &mut Context<Self>) {
        self.description = description;
        cx.notify();
    }

    pub fn open(&mut self, window: &mut Window, cx: &mut Context<Self>) {
        if self.open {
            return;
        }
        self.open = true;
        self.pending_focus = true;
        self.trap.engage(window, cx);
        cx.emit(DialogEvent::Opened);
        cx.notify();
    }

    /// Closes without an outcome. The window is required because closing gives
    /// the keyboard back to whatever held it before the dialog opened.
    pub fn close(&mut self, window: &mut Window, cx: &mut Context<Self>) {
        if !self.open {
            return;
        }
        self.open = false;
        self.pending_focus = false;
        self.trap.release(window, cx);
        cx.emit(DialogEvent::Closed);
        cx.notify();
    }

    pub fn confirm(&mut self, window: &mut Window, cx: &mut Context<Self>) {
        if !self.open {
            return;
        }
        cx.emit(DialogEvent::Confirmed);
        self.close(window, cx);
    }

    pub fn cancel(&mut self, window: &mut Window, cx: &mut Context<Self>) {
        if !self.open {
            return;
        }
        cx.emit(DialogEvent::Cancelled);
        self.close(window, cx);
    }

    /// Reports a wave-away. A dialog that is not dismissable cannot be waved
    /// away even by a host calling this directly.
    pub fn dismiss(&mut self, window: &mut Window, cx: &mut Context<Self>) {
        if !self.open || !self.dismissable {
            return;
        }
        cx.emit(DialogEvent::Dismissed);
        self.close(window, cx);
    }

    /// Where the keyboard lands when the dialog opens.
    ///
    /// A destructive confirmation opens on cancel, so a stray return key does
    /// not destroy anything.
    fn initial_focus(&self) -> FocusHandle {
        if self.destructive && self.cancel_label.is_some() {
            return self.cancel_focus.clone();
        }
        if self.confirm_label.is_some() {
            return self.confirm_focus.clone();
        }
        if self.cancel_label.is_some() {
            return self.cancel_focus.clone();
        }
        self.focus_handle.clone()
    }

    fn on_navigation_key(
        &mut self,
        event: &KeyDownEvent,
        window: &mut Window,
        cx: &mut Context<Self>,
    ) {
        if !self.open || event.keystroke.key.as_str() != "tab" {
            return;
        }
        if event.keystroke.modifiers.shift {
            self.trap.focus_prev(window, cx);
        } else {
            self.trap.focus_next(window, cx);
        }
        cx.stop_propagation();
    }

    fn on_dismiss_key(
        &mut self,
        event: &KeyDownEvent,
        window: &mut Window,
        cx: &mut Context<Self>,
    ) {
        if !self.open || event.keystroke.key.as_str() != "escape" {
            return;
        }
        self.dismiss(window, cx);
        cx.stop_propagation();
    }

    fn actions(&self, cx: &mut Context<Self>) -> Option<AnyElement> {
        if self.confirm_label.is_none() && self.cancel_label.is_none() {
            return None;
        }
        let theme = cx.theme().clone();
        let dialog = cx.entity().downgrade();
        let cancel = self.cancel_label.clone().map(|label| {
            let dialog = dialog.clone();
            Button::new(self.ident.child("cancel"))
                .label(label)
                .secondary()
                .track_focus(&self.cancel_focus)
                .on_click(move |window, cx| {
                    dialog
                        .update(cx, |dialog, cx| dialog.cancel(window, cx))
                        .ok();
                })
        });
        let confirm = self.confirm_label.clone().map(|label| {
            let dialog = dialog.clone();
            Button::new(self.ident.child("confirm"))
                .label(label)
                .variant(if self.destructive {
                    ButtonVariant::Danger
                } else {
                    ButtonVariant::Primary
                })
                .track_focus(&self.confirm_focus)
                .on_click(move |window, cx| {
                    dialog
                        .update(cx, |dialog, cx| dialog.confirm(window, cx))
                        .ok();
                })
        });

        Some(
            div()
                .row()
                .justify_end()
                .gap_token(&theme, Space::Sm)
                .children(cancel)
                .children(confirm)
                .into_any_element(),
        )
    }
}

impl Focusable for Dialog {
    fn focus_handle(&self, _cx: &App) -> FocusHandle {
        self.focus_handle.clone()
    }
}

impl Render for Dialog {
    fn render(&mut self, window: &mut Window, cx: &mut Context<Self>) -> impl IntoElement {
        self.trap.begin_frame();
        if !self.open {
            return div().into_any_element();
        }

        if self.cancel_label.is_some() {
            self.trap.register(self.cancel_focus.clone());
        }
        if self.confirm_label.is_some() {
            self.trap.register(self.confirm_focus.clone());
        }
        if self.trap.stops().is_empty() {
            self.trap.register(self.focus_handle.clone());
        }
        if self.pending_focus {
            // The handle can only take focus once this frame has put it in the
            // dispatch tree, which is why opening only records the intent.
            self.pending_focus = false;
            self.initial_focus().focus(window, cx);
        }

        let theme = cx.theme().clone();
        let title = self.title.clone();
        let description = self.description.clone();
        let body = self.body.clone().map(|body| body(window, cx));
        let actions = self.actions(cx);

        let mut spec = NodeSpec::new(self.ident.semantic_id(), Role::Dialog)
            .modal(true)
            .focus(&self.focus_handle);
        if !title.is_empty() {
            spec = spec.text(title.clone());
        }
        if let Some(description) = description.clone() {
            spec = spec.description(description);
        }

        let heading = (!title.is_empty()).then(|| panel::heading(&self.ident, &theme, title, cx));
        let description =
            description.map(|description| panel::description(&self.ident, &theme, description, cx));

        let mut card = surface(&theme, Elevation::Modal)
            .w(px(360.0))
            .p_token(&theme, Space::Lg)
            .gap_token(&theme, Space::Sm)
            .track_focus(&self.focus_handle)
            .on_key_down(cx.listener(Self::on_navigation_key));
        if self.dismissable {
            card = card.on_key_down(cx.listener(Self::on_dismiss_key));
        }
        let card = card
            .children(heading)
            .children(description)
            .children(body)
            .children(actions)
            .semantic_in(cx, spec);

        let mut overlay = Overlay::modal(self.ident.child("overlay")).child(card);
        if self.dismissable {
            let dialog = cx.entity().downgrade();
            overlay = overlay.on_dismiss(move |window, cx| {
                dialog
                    .update(cx, |dialog, cx| dialog.dismiss(window, cx))
                    .ok();
            });
        }
        overlay.into_any_element()
    }
}