1use crate::ItemHandle;
2use gpui::{
3 AnyView, Entity, EntityId, EventEmitter, ParentElement as _, Render, Styled, View, ViewContext,
4 WindowContext,
5};
6use ui::prelude::*;
7use ui::{h_flex, v_flex};
8
9pub enum ToolbarItemEvent {
10 ChangeLocation(ToolbarItemLocation),
11}
12
13pub trait ToolbarItemView: Render + EventEmitter<ToolbarItemEvent> {
14 fn set_active_pane_item(
15 &mut self,
16 active_pane_item: Option<&dyn crate::ItemHandle>,
17 cx: &mut ViewContext<Self>,
18 ) -> ToolbarItemLocation;
19
20 fn pane_focus_update(&mut self, _pane_focused: bool, _cx: &mut ViewContext<Self>) {}
21
22 /// Number of times toolbar's height will be repeated to get the effective height.
23 /// Useful when multiple rows one under each other are needed.
24 /// The rows have the same width and act as a whole when reacting to resizes and similar events.
25 fn row_count(&self, _cx: &WindowContext) -> usize {
26 1
27 }
28}
29
30trait ToolbarItemViewHandle: Send {
31 fn id(&self) -> EntityId;
32 fn to_any(&self) -> AnyView;
33 fn set_active_pane_item(
34 &self,
35 active_pane_item: Option<&dyn ItemHandle>,
36 cx: &mut WindowContext,
37 ) -> ToolbarItemLocation;
38 fn focus_changed(&mut self, pane_focused: bool, cx: &mut WindowContext);
39 fn row_count(&self, cx: &WindowContext) -> usize;
40}
41
42#[derive(Copy, Clone, Debug, PartialEq)]
43pub enum ToolbarItemLocation {
44 Hidden,
45 PrimaryLeft,
46 PrimaryRight,
47 Secondary,
48}
49
50pub struct Toolbar {
51 active_item: Option<Box<dyn ItemHandle>>,
52 hidden: bool,
53 can_navigate: bool,
54 items: Vec<(Box<dyn ToolbarItemViewHandle>, ToolbarItemLocation)>,
55}
56
57impl Toolbar {
58 fn has_any_visible_items(&self) -> bool {
59 self.items
60 .iter()
61 .any(|(_item, location)| *location != ToolbarItemLocation::Hidden)
62 }
63
64 fn left_items(&self) -> impl Iterator<Item = &dyn ToolbarItemViewHandle> {
65 self.items.iter().filter_map(|(item, location)| {
66 if *location == ToolbarItemLocation::PrimaryLeft {
67 Some(item.as_ref())
68 } else {
69 None
70 }
71 })
72 }
73
74 fn right_items(&self) -> impl Iterator<Item = &dyn ToolbarItemViewHandle> {
75 self.items.iter().filter_map(|(item, location)| {
76 if *location == ToolbarItemLocation::PrimaryRight {
77 Some(item.as_ref())
78 } else {
79 None
80 }
81 })
82 }
83
84 fn secondary_items(&self) -> impl Iterator<Item = &dyn ToolbarItemViewHandle> {
85 self.items.iter().filter_map(|(item, location)| {
86 if *location == ToolbarItemLocation::Secondary {
87 Some(item.as_ref())
88 } else {
89 None
90 }
91 })
92 }
93}
94
95impl Render for Toolbar {
96 fn render(&mut self, cx: &mut ViewContext<Self>) -> impl IntoElement {
97 if !self.has_any_visible_items() {
98 return div();
99 }
100
101 let secondary_item = self.secondary_items().next().map(|item| item.to_any());
102
103 let has_left_items = self.left_items().count() > 0;
104 let has_right_items = self.right_items().count() > 0;
105
106 v_flex()
107 .p_2()
108 .when(has_left_items || has_right_items, |this| this.gap_2())
109 .border_b()
110 .border_color(cx.theme().colors().border_variant)
111 .bg(cx.theme().colors().toolbar_background)
112 .child(
113 h_flex()
114 .justify_between()
115 .gap_2()
116 .when(has_left_items, |this| {
117 this.child(
118 h_flex()
119 .flex_auto()
120 .justify_start()
121 .overflow_x_hidden()
122 .children(self.left_items().map(|item| item.to_any())),
123 )
124 })
125 .when(has_right_items, |this| {
126 this.child(
127 h_flex()
128 // We're using `flex_none` here to prevent some flickering that can occur when the
129 // size of the left items container changes.
130 .when_else(has_left_items, Div::flex_none, Div::flex_auto)
131 .justify_end()
132 .children(self.right_items().map(|item| item.to_any())),
133 )
134 }),
135 )
136 .children(secondary_item)
137 }
138}
139
140impl Toolbar {
141 pub fn new() -> Self {
142 Self {
143 active_item: None,
144 items: Default::default(),
145 hidden: false,
146 can_navigate: true,
147 }
148 }
149
150 pub fn set_can_navigate(&mut self, can_navigate: bool, cx: &mut ViewContext<Self>) {
151 self.can_navigate = can_navigate;
152 cx.notify();
153 }
154
155 pub fn add_item<T>(&mut self, item: View<T>, cx: &mut ViewContext<Self>)
156 where
157 T: 'static + ToolbarItemView,
158 {
159 let location = item.set_active_pane_item(self.active_item.as_deref(), cx);
160 cx.subscribe(&item, |this, item, event, cx| {
161 if let Some((_, current_location)) =
162 this.items.iter_mut().find(|(i, _)| i.id() == item.id())
163 {
164 match event {
165 ToolbarItemEvent::ChangeLocation(new_location) => {
166 if new_location != current_location {
167 *current_location = *new_location;
168 cx.notify();
169 }
170 }
171 }
172 }
173 })
174 .detach();
175 self.items.push((Box::new(item), location));
176 cx.notify();
177 }
178
179 pub fn set_active_item(&mut self, item: Option<&dyn ItemHandle>, cx: &mut ViewContext<Self>) {
180 self.active_item = item.map(|item| item.boxed_clone());
181 self.hidden = self
182 .active_item
183 .as_ref()
184 .map(|item| !item.show_toolbar(cx))
185 .unwrap_or(false);
186
187 for (toolbar_item, current_location) in self.items.iter_mut() {
188 let new_location = toolbar_item.set_active_pane_item(item, cx);
189 if new_location != *current_location {
190 *current_location = new_location;
191 cx.notify();
192 }
193 }
194 }
195
196 pub fn focus_changed(&mut self, focused: bool, cx: &mut ViewContext<Self>) {
197 for (toolbar_item, _) in self.items.iter_mut() {
198 toolbar_item.focus_changed(focused, cx);
199 }
200 }
201
202 pub fn item_of_type<T: ToolbarItemView>(&self) -> Option<View<T>> {
203 self.items
204 .iter()
205 .find_map(|(item, _)| item.to_any().downcast().ok())
206 }
207
208 pub fn hidden(&self) -> bool {
209 self.hidden
210 }
211}
212
213impl<T: ToolbarItemView> ToolbarItemViewHandle for View<T> {
214 fn id(&self) -> EntityId {
215 self.entity_id()
216 }
217
218 fn to_any(&self) -> AnyView {
219 self.clone().into()
220 }
221
222 fn set_active_pane_item(
223 &self,
224 active_pane_item: Option<&dyn ItemHandle>,
225 cx: &mut WindowContext,
226 ) -> ToolbarItemLocation {
227 self.update(cx, |this, cx| {
228 this.set_active_pane_item(active_pane_item, cx)
229 })
230 }
231
232 fn focus_changed(&mut self, pane_focused: bool, cx: &mut WindowContext) {
233 self.update(cx, |this, cx| {
234 this.pane_focus_update(pane_focused, cx);
235 cx.notify();
236 });
237 }
238
239 fn row_count(&self, cx: &WindowContext) -> usize {
240 self.read(cx).row_count(cx)
241 }
242}