1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
//! List component backed by `uniform_list` for efficient rendering of large lists.
//!
//! All items (including section headers) have the same height. Headers use
//! bottom-aligned text with top padding to visually separate sections.
//!
//! # Example
//!
//! ```ignore
//! use gpuikit::elements::list::{List, ListEntry};
//!
//! let entries = vec![
//! ListEntry::header("Section A"),
//! ListEntry::item("item-1", |_w, _cx| div().child("First item").into_any_element()),
//! ListEntry::item("item-2", |_w, _cx| div().child("Second item").into_any_element()),
//! ListEntry::header("Section B"),
//! ListEntry::item("item-3", |_w, _cx| div().child("Third item").into_any_element()),
//! ];
//!
//! // In your Render impl:
//! List::new("my-list", entries).render(window, cx)
//! ```
use crate::theme::{ActiveTheme, Themeable};
use gpui::{
div, prelude::FluentBuilder, px, uniform_list, AnyElement, App, ClickEvent, ElementId,
InteractiveElement, IntoElement, ParentElement, Pixels, SharedString,
StatefulInteractiveElement, Styled, UniformListScrollHandle, Window,
};
use std::rc::Rc;
/// Default row height in pixels
const DEFAULT_ITEM_HEIGHT: f32 = 27.0;
/// Default font size in pixels
const DEFAULT_FONT_SIZE: f32 = 13.0;
type ItemRender = Rc<dyn Fn(&mut Window, &mut App) -> AnyElement>;
type ClickHandler = Rc<dyn Fn(&ClickEvent, &mut Window, &mut App)>;
/// A single entry in the list — either a section header or a content item.
#[derive(Clone)]
pub enum ListEntry {
/// A section header label, rendered bottom-aligned with space above.
Header { label: SharedString },
/// A content item rendered by a callback, with an optional click handler.
Item {
id: ElementId,
render: ItemRender,
on_click: Option<ClickHandler>,
selected: bool,
},
}
impl ListEntry {
/// Create a section header entry.
pub fn header(label: impl Into<SharedString>) -> Self {
ListEntry::Header {
label: label.into(),
}
}
/// Create a content item entry.
pub fn item(
id: impl Into<ElementId>,
render: impl Fn(&mut Window, &mut App) -> AnyElement + 'static,
) -> Self {
ListEntry::Item {
id: id.into(),
render: Rc::new(render),
on_click: None,
selected: false,
}
}
/// Set a click handler on this entry.
pub fn on_click(
mut self,
handler: impl Fn(&ClickEvent, &mut Window, &mut App) + 'static,
) -> Self {
if let ListEntry::Item {
ref mut on_click, ..
} = self
{
*on_click = Some(Rc::new(handler));
}
self
}
/// Mark this entry as selected.
pub fn selected(mut self, is_selected: bool) -> Self {
if let ListEntry::Item {
ref mut selected, ..
} = self
{
*selected = is_selected;
}
self
}
}
/// A virtualized list component using `uniform_list`.
pub struct List {
id: ElementId,
entries: Vec<ListEntry>,
item_height: Pixels,
font_size: Pixels,
scroll_handle: Option<UniformListScrollHandle>,
}
impl List {
pub fn new(id: impl Into<ElementId>, entries: Vec<ListEntry>) -> Self {
Self {
id: id.into(),
entries,
item_height: px(DEFAULT_ITEM_HEIGHT),
font_size: px(DEFAULT_FONT_SIZE),
scroll_handle: None,
}
}
/// Set the row height (applies to both headers and items).
pub fn item_height(mut self, height: Pixels) -> Self {
self.item_height = height;
self
}
/// Set the font size for list content.
pub fn font_size(mut self, size: Pixels) -> Self {
self.font_size = size;
self
}
/// Attach a scroll handle for programmatic scrolling.
pub fn track_scroll(mut self, handle: &UniformListScrollHandle) -> Self {
self.scroll_handle = Some(handle.clone());
self
}
/// Render the list into an element.
pub fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement {
let item_height = self.item_height;
let font_size = self.font_size;
let entries = self.entries.clone();
let entry_count = entries.len();
let theme = cx.theme();
let fg_muted = theme.fg_muted();
let fg = theme.fg();
let accent = theme.accent();
let accent_bg = theme.accent_bg();
let list = uniform_list(self.id, entry_count, move |range, window, cx| {
range
.map(|ix| {
let entry = &entries[ix];
match entry {
ListEntry::Header { label } => div()
.h(item_height)
.w_full()
.flex()
.items_end()
.px_2()
.pb(px(2.))
.child(
div()
.text_size(font_size - px(1.))
.text_color(fg_muted)
.child(label.clone()),
)
.into_any_element(),
ListEntry::Item {
id,
render,
on_click,
selected,
} => {
let content = render(window, cx);
let row = div()
.id(id.clone())
.h(item_height)
.w_full()
.flex()
.items_center()
.text_size(font_size)
.rounded_sm()
.when(*selected, |el| el.bg(accent_bg).text_color(accent))
.when(!*selected, |el| {
el.text_color(fg).hover(|s| s.bg(accent_bg.opacity(0.5)))
})
.when_some(on_click.clone(), |el, handler| {
el.cursor_pointer().on_click(move |event, window, cx| {
handler(event, window, cx);
})
})
.child(content);
row.into_any_element()
}
}
})
.collect()
})
.size_full();
match self.scroll_handle {
Some(ref handle) => list.track_scroll(handle).into_any_element(),
None => list.into_any_element(),
}
}
}