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 let selected_border = cx.theme().colors().border.opacity(0.6);
130 let focused_border = cx.theme().colors().border_focused;
131 let transparent_border = cx.theme().colors().border_transparent;
132 let item_size = rems_from_px(28.);
133
134 let indentation_line = h_flex().size(item_size).flex_none().justify_center().child(
135 div()
136 .w_px()
137 .h_full()
138 .bg(cx.theme().colors().border.opacity(0.5)),
139 );
140
141 h_flex()
142 .id(self.id)
143 .when_some(self.group_name, |this, group| this.group(group))
144 .w_full()
145 .child(
146 h_flex()
147 .id("inner_tree_view_item")
148 .group("tree_view_item")
149 .cursor_pointer()
150 .size_full()
151 .relative()
152 .when_some(self.tab_index, |this, index| this.tab_index(index))
153 .map(|this| {
154 let label = self.label;
155 if self.root_item {
156 this.h(item_size)
157 .px_1()
158 .mb_1()
159 .gap_2p5()
160 .rounded_sm()
161 .border_1()
162 .focus(|s| s.border_color(focused_border))
163 .border_color(transparent_border)
164 .when(self.selected, |this| {
165 this.border_color(selected_border).bg(selected_bg)
166 })
167 .hover(|s| s.bg(cx.theme().colors().element_hover))
168 .child(
169 Disclosure::new("toggle", self.expanded)
170 .when_some(
171 self.on_toggle.clone(),
172 |disclosure, on_toggle| {
173 disclosure.on_toggle_expanded(on_toggle)
174 },
175 )
176 .opened_icon(IconName::ChevronDown)
177 .closed_icon(IconName::ChevronRight),
178 )
179 .child(
180 Label::new(label)
181 .when(!self.selected, |this| this.color(Color::Muted)),
182 )
183 } else {
184 this.child(indentation_line).child(
185 h_flex()
186 .id("nested_inner_tree_view_item")
187 .w_full()
188 .flex_grow()
189 .px_1()
190 .rounded_sm()
191 .border_1()
192 .focusable()
193 .in_focus(|s| s.border_color(focused_border))
194 .border_color(transparent_border)
195 .when(self.selected, |this| {
196 this.border_color(selected_border).bg(selected_bg)
197 })
198 .hover(|s| s.bg(cx.theme().colors().element_hover))
199 .child(
200 Label::new(label)
201 .when(!self.selected, |this| this.color(Color::Muted)),
202 ),
203 )
204 }
205 })
206 .when_some(self.on_hover, |this, on_hover| this.on_hover(on_hover))
207 .when_some(
208 self.on_click.filter(|_| !self.disabled),
209 |this, on_click| {
210 if self.root_item
211 && let Some(on_toggle) = self.on_toggle.clone()
212 {
213 this.on_click(move |event, window, cx| {
214 if !event.is_keyboard() {
215 on_click(event, window, cx);
216 }
217 on_toggle(event, window, cx);
218 })
219 } else {
220 this.on_click(on_click)
221 }
222 },
223 )
224 .when_some(self.on_secondary_mouse_down, |this, on_mouse_down| {
225 this.on_mouse_down(MouseButton::Right, move |event, window, cx| {
226 (on_mouse_down)(event, window, cx)
227 })
228 })
229 .when_some(self.tooltip, |this, tooltip| this.tooltip(tooltip)),
230 )
231 }
232}
233
234impl Component for TreeViewItem {
235 fn scope() -> ComponentScope {
236 ComponentScope::Navigation
237 }
238
239 fn description() -> Option<&'static str> {
240 Some(
241 "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.",
242 )
243 }
244
245 fn preview(_window: &mut Window, cx: &mut App) -> Option<AnyElement> {
246 let container = || {
247 v_flex()
248 .p_2()
249 .w_64()
250 .border_1()
251 .border_color(cx.theme().colors().border_variant)
252 .bg(cx.theme().colors().panel_background)
253 };
254
255 Some(
256 example_group(vec![
257 single_example(
258 "Basic Tree View",
259 container()
260 .child(
261 TreeViewItem::new("index-1", "Tree Item Root #1")
262 .root_item(true)
263 .toggle_state(true),
264 )
265 .child(TreeViewItem::new("index-2", "Tree Item #2"))
266 .child(TreeViewItem::new("index-3", "Tree Item #3"))
267 .child(TreeViewItem::new("index-4", "Tree Item Root #2").root_item(true))
268 .child(TreeViewItem::new("index-5", "Tree Item #5"))
269 .child(TreeViewItem::new("index-6", "Tree Item #6"))
270 .into_any_element(),
271 ),
272 single_example(
273 "Active Child",
274 container()
275 .child(TreeViewItem::new("index-1", "Tree Item Root #1").root_item(true))
276 .child(TreeViewItem::new("index-2", "Tree Item #2").toggle_state(true))
277 .child(TreeViewItem::new("index-3", "Tree Item #3"))
278 .into_any_element(),
279 ),
280 single_example(
281 "Focused Parent",
282 container()
283 .child(
284 TreeViewItem::new("index-1", "Tree Item Root #1")
285 .root_item(true)
286 .focused(true)
287 .toggle_state(true),
288 )
289 .child(TreeViewItem::new("index-2", "Tree Item #2"))
290 .child(TreeViewItem::new("index-3", "Tree Item #3"))
291 .into_any_element(),
292 ),
293 single_example(
294 "Focused Child",
295 container()
296 .child(
297 TreeViewItem::new("index-1", "Tree Item Root #1")
298 .root_item(true)
299 .toggle_state(true),
300 )
301 .child(TreeViewItem::new("index-2", "Tree Item #2").focused(true))
302 .child(TreeViewItem::new("index-3", "Tree Item #3"))
303 .into_any_element(),
304 ),
305 ])
306 .into_any_element(),
307 )
308 }
309}