ui: Add Chip component (#34521)

Possibly the simplest component in our set, but a nice one to have so we
can standardize how it looks across the app.

Release Notes:

- N/A
This commit is contained in:
Danilo Leal 2025-07-16 01:15:45 -03:00 committed by GitHub
parent ee4b9a27a2
commit 59d524427e
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
7 changed files with 124 additions and 40 deletions

View file

@ -2,6 +2,7 @@ mod avatar;
mod banner;
mod button;
mod callout;
mod chip;
mod content_group;
mod context_menu;
mod disclosure;
@ -43,6 +44,7 @@ pub use avatar::*;
pub use banner::*;
pub use button::*;
pub use callout::*;
pub use chip::*;
pub use content_group::*;
pub use context_menu::*;
pub use disclosure::*;

View file

@ -0,0 +1,106 @@
use crate::prelude::*;
use gpui::{AnyElement, Hsla, IntoElement, ParentElement, Styled};
/// Chips provide a container for an informative label.
///
/// # Usage Example
///
/// ```
/// use ui::{Chip};
///
/// Chip::new("This Chip")
/// ```
#[derive(IntoElement, RegisterComponent)]
pub struct Chip {
label: SharedString,
label_color: Color,
label_size: LabelSize,
bg_color: Option<Hsla>,
}
impl Chip {
/// Creates a new `Chip` component with the specified label.
pub fn new(label: impl Into<SharedString>) -> Self {
Self {
label: label.into(),
label_color: Color::Default,
label_size: LabelSize::XSmall,
bg_color: None,
}
}
/// Sets the color of the label.
pub fn label_color(mut self, color: Color) -> Self {
self.label_color = color;
self
}
/// Sets the size of the label.
pub fn label_size(mut self, size: LabelSize) -> Self {
self.label_size = size;
self
}
/// Sets a custom background color for the callout content.
pub fn bg_color(mut self, color: Hsla) -> Self {
self.bg_color = Some(color);
self
}
}
impl RenderOnce for Chip {
fn render(self, _: &mut Window, cx: &mut App) -> impl IntoElement {
let bg_color = self
.bg_color
.unwrap_or(cx.theme().colors().element_background);
h_flex()
.min_w_0()
.flex_initial()
.px_1()
.border_1()
.rounded_sm()
.border_color(cx.theme().colors().border)
.bg(bg_color)
.overflow_hidden()
.child(
Label::new(self.label)
.size(self.label_size)
.color(self.label_color)
.buffer_font(cx),
)
}
}
impl Component for Chip {
fn scope() -> ComponentScope {
ComponentScope::DataDisplay
}
fn preview(_window: &mut Window, cx: &mut App) -> Option<AnyElement> {
let chip_examples = vec![
single_example("Default", Chip::new("Chip Example").into_any_element()),
single_example(
"Customized Label Color",
Chip::new("Chip Example")
.label_color(Color::Accent)
.into_any_element(),
),
single_example(
"Customized Label Size",
Chip::new("Chip Example")
.label_size(LabelSize::Large)
.label_color(Color::Accent)
.into_any_element(),
),
single_example(
"Customized Background Color",
Chip::new("Chip Example")
.bg_color(cx.theme().colors().text_accent.opacity(0.1))
.into_any_element(),
),
];
Some(example_group(chip_examples).vertical().into_any_element())
}
}

View file

@ -206,7 +206,7 @@ impl RenderOnce for KeybindingHint {
impl Component for KeybindingHint {
fn scope() -> ComponentScope {
ComponentScope::None
ComponentScope::DataDisplay
}
fn description() -> Option<&'static str> {

View file

@ -274,7 +274,7 @@ impl Render for LinkPreview {
impl Component for Tooltip {
fn scope() -> ComponentScope {
ComponentScope::None
ComponentScope::DataDisplay
}
fn description() -> Option<&'static str> {