toolbar.rs

  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_stack, v_stack};
  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_stack()
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_stack()
114                    .justify_between()
115                    .when(has_left_items, |this| {
116                        this.child(
117                            h_stack()
118                                .flex_1()
119                                .justify_start()
120                                .children(self.left_items().map(|item| item.to_any())),
121                        )
122                    })
123                    .when(has_right_items, |this| {
124                        this.child(
125                            h_stack()
126                                .flex_1()
127                                .justify_end()
128                                .children(self.right_items().map(|item| item.to_any())),
129                        )
130                    }),
131            )
132            .children(secondary_item)
133    }
134}
135
136impl Toolbar {
137    pub fn new() -> Self {
138        Self {
139            active_item: None,
140            items: Default::default(),
141            hidden: false,
142            can_navigate: true,
143        }
144    }
145
146    pub fn set_can_navigate(&mut self, can_navigate: bool, cx: &mut ViewContext<Self>) {
147        self.can_navigate = can_navigate;
148        cx.notify();
149    }
150
151    pub fn add_item<T>(&mut self, item: View<T>, cx: &mut ViewContext<Self>)
152    where
153        T: 'static + ToolbarItemView,
154    {
155        let location = item.set_active_pane_item(self.active_item.as_deref(), cx);
156        cx.subscribe(&item, |this, item, event, cx| {
157            if let Some((_, current_location)) =
158                this.items.iter_mut().find(|(i, _)| i.id() == item.id())
159            {
160                match event {
161                    ToolbarItemEvent::ChangeLocation(new_location) => {
162                        if new_location != current_location {
163                            *current_location = *new_location;
164                            cx.notify();
165                        }
166                    }
167                }
168            }
169        })
170        .detach();
171        self.items.push((Box::new(item), location));
172        cx.notify();
173    }
174
175    pub fn set_active_item(&mut self, item: Option<&dyn ItemHandle>, cx: &mut ViewContext<Self>) {
176        self.active_item = item.map(|item| item.boxed_clone());
177        self.hidden = self
178            .active_item
179            .as_ref()
180            .map(|item| !item.show_toolbar(cx))
181            .unwrap_or(false);
182
183        for (toolbar_item, current_location) in self.items.iter_mut() {
184            let new_location = toolbar_item.set_active_pane_item(item, cx);
185            if new_location != *current_location {
186                *current_location = new_location;
187                cx.notify();
188            }
189        }
190    }
191
192    pub fn focus_changed(&mut self, focused: bool, cx: &mut ViewContext<Self>) {
193        for (toolbar_item, _) in self.items.iter_mut() {
194            toolbar_item.focus_changed(focused, cx);
195        }
196    }
197
198    pub fn item_of_type<T: ToolbarItemView>(&self) -> Option<View<T>> {
199        self.items
200            .iter()
201            .find_map(|(item, _)| item.to_any().downcast().ok())
202    }
203
204    pub fn hidden(&self) -> bool {
205        self.hidden
206    }
207}
208
209impl<T: ToolbarItemView> ToolbarItemViewHandle for View<T> {
210    fn id(&self) -> EntityId {
211        self.entity_id()
212    }
213
214    fn to_any(&self) -> AnyView {
215        self.clone().into()
216    }
217
218    fn set_active_pane_item(
219        &self,
220        active_pane_item: Option<&dyn ItemHandle>,
221        cx: &mut WindowContext,
222    ) -> ToolbarItemLocation {
223        self.update(cx, |this, cx| {
224            this.set_active_pane_item(active_pane_item, cx)
225        })
226    }
227
228    fn focus_changed(&mut self, pane_focused: bool, cx: &mut WindowContext) {
229        self.update(cx, |this, cx| {
230            this.pane_focus_update(pane_focused, cx);
231            cx.notify();
232        });
233    }
234
235    fn row_count(&self, cx: &WindowContext) -> usize {
236        self.read(cx).row_count(cx)
237    }
238}