oak-gpui/crates/ui/src/components/indicator.rs

#![allow(missing_docs)]
use crate::{prelude::*, AnyIcon};

#[derive(Default)]
enum IndicatorKind {
    #[default]
    Dot,
    Bar,
    Icon(AnyIcon),
}

#[derive(IntoElement)]
pub struct Indicator {
    kind: IndicatorKind,
    border_color: Option<Color>,
    pub color: Color,
}

impl Indicator {
    pub fn dot() -> Self {
        Self {
            kind: IndicatorKind::Dot,
            border_color: None,
            color: Color::Default,
        }
    }

    pub fn bar() -> Self {
        Self {
            kind: IndicatorKind::Bar,
            border_color: None,

            color: Color::Default,
        }
    }

    pub fn icon(icon: impl Into<AnyIcon>) -> Self {
        Self {
            kind: IndicatorKind::Icon(icon.into()),
            border_color: None,

            color: Color::Default,
        }
    }

    pub fn color(mut self, color: Color) -> Self {
        self.color = color;
        self
    }

    pub fn border_color(mut self, color: Color) -> Self {
        self.border_color = Some(color);
        self
    }
}

impl RenderOnce for Indicator {
    fn render(self, cx: &mut WindowContext) -> impl IntoElement {
        let container = div().flex_none();
        let container = if let Some(border_color) = self.border_color {
            if matches!(self.kind, IndicatorKind::Dot | IndicatorKind::Bar) {
                container.border_1().border_color(border_color.color(cx))
            } else {
                container
            }
        } else {
            container
        };

        match self.kind {
            IndicatorKind::Icon(icon) => container
                .child(icon.map(|icon| icon.custom_size(rems_from_px(8.)).color(self.color))),
            IndicatorKind::Dot => container
                .w_1p5()
                .h_1p5()
                .rounded_full()
                .bg(self.color.color(cx)),
            IndicatorKind::Bar => container
                .w_full()
                .h_1p5()
                .rounded_t_md()
                .bg(self.color.color(cx)),
        }
    }
}

impl ComponentPreview for Indicator {
    fn description() -> impl Into<Option<&'static str>> {
        "An indicator visually represents a status or state."
    }

    fn examples(_: &WindowContext) -> Vec<ComponentExampleGroup<Self>> {
        vec![
            example_group_with_title(
                "Types",
                vec![
                    single_example("Dot", Indicator::dot().color(Color::Info)),
                    single_example("Bar", Indicator::bar().color(Color::Player(2))),
                    single_example(
                        "Icon",
                        Indicator::icon(Icon::new(IconName::Check).color(Color::Success)),
                    ),
                ],
            ),
            example_group_with_title(
                "Examples",
                vec![
                    single_example("Info", Indicator::dot().color(Color::Info)),
                    single_example("Success", Indicator::dot().color(Color::Success)),
                    single_example("Warning", Indicator::dot().color(Color::Warning)),
                    single_example("Error", Indicator::dot().color(Color::Error)),
                ],
            ),
        ]
    }
}