Add ui::ContentGroup (#20666)

TL;DR our version of [HIG's
Box](https://developer.apple.com/design/human-interface-guidelines/boxes)

We can't use the name `Box` (because rust) or `ContentBox` (because
taffy/styles/css).

---

This PR introduces the `ContentGroup` component, a flexible container
inspired by HIG's `Box` component. It's designed to hold and organize
various UI elements with options to toggle borders and background fills.

**Example usage**:

```rust
ContentGroup::new()
    .flex_1()
    .items_center()
    .justify_center()
    .h_48()
    .child(Label::new("Flexible ContentBox"))
```

Here are some configurations:

- Default: Includes both border and fill.
- Borderless: No border for a clean look.
- Unfilled: No background fill for a transparent appearance.

**Preview**:

![CleanShot 2024-11-14 at 07 05
15@2x](https://github.com/user-attachments/assets/c838371e-e24f-46f0-94b4-43c078e8f14e)

---

_This PR was written by a large language model with input from the
author._

Release Notes:

- N/A
This commit is contained in:
Nate Butler 2024-11-14 08:25:48 -05:00 committed by GitHub
parent f7b4431659
commit 04ba75e2e5
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
6 changed files with 173 additions and 11 deletions

View file

@ -0,0 +1,135 @@
use crate::prelude::*;
use gpui::{AnyElement, IntoElement, ParentElement, StyleRefinement, Styled};
use smallvec::SmallVec;
/// Creates a new [ContentGroup].
pub fn content_group() -> ContentGroup {
ContentGroup::new()
}
/// A [ContentGroup] that vertically stacks its children.
///
/// This is a convenience function that simply combines [`ContentGroup`] and [`v_flex`](crate::v_flex).
pub fn v_group() -> ContentGroup {
content_group().v_flex()
}
/// Creates a new horizontal [ContentGroup].
///
/// This is a convenience function that simply combines [`ContentGroup`] and [`h_flex`](crate::h_flex).
pub fn h_group() -> ContentGroup {
content_group().h_flex()
}
/// A flexible container component that can hold other elements.
#[derive(IntoElement)]
pub struct ContentGroup {
base: Div,
border: bool,
fill: bool,
children: SmallVec<[AnyElement; 2]>,
}
impl ContentGroup {
/// Creates a new [ContentBox].
pub fn new() -> Self {
Self {
base: div(),
border: true,
fill: true,
children: SmallVec::new(),
}
}
/// Removes the border from the [ContentBox].
pub fn borderless(mut self) -> Self {
self.border = false;
self
}
/// Removes the background fill from the [ContentBox].
pub fn unfilled(mut self) -> Self {
self.fill = false;
self
}
}
impl ParentElement for ContentGroup {
fn extend(&mut self, elements: impl IntoIterator<Item = AnyElement>) {
self.children.extend(elements)
}
}
impl Styled for ContentGroup {
fn style(&mut self) -> &mut StyleRefinement {
self.base.style()
}
}
impl RenderOnce for ContentGroup {
fn render(self, cx: &mut WindowContext) -> impl IntoElement {
// TODO:
// Baked in padding will make scrollable views inside of content boxes awkward.
//
// Do we make the padding optional, or do we push to use a different component?
self.base
.when(self.fill, |this| {
this.bg(cx.theme().colors().text.opacity(0.05))
})
.when(self.border, |this| {
this.border_1().border_color(cx.theme().colors().border)
})
.rounded_md()
.p_2()
.children(self.children)
}
}
impl ComponentPreview for ContentGroup {
fn description() -> impl Into<Option<&'static str>> {
"A flexible container component that can hold other elements. It can be customized with or without a border and background fill."
}
fn example_label_side() -> ExampleLabelSide {
ExampleLabelSide::Bottom
}
fn examples(_: &WindowContext) -> Vec<ComponentExampleGroup<Self>> {
vec![example_group(vec![
single_example(
"Default",
ContentGroup::new()
.flex_1()
.items_center()
.justify_center()
.h_48()
.child(Label::new("Default ContentBox")),
)
.grow(),
single_example(
"Without Border",
ContentGroup::new()
.flex_1()
.items_center()
.justify_center()
.h_48()
.borderless()
.child(Label::new("Borderless ContentBox")),
)
.grow(),
single_example(
"Without Fill",
ContentGroup::new()
.flex_1()
.items_center()
.justify_center()
.h_48()
.unfilled()
.child(Label::new("Unfilled ContentBox")),
)
.grow(),
])
.grow()]
}
}