Rework ListItem to use children (#3387)

This PR reworks the `ListItem` component to accept `children` rather
than just a `Label`.

This is a step towards making the `ListItem` component more open.

As part of this the `ContextMenu` was simplified to only construct the
various list components in `render` rather than holding them as part of
its state.

Release Notes:

- N/A
This commit is contained in:
Marshall Bowers 2023-11-22 12:55:20 -05:00 committed by GitHub
commit cac6e22e8e
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
6 changed files with 41 additions and 63 deletions

View file

@ -371,7 +371,7 @@ impl ProjectPanel {
_entry_id: ProjectEntryId, _entry_id: ProjectEntryId,
_cx: &mut ViewContext<Self>, _cx: &mut ViewContext<Self>,
) { ) {
todo!() // todo!()
// let project = self.project.read(cx); // let project = self.project.read(cx);
// let worktree_id = if let Some(id) = project.worktree_id_for_entry(entry_id, cx) { // let worktree_id = if let Some(id) = project.worktree_id_for_entry(entry_id, cx) {

View file

@ -31,7 +31,7 @@ use workspace::{
notifications::NotifyResultExt, notifications::NotifyResultExt,
register_deserializable_item, register_deserializable_item,
searchable::{SearchEvent, SearchOptions, SearchableItem}, searchable::{SearchEvent, SearchOptions, SearchableItem},
ui::{ContextMenu, Icon, IconElement, Label, ListItem}, ui::{ContextMenu, Icon, IconElement, Label},
CloseActiveItem, NewCenterTerminal, Pane, ToolbarItemLocation, Workspace, WorkspaceId, CloseActiveItem, NewCenterTerminal, Pane, ToolbarItemLocation, Workspace, WorkspaceId,
}; };
@ -299,11 +299,8 @@ impl TerminalView {
cx: &mut ViewContext<Self>, cx: &mut ViewContext<Self>,
) { ) {
self.context_menu = Some(ContextMenu::build(cx, |menu, _| { self.context_menu = Some(ContextMenu::build(cx, |menu, _| {
menu.action(ListItem::new("clear", Label::new("Clear")), Box::new(Clear)) menu.action("Clear", Box::new(Clear))
.action( .action("Close", Box::new(CloseActiveItem { save_intent: None }))
ListItem::new("close", Label::new("Close")),
Box::new(CloseActiveItem { save_intent: None }),
)
})); }));
dbg!(&position); dbg!(&position);
// todo!() // todo!()

View file

@ -1,7 +1,7 @@
use std::cell::RefCell; use std::cell::RefCell;
use std::rc::Rc; use std::rc::Rc;
use crate::{prelude::*, v_stack, List}; use crate::{prelude::*, v_stack, Label, List};
use crate::{ListItem, ListSeparator, ListSubHeader}; use crate::{ListItem, ListSeparator, ListSubHeader};
use gpui::{ use gpui::{
overlay, px, Action, AnchorCorner, AnyElement, AppContext, Bounds, ClickEvent, DispatchPhase, overlay, px, Action, AnchorCorner, AnyElement, AppContext, Bounds, ClickEvent, DispatchPhase,
@ -10,9 +10,9 @@ use gpui::{
}; };
pub enum ContextMenuItem { pub enum ContextMenuItem {
Separator(ListSeparator), Separator,
Header(ListSubHeader), Header(SharedString),
Entry(ListItem, Rc<dyn Fn(&ClickEvent, &mut WindowContext)>), Entry(SharedString, Rc<dyn Fn(&ClickEvent, &mut WindowContext)>),
} }
pub struct ContextMenu { pub struct ContextMenu {
@ -46,29 +46,30 @@ impl ContextMenu {
} }
pub fn header(mut self, title: impl Into<SharedString>) -> Self { pub fn header(mut self, title: impl Into<SharedString>) -> Self {
self.items self.items.push(ContextMenuItem::Header(title.into()));
.push(ContextMenuItem::Header(ListSubHeader::new(title)));
self self
} }
pub fn separator(mut self) -> Self { pub fn separator(mut self) -> Self {
self.items.push(ContextMenuItem::Separator(ListSeparator)); self.items.push(ContextMenuItem::Separator);
self self
} }
pub fn entry( pub fn entry(
mut self, mut self,
view: ListItem, label: impl Into<SharedString>,
on_click: impl Fn(&ClickEvent, &mut WindowContext) + 'static, on_click: impl Fn(&ClickEvent, &mut WindowContext) + 'static,
) -> Self { ) -> Self {
self.items self.items
.push(ContextMenuItem::Entry(view, Rc::new(on_click))); .push(ContextMenuItem::Entry(label.into(), Rc::new(on_click)));
self self
} }
pub fn action(self, view: ListItem, action: Box<dyn Action>) -> Self { pub fn action(self, label: impl Into<SharedString>, action: Box<dyn Action>) -> Self {
// todo: add the keybindings to the list entry // todo: add the keybindings to the list entry
self.entry(view, move |_, cx| cx.dispatch_action(action.boxed_clone())) self.entry(label.into(), move |_, cx| {
cx.dispatch_action(action.boxed_clone())
})
} }
pub fn confirm(&mut self, _: &menu::Confirm, cx: &mut ViewContext<Self>) { pub fn confirm(&mut self, _: &menu::Confirm, cx: &mut ViewContext<Self>) {
@ -104,16 +105,16 @@ impl Render for ContextMenu {
// .border_color(cx.theme().colors().border) // .border_color(cx.theme().colors().border)
.child( .child(
List::new().children(self.items.iter().map(|item| match item { List::new().children(self.items.iter().map(|item| match item {
ContextMenuItem::Separator(separator) => { ContextMenuItem::Separator => ListSeparator::new().render_into_any(),
separator.clone().render_into_any() ContextMenuItem::Header(header) => {
ListSubHeader::new(header.clone()).render_into_any()
} }
ContextMenuItem::Header(header) => header.clone().render_into_any(),
ContextMenuItem::Entry(entry, callback) => { ContextMenuItem::Entry(entry, callback) => {
let callback = callback.clone(); let callback = callback.clone();
let dismiss = cx.listener(|_, _, cx| cx.emit(Manager::Dismiss)); let dismiss = cx.listener(|_, _, cx| cx.emit(Manager::Dismiss));
entry ListItem::new(entry.clone())
.clone() .child(Label::new(entry.clone()))
.on_click(move |event, cx| { .on_click(move |event, cx| {
callback(event, cx); callback(event, cx);
dismiss(event, cx) dismiss(event, cx)

View file

@ -245,45 +245,28 @@ pub struct ListItem {
// TODO: Reintroduce this // TODO: Reintroduce this
// disclosure_control_style: DisclosureControlVisibility, // disclosure_control_style: DisclosureControlVisibility,
indent_level: u32, indent_level: u32,
label: Label,
left_slot: Option<GraphicSlot>, left_slot: Option<GraphicSlot>,
overflow: OverflowStyle, overflow: OverflowStyle,
size: ListEntrySize, size: ListEntrySize,
toggle: Toggle, toggle: Toggle,
variant: ListItemVariant, variant: ListItemVariant,
on_click: Option<Rc<dyn Fn(&ClickEvent, &mut WindowContext) + 'static>>, on_click: Option<Rc<dyn Fn(&ClickEvent, &mut WindowContext) + 'static>>,
} children: SmallVec<[AnyElement; 2]>,
impl Clone for ListItem {
fn clone(&self) -> Self {
Self {
id: self.id.clone(),
disabled: self.disabled,
indent_level: self.indent_level,
label: self.label.clone(),
left_slot: self.left_slot.clone(),
overflow: self.overflow,
size: self.size,
toggle: self.toggle,
variant: self.variant,
on_click: self.on_click.clone(),
}
}
} }
impl ListItem { impl ListItem {
pub fn new(id: impl Into<ElementId>, label: Label) -> Self { pub fn new(id: impl Into<ElementId>) -> Self {
Self { Self {
id: id.into(), id: id.into(),
disabled: false, disabled: false,
indent_level: 0, indent_level: 0,
label,
left_slot: None, left_slot: None,
overflow: OverflowStyle::Hidden, overflow: OverflowStyle::Hidden,
size: ListEntrySize::default(), size: ListEntrySize::default(),
toggle: Toggle::NotToggleable, toggle: Toggle::NotToggleable,
variant: ListItemVariant::default(), variant: ListItemVariant::default(),
on_click: Default::default(), on_click: Default::default(),
children: SmallVec::new(),
} }
} }
@ -394,11 +377,17 @@ impl Component for ListItem {
.relative() .relative()
.child(disclosure_control(self.toggle)) .child(disclosure_control(self.toggle))
.children(left_content) .children(left_content)
.child(self.label), .children(self.children),
) )
} }
} }
impl ParentElement for ListItem {
fn children_mut(&mut self) -> &mut SmallVec<[AnyElement; 2]> {
&mut self.children
}
}
#[derive(RenderOnce, Clone)] #[derive(RenderOnce, Clone)]
pub struct ListSeparator; pub struct ListSeparator;

View file

@ -2,7 +2,7 @@ use gpui::{actions, Action, AnchorCorner, Div, Render, View};
use story::Story; use story::Story;
use crate::prelude::*; use crate::prelude::*;
use crate::{menu_handle, ContextMenu, Label, ListItem}; use crate::{menu_handle, ContextMenu, Label};
actions!(PrintCurrentDate, PrintBestFood); actions!(PrintCurrentDate, PrintBestFood);
@ -10,17 +10,13 @@ fn build_menu(cx: &mut WindowContext, header: impl Into<SharedString>) -> View<C
ContextMenu::build(cx, |menu, _| { ContextMenu::build(cx, |menu, _| {
menu.header(header) menu.header(header)
.separator() .separator()
.entry( .entry("Print current time", |v, cx| {
ListItem::new("Print current time", Label::new("Print current time")), println!("dispatching PrintCurrentTime action");
|v, cx| { cx.dispatch_action(PrintCurrentDate.boxed_clone())
println!("dispatching PrintCurrentTime action"); })
cx.dispatch_action(PrintCurrentDate.boxed_clone()) .entry("Print best foot", |v, cx| {
}, cx.dispatch_action(PrintBestFood.boxed_clone())
) })
.entry(
ListItem::new("Print best food", Label::new("Print best food")),
|v, cx| cx.dispatch_action(PrintBestFood.boxed_clone()),
)
}) })
} }

View file

@ -8,9 +8,7 @@ use schemars::JsonSchema;
use serde::{Deserialize, Serialize}; use serde::{Deserialize, Serialize};
use std::sync::Arc; use std::sync::Arc;
use theme2::ActiveTheme; use theme2::ActiveTheme;
use ui::{ use ui::{h_stack, menu_handle, ContextMenu, IconButton, InteractionState, Tooltip};
h_stack, menu_handle, ContextMenu, IconButton, InteractionState, Label, ListItem, Tooltip,
};
pub enum PanelEvent { pub enum PanelEvent {
ChangePosition, ChangePosition,
@ -720,10 +718,7 @@ impl Render for PanelButtons {
{ {
let panel = panel.clone(); let panel = panel.clone();
menu = menu.entry( menu = menu.entry(
ListItem::new( format!("Dock {}", position.to_label()),
panel.entity_id(),
Label::new(format!("Dock {}", position.to_label())),
),
move |_, cx| { move |_, cx| {
panel.set_position(position, cx); panel.set_position(position, cx);
}, },