- Upstream merged core, data, editor, and utils into a single `components` crate: `ui::button`, `ui::tabs`, `ui::code`, `ui::tree`, `ui::sidebar` are flat, and `h_flex`/`v_flex`/`StyledExt` live in `ui::common` and `ui::layout`. - Adopts the new wrapper-less component module tree, the merged theme/icon updates, and the relocated editor grammars. - Titlebar repo tabs use the new `TabsVariant::Titlebar` capsule sizing. - Doc examples now import from `ui::`, so all 44 doctests compile; the clipboard sample no longer names the kit crate. - docs/ui-gaps.md records that `ui` has no dock/view-registry API instead of the deleted `DockState`.
172 lines
4.8 KiB
Rust
172 lines
4.8 KiB
Rust
//! Renders a small pill that labels a count or a state.
|
|
//!
|
|
//! # Examples
|
|
//!
|
|
//! ```no_run
|
|
//! use ui::badge::{Badge, BadgeVariant};
|
|
//!
|
|
//! let unread = Badge::new("unread", "12").variant(BadgeVariant::Accent);
|
|
//! ```
|
|
|
|
use std::rc::Rc;
|
|
|
|
use crate::icons::Icon;
|
|
use crate::theme::{ActiveTheme as _, Size, Theme};
|
|
use gpui::prelude::FluentBuilder as _;
|
|
use gpui::{
|
|
AnyView, App, ElementId, Hsla, InteractiveElement as _, IntoElement, ParentElement as _,
|
|
RenderOnce, SharedString, StatefulInteractiveElement as _, StyleRefinement, Styled as _,
|
|
Window, transparent_black,
|
|
};
|
|
|
|
use crate::components::common::{StyledExt, h_flex};
|
|
|
|
/// The tooltip view builder gpui's `.tooltip(...)` expects.
|
|
type TooltipBuilder = Rc<dyn Fn(&mut Window, &mut App) -> AnyView>;
|
|
|
|
/// The visual treatment of a [`Badge`].
|
|
#[derive(Clone, Copy, Debug, Default, PartialEq, Eq)]
|
|
pub enum BadgeVariant {
|
|
/// The default; quiet muted fill for counts.
|
|
#[default]
|
|
Neutral,
|
|
/// The accent ramp; something active or newly added.
|
|
Accent,
|
|
/// The success ramp.
|
|
Success,
|
|
/// The warning ramp.
|
|
Warning,
|
|
/// The destructive ramp.
|
|
Danger,
|
|
/// No fill, just a border; the quietest badge.
|
|
Outline,
|
|
}
|
|
|
|
impl BadgeVariant {
|
|
fn tokens(self, theme: &Theme) -> (Hsla, Hsla, Hsla) {
|
|
match self {
|
|
Self::Neutral => (
|
|
theme.colors.muted,
|
|
theme.colors.muted_foreground,
|
|
transparent_black(),
|
|
),
|
|
Self::Accent => (
|
|
theme.ramps.primary.base,
|
|
theme.colors.primary_foreground,
|
|
transparent_black(),
|
|
),
|
|
Self::Success => (
|
|
theme.ramps.success.base,
|
|
theme.colors.success_foreground,
|
|
transparent_black(),
|
|
),
|
|
Self::Warning => (
|
|
theme.ramps.warning.base,
|
|
theme.colors.warning_foreground,
|
|
transparent_black(),
|
|
),
|
|
Self::Danger => (
|
|
theme.ramps.destructive.base,
|
|
theme.colors.destructive_foreground,
|
|
transparent_black(),
|
|
),
|
|
Self::Outline => (
|
|
transparent_black(),
|
|
theme.colors.foreground,
|
|
theme.colors.border,
|
|
),
|
|
}
|
|
}
|
|
}
|
|
|
|
/// A small pill for a count or a state.
|
|
#[derive(IntoElement)]
|
|
#[must_use]
|
|
pub struct Badge {
|
|
id: ElementId,
|
|
label: SharedString,
|
|
icon: Option<Icon>,
|
|
variant: BadgeVariant,
|
|
tooltip: Option<TooltipBuilder>,
|
|
style: StyleRefinement,
|
|
}
|
|
|
|
impl Badge {
|
|
/// Creates a badge with `label`, a count or state word the caller formats.
|
|
pub fn new<I, L>(id: I, label: L) -> Self
|
|
where
|
|
I: Into<ElementId>,
|
|
L: Into<SharedString>,
|
|
{
|
|
Self {
|
|
id: id.into(),
|
|
label: label.into(),
|
|
icon: None,
|
|
variant: BadgeVariant::default(),
|
|
tooltip: None,
|
|
style: StyleRefinement::default(),
|
|
}
|
|
}
|
|
|
|
/// Sets the badge's [`BadgeVariant`].
|
|
pub fn variant(mut self, variant: BadgeVariant) -> Self {
|
|
self.variant = variant;
|
|
self
|
|
}
|
|
|
|
/// Shows an icon before the label.
|
|
pub fn icon<I>(mut self, icon: I) -> Self
|
|
where
|
|
I: Into<Icon>,
|
|
{
|
|
self.icon = Some(icon.into());
|
|
self
|
|
}
|
|
|
|
/// Shows a tooltip view next to the badge after it is hovered.
|
|
pub fn tooltip<F>(mut self, tooltip: F) -> Self
|
|
where
|
|
F: Fn(&mut Window, &mut App) -> AnyView + 'static,
|
|
{
|
|
self.tooltip = Some(Rc::new(tooltip));
|
|
self
|
|
}
|
|
}
|
|
|
|
impl gpui::Styled for Badge {
|
|
fn style(&mut self) -> &mut gpui::StyleRefinement {
|
|
&mut self.style
|
|
}
|
|
}
|
|
|
|
impl RenderOnce for Badge {
|
|
fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement {
|
|
let theme = cx.theme();
|
|
let metrics = theme.sizes.resolve(Size::Small);
|
|
let label_size = metrics.caption_size;
|
|
let (background, foreground, border) = self.variant.tokens(theme);
|
|
|
|
h_flex()
|
|
.id(self.id.clone())
|
|
.flex_none()
|
|
.justify_center()
|
|
.gap_1()
|
|
.rounded(theme.radius.full)
|
|
.border_1()
|
|
.border_color(border)
|
|
.bg(background)
|
|
.text_color(foreground)
|
|
.text_size(label_size)
|
|
.px(metrics.dense_padding_x)
|
|
.py_0p5()
|
|
.when_some(self.icon, |badge, icon| {
|
|
badge.child(icon.size(metrics.dense_icon_size).color(foreground))
|
|
})
|
|
.child(self.label)
|
|
.refine_style(&self.style)
|
|
.when_some(self.tooltip, |badge, tooltip| {
|
|
badge.tooltip(move |window, cx| tooltip(window, cx))
|
|
})
|
|
}
|
|
}
|