1use std::sync::Arc;
2
3use gpui::{AnyElement, AnyView, ClickEvent, MouseButton, MouseDownEvent};
4
5use crate::{Disclosure, prelude::*};
6
7#[derive(IntoElement, RegisterComponent)]
8pub struct TreeViewItem {
9 id: ElementId,
10 group_name: Option<SharedString>,
11 label: SharedString,
12 expanded: bool,
13 selected: bool,
14 disabled: bool,
15 focused: bool,
16 default_expanded: bool,
17 root_item: bool,
18 tooltip: Option<Box<dyn Fn(&mut Window, &mut App) -> AnyView + 'static>>,
19 on_click: Option<Box<dyn Fn(&ClickEvent, &mut Window, &mut App) + 'static>>,
20 on_hover: Option<Box<dyn Fn(&bool, &mut Window, &mut App) + 'static>>,
21 on_toggle: Option<Arc<dyn Fn(&ClickEvent, &mut Window, &mut App) + 'static>>,
22 on_secondary_mouse_down: Option<Box<dyn Fn(&MouseDownEvent, &mut Window, &mut App) + 'static>>,
23 tab_index: Option<isize>,
24}
25
26impl TreeViewItem {
27 pub fn new(id: impl Into<ElementId>, label: impl Into<SharedString>) -> Self {
28 Self {
29 id: id.into(),
30 group_name: None,
31 label: label.into(),
32 expanded: false,
33 selected: false,
34 disabled: false,
35 focused: false,
36 default_expanded: false,
37 root_item: false,
38 tooltip: None,
39 on_click: None,
40 on_hover: None,
41 on_toggle: None,
42 on_secondary_mouse_down: None,
43 tab_index: None,
44 }
45 }
46
47 pub fn group_name(mut self, group_name: impl Into<SharedString>) -> Self {
48 self.group_name = Some(group_name.into());
49 self
50 }
51
52 pub fn on_click(
53 mut self,
54 handler: impl Fn(&ClickEvent, &mut Window, &mut App) + 'static,
55 ) -> Self {
56 self.on_click = Some(Box::new(handler));
57 self
58 }
59
60 pub fn on_hover(mut self, handler: impl Fn(&bool, &mut Window, &mut App) + 'static) -> Self {
61 self.on_hover = Some(Box::new(handler));
62 self
63 }
64
65 pub fn on_secondary_mouse_down(
66 mut self,
67 handler: impl Fn(&MouseDownEvent, &mut Window, &mut App) + 'static,
68 ) -> Self {
69 self.on_secondary_mouse_down = Some(Box::new(handler));
70 self
71 }
72
73 pub fn tooltip(mut self, tooltip: impl Fn(&mut Window, &mut App) -> AnyView + 'static) -> Self {
74 self.tooltip = Some(Box::new(tooltip));
75 self
76 }
77
78 pub fn tab_index(mut self, tab_index: isize) -> Self {
79 self.tab_index = Some(tab_index);
80 self
81 }
82
83 pub fn expanded(mut self, toggle: bool) -> Self {
84 self.expanded = toggle;
85 self
86 }
87
88 pub fn default_expanded(mut self, default_expanded: bool) -> Self {
89 self.default_expanded = default_expanded;
90 self
91 }
92
93 pub fn on_toggle(
94 mut self,
95 on_toggle: impl Fn(&ClickEvent, &mut Window, &mut App) + 'static,
96 ) -> Self {
97 self.on_toggle = Some(Arc::new(on_toggle));
98 self
99 }
100
101 pub fn root_item(mut self, root_item: bool) -> Self {
102 self.root_item = root_item;
103 self
104 }
105
106 pub fn focused(mut self, focused: bool) -> Self {
107 self.focused = focused;
108 self
109 }
110}
111
112impl Disableable for TreeViewItem {
113 fn disabled(mut self, disabled: bool) -> Self {
114 self.disabled = disabled;
115 self
116 }
117}
118
119impl Toggleable for TreeViewItem {
120 fn toggle_state(mut self, selected: bool) -> Self {
121 self.selected = selected;
122 self
123 }
124}
125
126impl RenderOnce for TreeViewItem {
127 fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement {
128 let selected_bg = cx.theme().colors().element_active.opacity(0.5);
129
130 let selected_border = cx.theme().colors().border.opacity(0.6);
131 let focused_border = cx.theme().colors().border_focused;
132 let transparent_border = cx.theme().colors().border_transparent;
133
134 let item_size = rems_from_px(28.);
135 let indentation_line = h_flex().size(item_size).flex_none().justify_center().child(
136 div()
137 .w_px()
138 .h_full()
139 .bg(cx.theme().colors().border.opacity(0.5)),
140 );
141
142 h_flex()
143 .id(self.id)
144 .when_some(self.group_name, |this, group| this.group(group))
145 .w_full()
146 .child(
147 h_flex()
148 .id("inner_tree_view_item")
149 .group("tree_view_item")
150 .cursor_pointer()
151 .size_full()
152 .relative()
153 .map(|this| {
154 let label = self.label;
155
156 if self.root_item {
157 this.h(item_size)
158 .px_1()
159 .gap_2p5()
160 .rounded_sm()
161 .border_1()
162 .border_color(transparent_border)
163 .when(self.selected, |this| {
164 this.border_color(selected_border).bg(selected_bg)
165 })
166 .focus(|s| s.border_color(focused_border))
167 .hover(|s| s.bg(cx.theme().colors().element_hover))
168 .when_some(self.tab_index, |this, index| this.tab_index(index))
169 .child(
170 Disclosure::new("toggle", self.expanded)
171 .when_some(
172 self.on_toggle.clone(),
173 |disclosure, on_toggle| {
174 disclosure.on_toggle_expanded(on_toggle)
175 },
176 )
177 .opened_icon(IconName::ChevronDown)
178 .closed_icon(IconName::ChevronRight),
179 )
180 .child(
181 Label::new(label)
182 .when(!self.selected, |this| this.color(Color::Muted)),
183 )
184 } else {
185 this.child(indentation_line).child(
186 h_flex()
187 .id("nested_inner_tree_view_item")
188 .w_full()
189 .flex_grow()
190 .px_1()
191 .rounded_sm()
192 .border_1()
193 .border_color(transparent_border)
194 .when(self.selected, |this| {
195 this.border_color(selected_border).bg(selected_bg)
196 })
197 .focus(|s| s.border_color(focused_border))
198 .hover(|s| s.bg(cx.theme().colors().element_hover))
199 .when_some(self.tab_index, |this, index| this.tab_index(index))
200 .child(
201 Label::new(label)
202 .when(!self.selected, |this| this.color(Color::Muted)),
203 ),
204 )
205 }
206 })
207 .when_some(self.on_hover, |this, on_hover| this.on_hover(on_hover))
208 .when_some(
209 self.on_click.filter(|_| !self.disabled),
210 |this, on_click| {
211 if self.root_item
212 && let Some(on_toggle) = self.on_toggle.clone()
213 {
214 this.on_click(move |event, window, cx| {
215 if event.is_keyboard() {
216 on_click(event, window, cx);
217 on_toggle(event, window, cx);
218 } else {
219 on_click(event, window, cx);
220 }
221 })
222 } else {
223 this.on_click(on_click)
224 }
225 },
226 )
227 .when_some(self.on_secondary_mouse_down, |this, on_mouse_down| {
228 this.on_mouse_down(MouseButton::Right, move |event, window, cx| {
229 (on_mouse_down)(event, window, cx)
230 })
231 })
232 .when_some(self.tooltip, |this, tooltip| this.tooltip(tooltip)),
233 )
234 }
235}
236
237impl Component for TreeViewItem {
238 fn scope() -> ComponentScope {
239 ComponentScope::Navigation
240 }
241
242 fn description() -> Option<&'static str> {
243 Some(
244 "A hierarchical list of items that may have a parent-child relationship where children can be toggled into view by expanding or collapsing their parent item.",
245 )
246 }
247
248 fn preview(_window: &mut Window, cx: &mut App) -> Option<AnyElement> {
249 let container = || {
250 v_flex()
251 .p_2()
252 .w_64()
253 .border_1()
254 .border_color(cx.theme().colors().border_variant)
255 .bg(cx.theme().colors().panel_background)
256 };
257
258 Some(
259 example_group(vec![
260 single_example(
261 "Basic Tree View",
262 container()
263 .child(
264 TreeViewItem::new("index-1", "Tree Item Root #1")
265 .root_item(true)
266 .toggle_state(true),
267 )
268 .child(TreeViewItem::new("index-2", "Tree Item #2"))
269 .child(TreeViewItem::new("index-3", "Tree Item #3"))
270 .child(TreeViewItem::new("index-4", "Tree Item Root #2").root_item(true))
271 .child(TreeViewItem::new("index-5", "Tree Item #5"))
272 .child(TreeViewItem::new("index-6", "Tree Item #6"))
273 .into_any_element(),
274 ),
275 single_example(
276 "Active Child",
277 container()
278 .child(TreeViewItem::new("index-1", "Tree Item Root #1").root_item(true))
279 .child(TreeViewItem::new("index-2", "Tree Item #2").toggle_state(true))
280 .child(TreeViewItem::new("index-3", "Tree Item #3"))
281 .into_any_element(),
282 ),
283 single_example(
284 "Focused Parent",
285 container()
286 .child(
287 TreeViewItem::new("index-1", "Tree Item Root #1")
288 .root_item(true)
289 .focused(true)
290 .toggle_state(true),
291 )
292 .child(TreeViewItem::new("index-2", "Tree Item #2"))
293 .child(TreeViewItem::new("index-3", "Tree Item #3"))
294 .into_any_element(),
295 ),
296 single_example(
297 "Focused Child",
298 container()
299 .child(
300 TreeViewItem::new("index-1", "Tree Item Root #1")
301 .root_item(true)
302 .toggle_state(true),
303 )
304 .child(TreeViewItem::new("index-2", "Tree Item #2").focused(true))
305 .child(TreeViewItem::new("index-3", "Tree Item #3"))
306 .into_any_element(),
307 ),
308 ])
309 .into_any_element(),
310 )
311 }
312}