Martin Pool
b9cf5886e4
Follows on from https://github.com/zed-industries/zed/pull/37716#pullrequestreview-3195695110 by @SomeoneToIgnore After this the doctests will be run in CI to check that the examples are still accurate. Note that doctests aren't run by Nextest: you can run them locally with `cargo test --doc`. Summary: * Run tests from CI * Loosen an exact float comparison to match approximately (otherwise it fails) * Fixed one actual bug in the tests for `dilate` where the test code assumed that `dilate` mutates `self` rather than returning a new object * Add some `must_use` on some functions that seemed at risk of similar bugs, following the Rust stdlib style to add it where ignoring the result is almost certainly a bug. * Fix some cases where the doc examples seem to have gone out of date with the code * Add imports to doctests that need them * Add some dev-dependencies to make the tests build * Fix the `key_dispatch` module docstring, which was accidentally attached to objects within that module * Skip some doctest examples that seem like they need an async environment or that just looked hard to get running AI usage: I asked Claude to do some of the repetitive tests. I checked the output and fixed up some things that seemed to not be in the right spirit of the test, or too longwinded. I think we could reasonably run the tests on only Linux to save CI CPU-seconds and latency, but I haven't done that yet, partly because of how it's implemented in the action. Release Notes: - N/A
136 lines
4.1 KiB
Rust
136 lines
4.1 KiB
Rust
use crate::component_prelude::*;
|
|
use crate::prelude::*;
|
|
use gpui::{AnyElement, StyleRefinement};
|
|
use smallvec::SmallVec;
|
|
|
|
use super::Avatar;
|
|
|
|
/// An element that displays a collection of (usually) faces stacked
|
|
/// horizontally, with the left-most face on top, visually descending
|
|
/// from left to right.
|
|
///
|
|
/// Facepiles are used to display a group of people or things,
|
|
/// such as a list of participants in a collaboration session.
|
|
///
|
|
/// # Examples
|
|
///
|
|
/// ## Default
|
|
///
|
|
/// A default, horizontal facepile.
|
|
///
|
|
/// ```
|
|
/// use gpui::IntoElement;
|
|
/// use ui::{Avatar, Facepile, EXAMPLE_FACES};
|
|
///
|
|
/// let facepile = Facepile::new(
|
|
/// EXAMPLE_FACES.iter().take(3).map(|&url|
|
|
/// Avatar::new(url).into_any_element()).collect()
|
|
/// );
|
|
/// ```
|
|
#[derive(IntoElement, Documented, RegisterComponent)]
|
|
pub struct Facepile {
|
|
base: Div,
|
|
faces: SmallVec<[AnyElement; 2]>,
|
|
}
|
|
|
|
impl Facepile {
|
|
/// Creates a new empty facepile.
|
|
pub fn empty() -> Self {
|
|
Self::new(SmallVec::new())
|
|
}
|
|
|
|
/// Creates a new facepile with the given faces.
|
|
pub fn new(faces: SmallVec<[AnyElement; 2]>) -> Self {
|
|
Self { base: div(), faces }
|
|
}
|
|
}
|
|
|
|
impl ParentElement for Facepile {
|
|
fn extend(&mut self, elements: impl IntoIterator<Item = AnyElement>) {
|
|
self.faces.extend(elements);
|
|
}
|
|
}
|
|
|
|
// Style methods.
|
|
impl Facepile {
|
|
fn style(&mut self) -> &mut StyleRefinement {
|
|
self.base.style()
|
|
}
|
|
|
|
gpui::padding_style_methods!({
|
|
visibility: pub
|
|
});
|
|
}
|
|
|
|
impl RenderOnce for Facepile {
|
|
fn render(self, _window: &mut Window, _cx: &mut App) -> impl IntoElement {
|
|
// Lay the faces out in reverse so they overlap in the desired order (left to right, front to back)
|
|
self.base
|
|
.flex()
|
|
.flex_row_reverse()
|
|
.items_center()
|
|
.justify_start()
|
|
.children(
|
|
self.faces
|
|
.into_iter()
|
|
.enumerate()
|
|
.rev()
|
|
.map(|(ix, player)| div().when(ix > 0, |div| div.ml_neg_1()).child(player)),
|
|
)
|
|
}
|
|
}
|
|
|
|
pub const EXAMPLE_FACES: [&str; 6] = [
|
|
"https://avatars.githubusercontent.com/u/326587?s=60&v=4",
|
|
"https://avatars.githubusercontent.com/u/2280405?s=60&v=4",
|
|
"https://avatars.githubusercontent.com/u/1789?s=60&v=4",
|
|
"https://avatars.githubusercontent.com/u/67129314?s=60&v=4",
|
|
"https://avatars.githubusercontent.com/u/482957?s=60&v=4",
|
|
"https://avatars.githubusercontent.com/u/1714999?s=60&v=4",
|
|
];
|
|
|
|
impl Component for Facepile {
|
|
fn scope() -> ComponentScope {
|
|
ComponentScope::Collaboration
|
|
}
|
|
|
|
fn description() -> Option<&'static str> {
|
|
Some(
|
|
"Displays a collection of avatars or initials in a compact format. Often used to represent active collaborators or a subset of contributors.",
|
|
)
|
|
}
|
|
|
|
fn preview(_window: &mut Window, _cx: &mut App) -> Option<AnyElement> {
|
|
Some(
|
|
v_flex()
|
|
.gap_6()
|
|
.children(vec![example_group_with_title(
|
|
"Facepile Examples",
|
|
vec![
|
|
single_example(
|
|
"Default",
|
|
Facepile::new(
|
|
EXAMPLE_FACES
|
|
.iter()
|
|
.map(|&url| Avatar::new(url).into_any_element())
|
|
.collect(),
|
|
)
|
|
.into_any_element(),
|
|
),
|
|
single_example(
|
|
"Custom Size",
|
|
Facepile::new(
|
|
EXAMPLE_FACES
|
|
.iter()
|
|
.map(|&url| Avatar::new(url).size(px(24.)).into_any_element())
|
|
.collect(),
|
|
)
|
|
.into_any_element(),
|
|
),
|
|
],
|
|
)])
|
|
.into_any_element(),
|
|
)
|
|
}
|
|
}
|