guise-ui 1.7.0

A component library for gpui, Zed's GPU-accelerated UI framework: a themed palette, sizing tokens, 130+ composable components, a reactive state layer, and an in-app Safari-style inspector.
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

//! The right-click Cut / Copy / Paste / Select All menu every text surface
//! opens.
//!
//! Built fresh on each right-click, so it offers only what applies at that
//! moment: no Cut or Copy without a selection or in a masked field, no Cut or
//! Paste when the field is read-only. [`ContextMenu`] has no disabled items,
//! so leaving an entry out is how "not now" is said.
//!
//! The items don't touch the field. Each one sends the matching
//! [`actions`](crate::actions) action to the field's focus handle, so the
//! menu, the keyboard, and a host's Edit menu all run the same code.

use gpui::{Action, AppContext as _, Context, Entity, FocusHandle, Pixels, Point, Window};

use crate::actions;
use crate::icon::IconName;
use crate::overlay::ContextMenu;

/// What the menu should offer, decided by the field at the moment of the
/// click.
pub(crate) struct EditMenu {
  pub cut: bool,
  pub copy: bool,
  pub paste: bool,
}

impl EditMenu {
  /// The usual rules: copying needs a selection and an unmasked field,
  /// cutting also needs it to be editable, pasting only needs that.
  pub fn new(selection: bool, masked: bool, read_only: bool) -> Self {
    EditMenu {
      cut: selection && !masked && !read_only,
      copy: selection && !masked,
      paste: !read_only,
    }
  }
}

/// Build the menu, open it at `position`, and put it in `slot` for the field
/// to render. The field renders `slot` inside itself; the menu paints
/// deferred, so the field's clipping doesn't reach it.
pub(crate) fn open<V: 'static>(
  slot: &mut Option<Entity<ContextMenu>>,
  menu: EditMenu,
  focus: &FocusHandle,
  position: Point<Pixels>,
  window: &mut Window,
  cx: &mut Context<V>,
) {
  let send = |action: Box<dyn Action>| {
    let focus = focus.clone();
    move |window: &mut Window, cx: &mut gpui::App| {
      focus.dispatch_action(action.as_ref(), window, cx)
    }
  };
  let entity = cx.new(|cx| {
    let mut m = ContextMenu::new(cx).width(180.0);
    if menu.cut {
      m = m.item_icon(IconName::Scissors, "Cut", send(Box::new(actions::Cut)));
    }
    if menu.copy {
      m = m.item_icon(IconName::Copy, "Copy", send(Box::new(actions::Copy)));
    }
    if menu.paste {
      m = m.item_icon(
        IconName::ClipboardPaste,
        "Paste",
        send(Box::new(actions::Paste)),
      );
    }
    if menu.cut || menu.copy || menu.paste {
      m = m.divider();
    }
    m.item_icon(
      IconName::TextSelect,
      "Select All",
      send(Box::new(actions::SelectAll)),
    )
  });
  entity.update(cx, |m, cx| m.show(position, window, cx));
  *slot = Some(entity);
}

/// Whether a field's menu is open, in which case the field ignores keys: the
/// menu holds focus, but it is rendered inside the field, so its keys bubble
/// there.
pub(crate) fn is_open(slot: &Option<Entity<ContextMenu>>, cx: &gpui::App) -> bool {
  slot.as_ref().is_some_and(|m| m.read(cx).is_open())
}

/// The slot, wrapped so it takes no room: absolutely positioned, it is no
/// flex item and adds no gap.
pub(crate) fn slot(slot: &Option<Entity<ContextMenu>>) -> Option<gpui::Div> {
  use gpui::{div, ParentElement, Styled};
  slot.clone().map(|m| div().absolute().child(m))
}