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