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