use crate::{ input::{InputEvent, TextInput}, scroll::{Scrollbar, ScrollbarState}, theme::{scale::ColorScaleStep, ActiveTheme}, v_flex, Icon, IconName, Size, }; use gpui::{ actions, div, prelude::FluentBuilder, px, uniform_list, AnyElement, App, AppContext, Context, Entity, FocusHandle, Focusable, InteractiveElement, IntoElement, KeyBinding, Length, ListSizingBehavior, MouseButton, ParentElement, Render, ScrollStrategy, SharedString, Styled, Subscription, Task, UniformListScrollHandle, Window, }; use smol::Timer; use std::{cell::Cell, rc::Rc, time::Duration}; actions!(list, [Cancel, Confirm, SelectPrev, SelectNext]); pub fn init(cx: &mut App) { let context: Option<&str> = Some("List"); cx.bind_keys([ KeyBinding::new("escape", Cancel, context), KeyBinding::new("enter", Confirm, context), KeyBinding::new("up", SelectPrev, context), KeyBinding::new("down", SelectNext, context), ]); } /// A delegate for the List. #[allow(unused)] pub trait ListDelegate: Sized + 'static { type Item: IntoElement; /// When Query Input change, this method will be called. /// You can perform search here. fn perform_search( &mut self, query: &str, window: &mut Window, cx: &mut Context>, ) -> Task<()> { Task::ready(()) } /// Return the number of items in the list. fn items_count(&self, cx: &App) -> usize; /// Render the item at the given index. /// /// Return None will skip the item. fn render_item( &self, ix: usize, window: &mut Window, cx: &mut Context>, ) -> Option; /// Return a Element to show when list is empty. fn render_empty(&self, window: &mut Window, cx: &mut Context>) -> impl IntoElement { div() } /// Returns Some(AnyElement) to render the initial state of the list. /// /// This can be used to show a view for the list before the user has interacted with it. /// /// For example: The last search results, or the last selected item. /// /// Default is None, that means no initial state. fn render_initial( &self, window: &mut Window, cx: &mut Context>, ) -> Option { None } /// Return the confirmed index of the selected item. fn confirmed_index(&self, cx: &App) -> Option { None } /// Set the selected index, just store the ix, don't confirm. fn set_selected_index( &mut self, ix: Option, window: &mut Window, cx: &mut Context>, ); /// Set the confirm and give the selected index, this is means user have clicked the item or pressed Enter. fn confirm(&mut self, ix: Option, window: &mut Window, cx: &mut Context>) {} /// Cancel the selection, e.g.: Pressed ESC. fn cancel(&mut self, window: &mut Window, cx: &mut Context>) {} } pub struct List { focus_handle: FocusHandle, delegate: D, max_height: Option, query_input: Option>, last_query: Option, loading: bool, enable_scrollbar: bool, vertical_scroll_handle: UniformListScrollHandle, scrollbar_state: Rc>, pub(crate) size: Size, selected_index: Option, right_clicked_index: Option, _search_task: Task<()>, query_input_subscription: Subscription, } impl List where D: ListDelegate, { pub fn new(delegate: D, window: &mut Window, cx: &mut Context) -> Self { let query_input = cx.new(|cx| { TextInput::new(window, cx) .appearance(false) .prefix(|_window, cx| { Icon::new(IconName::Search) .text_color(cx.theme().base.step(cx, ColorScaleStep::ELEVEN)) }) .placeholder("Search...") .cleanable() }); let query_input_subscription = cx.subscribe_in(&query_input, window, Self::on_query_input_event); Self { focus_handle: cx.focus_handle(), delegate, query_input: Some(query_input), last_query: None, selected_index: None, right_clicked_index: None, vertical_scroll_handle: UniformListScrollHandle::new(), scrollbar_state: Rc::new(Cell::new(ScrollbarState::new())), max_height: None, enable_scrollbar: true, loading: false, size: Size::default(), _search_task: Task::ready(()), query_input_subscription, } } /// Set the size pub fn set_size(&mut self, size: Size, window: &mut Window, cx: &mut Context) { if let Some(input) = &self.query_input { input.update(cx, |input, cx| { input.set_size(size, window, cx); }) } self.size = size; } pub fn max_h(mut self, height: impl Into) -> Self { self.max_height = Some(height.into()); self } pub fn no_scrollbar(mut self) -> Self { self.enable_scrollbar = false; self } pub fn no_query(mut self) -> Self { self.query_input = None; self } pub fn set_query_input( &mut self, query_input: Entity, window: &mut Window, cx: &mut Context, ) { self.query_input_subscription = cx.subscribe_in(&query_input, window, Self::on_query_input_event); self.query_input = Some(query_input); } pub fn delegate(&self) -> &D { &self.delegate } pub fn delegate_mut(&mut self) -> &mut D { &mut self.delegate } pub fn focus(&mut self, window: &mut Window, cx: &mut App) { self.focus_handle(cx).focus(window); } pub fn set_selected_index( &mut self, ix: Option, window: &mut Window, cx: &mut Context, ) { self.selected_index = ix; self.delegate.set_selected_index(ix, window, cx); } pub fn selected_index(&self) -> Option { self.selected_index } /// Set the query_input text pub fn set_query(&mut self, query: &str, window: &mut Window, cx: &mut Context) { if let Some(query_input) = &self.query_input { let query = query.to_owned(); query_input.update(cx, |input, cx| input.set_text(query, window, cx)) } } /// Get the query_input text pub fn query(&self, _window: &mut Window, cx: &mut Context) -> Option { self.query_input.as_ref().map(|input| input.read(cx).text()) } fn render_scrollbar( &self, _window: &mut Window, cx: &mut Context, ) -> Option { if !self.enable_scrollbar { return None; } Some(Scrollbar::uniform_scroll( cx.entity().entity_id(), self.scrollbar_state.clone(), self.vertical_scroll_handle.clone(), )) } fn scroll_to_selected_item(&mut self, _window: &mut Window, _cx: &mut Context) { if let Some(ix) = self.selected_index { self.vertical_scroll_handle .scroll_to_item(ix, ScrollStrategy::Top); } } fn on_query_input_event( &mut self, _: &Entity, event: &InputEvent, window: &mut Window, cx: &mut Context, ) { match event { InputEvent::Change(text) => { let text = text.trim().to_string(); if Some(&text) == self.last_query.as_ref() { return; } self.set_loading(true, window, cx); let search = self.delegate.perform_search(&text, window, cx); self._search_task = cx.spawn_in(window, async move |this, window| { search.await; _ = this.update_in(window, |this, _, _| { this.vertical_scroll_handle .scroll_to_item(0, ScrollStrategy::Top); this.last_query = Some(text); }); // Always wait 100ms to avoid flicker Timer::after(Duration::from_millis(100)).await; _ = this.update_in(window, |this, window, cx| { this.set_loading(false, window, cx); }); }); } InputEvent::PressEnter => self.on_action_confirm(&Confirm, window, cx), _ => {} } } fn set_loading(&mut self, loading: bool, window: &mut Window, cx: &mut Context) { self.loading = loading; if let Some(input) = &self.query_input { input.update(cx, |input, cx| input.set_loading(loading, window, cx)) } cx.notify(); } fn on_action_cancel(&mut self, _: &Cancel, window: &mut Window, cx: &mut Context) { self.set_selected_index(None, window, cx); self.delegate.cancel(window, cx); cx.notify(); } fn on_action_confirm(&mut self, _: &Confirm, window: &mut Window, cx: &mut Context) { if self.delegate.items_count(cx) == 0 { return; } self.delegate.confirm(self.selected_index, window, cx); cx.notify(); } fn on_action_select_prev( &mut self, _: &SelectPrev, window: &mut Window, cx: &mut Context, ) { if self.delegate.items_count(cx) == 0 { return; } let selected_index = self.selected_index.unwrap_or(0); if selected_index > 0 { self.selected_index = Some(selected_index - 1); } else { self.selected_index = Some(self.delegate.items_count(cx) - 1); } self.delegate .set_selected_index(self.selected_index, window, cx); self.scroll_to_selected_item(window, cx); cx.notify(); } fn on_action_select_next( &mut self, _: &SelectNext, window: &mut Window, cx: &mut Context, ) { if self.delegate.items_count(cx) == 0 { return; } if let Some(selected_index) = self.selected_index { if selected_index < self.delegate.items_count(cx) - 1 { self.selected_index = Some(selected_index + 1); } else { self.selected_index = Some(0); } } else { self.selected_index = Some(0); } self.delegate .set_selected_index(self.selected_index, window, cx); self.scroll_to_selected_item(window, cx); cx.notify(); } fn render_list_item( &mut self, ix: usize, window: &mut Window, cx: &mut Context, ) -> impl IntoElement { div() .id("list-item") .w_full() .relative() .children(self.delegate.render_item(ix, window, cx)) .when_some(self.selected_index, |this, selected_index| { this.when(ix == selected_index, |this| { this.child( div() .absolute() .top(px(0.)) .left(px(0.)) .right(px(0.)) .bottom(px(0.)) .bg(cx.theme().accent.step(cx, ColorScaleStep::SIX)) .border_1() .border_color(cx.theme().accent.step(cx, ColorScaleStep::NINE)), ) }) }) .when(self.right_clicked_index == Some(ix), |this| { this.child( div() .absolute() .top(px(0.)) .left(px(0.)) .right(px(0.)) .bottom(px(0.)) .border_1() .border_color(cx.theme().accent.step(cx, ColorScaleStep::NINE)), ) }) .on_mouse_down( MouseButton::Left, cx.listener(move |this, _, window, cx| { this.right_clicked_index = None; this.selected_index = Some(ix); this.on_action_confirm(&Confirm, window, cx); }), ) .on_mouse_down( MouseButton::Right, cx.listener(move |this, _, _window, cx| { this.right_clicked_index = Some(ix); cx.notify(); }), ) } } impl Focusable for List where D: ListDelegate, { fn focus_handle(&self, cx: &App) -> FocusHandle { if let Some(query_input) = &self.query_input { query_input.focus_handle(cx) } else { self.focus_handle.clone() } } } impl Render for List where D: ListDelegate, { fn render(&mut self, window: &mut Window, cx: &mut Context) -> impl IntoElement { let view = cx.entity().clone(); let vertical_scroll_handle = self.vertical_scroll_handle.clone(); let items_count = self.delegate.items_count(cx); let sizing_behavior = if self.max_height.is_some() { ListSizingBehavior::Infer } else { ListSizingBehavior::Auto }; let initial_view = if let Some(input) = &self.query_input { if input.read(cx).text().is_empty() { self.delegate().render_initial(window, cx) } else { None } } else { None }; v_flex() .key_context("List") .id("list") .track_focus(&self.focus_handle) .size_full() .relative() .overflow_hidden() .on_action(cx.listener(Self::on_action_cancel)) .on_action(cx.listener(Self::on_action_confirm)) .on_action(cx.listener(Self::on_action_select_next)) .on_action(cx.listener(Self::on_action_select_prev)) .when_some(self.query_input.clone(), |this, input| { this.child( div() .map(|this| match self.size { Size::Small => this.py_0().px_1p5(), _ => this.py_1().px_2(), }) .border_b_1() .border_color(cx.theme().base.step(cx, ColorScaleStep::THREE)) .child(input), ) }) .map(|this| { if let Some(view) = initial_view { this.child(view) } else { this.child( v_flex() .flex_grow() .relative() .when_some(self.max_height, |this, h| this.max_h(h)) .overflow_hidden() .when(items_count == 0, |this| { this.child(self.delegate().render_empty(window, cx)) }) .when(items_count > 0, |this| { this.child( uniform_list(view, "uniform-list", items_count, { move |list, visible_range, window, cx| { visible_range .map(|ix| list.render_list_item(ix, window, cx)) .collect::>() } }) .flex_grow() .with_sizing_behavior(sizing_behavior) .track_scroll(vertical_scroll_handle) .into_any_element(), ) }) .children(self.render_scrollbar(window, cx)), ) } }) // Click out to cancel right clicked row .when(self.right_clicked_index.is_some(), |this| { this.on_mouse_down_out(cx.listener(|this, _, _window, cx| { this.right_clicked_index = None; cx.notify(); })) }) } }