ZIm/crates/story/src/story.rs
Nate Butler e26620d1cf
gpui: Add a standard text example (#30747)
This is a dumb first pass at a standard text example. We'll use this to
start digging in to some text/scale rendering issues.

There will be a ton of follow-up features to this, but starting simple.

Release Notes:

- N/A
2025-05-16 17:35:44 +02:00

209 lines
5.8 KiB
Rust

use gpui::{
AnyElement, App, Div, SharedString, Window, colors::DefaultColors, div, prelude::*, px, rems,
};
use itertools::Itertools;
use smallvec::SmallVec;
pub struct Story {}
impl Story {
pub fn container(cx: &App) -> gpui::Stateful<Div> {
div()
.id("story_container")
.overflow_y_scroll()
.w_full()
.min_h_full()
.flex()
.flex_col()
.text_color(cx.default_colors().text)
.bg(cx.default_colors().background)
}
pub fn title(title: impl Into<SharedString>, cx: &App) -> impl Element {
div()
.text_xs()
.text_color(cx.default_colors().text)
.child(title.into())
}
pub fn title_for<T>(cx: &App) -> impl Element {
Self::title(std::any::type_name::<T>(), cx)
}
pub fn section(cx: &App) -> Div {
div()
.p_4()
.m_4()
.border_1()
.border_color(cx.default_colors().separator)
}
pub fn section_title(cx: &App) -> Div {
div().text_lg().text_color(cx.default_colors().text)
}
pub fn group(cx: &App) -> Div {
div().my_2().bg(cx.default_colors().container)
}
pub fn code_block(code: impl Into<SharedString>, cx: &App) -> Div {
div()
.size_full()
.p_2()
.max_w(rems(36.))
.bg(cx.default_colors().container)
.rounded_sm()
.text_sm()
.text_color(cx.default_colors().text)
.overflow_hidden()
.child(code.into())
}
pub fn divider(cx: &App) -> Div {
div().my_2().h(px(1.)).bg(cx.default_colors().separator)
}
pub fn description(description: impl Into<SharedString>, cx: &App) -> impl Element {
div()
.text_sm()
.text_color(cx.default_colors().text)
.min_w_96()
.child(description.into())
}
pub fn label(label: impl Into<SharedString>, cx: &App) -> impl Element {
div()
.text_xs()
.text_color(cx.default_colors().text)
.child(label.into())
}
/// Note: Not `ui::v_flex` as the `story` crate doesn't depend on the `ui` crate.
pub fn v_flex() -> Div {
div().flex().flex_col().gap_1()
}
}
#[derive(IntoElement)]
pub struct StoryItem {
label: SharedString,
item: AnyElement,
description: Option<SharedString>,
usage: Option<SharedString>,
}
impl StoryItem {
pub fn new(label: impl Into<SharedString>, item: impl IntoElement) -> Self {
Self {
label: label.into(),
item: item.into_any_element(),
description: None,
usage: None,
}
}
pub fn description(mut self, description: impl Into<SharedString>) -> Self {
self.description = Some(description.into());
self
}
pub fn usage(mut self, code: impl Into<SharedString>) -> Self {
self.usage = Some(code.into());
self
}
}
impl RenderOnce for StoryItem {
fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement {
let colors = cx.default_colors();
div()
.my_2()
.flex()
.gap_4()
.w_full()
.child(
Story::v_flex()
.px_2()
.w_1_2()
.min_h_px()
.child(Story::label(self.label, cx))
.child(
div()
.rounded_sm()
.bg(colors.background)
.border_1()
.border_color(colors.border)
.py_1()
.px_2()
.overflow_hidden()
.child(self.item),
)
.when_some(self.description, |this, description| {
this.child(Story::description(description, cx))
}),
)
.child(
Story::v_flex()
.px_2()
.flex_none()
.w_1_2()
.min_h_px()
.when_some(self.usage, |this, usage| {
this.child(Story::label("Example Usage", cx))
.child(Story::code_block(usage, cx))
}),
)
}
}
#[derive(IntoElement)]
pub struct StorySection {
description: Option<SharedString>,
children: SmallVec<[AnyElement; 2]>,
}
impl Default for StorySection {
fn default() -> Self {
Self::new()
}
}
impl StorySection {
pub fn new() -> Self {
Self {
description: None,
children: SmallVec::new(),
}
}
pub fn description(mut self, description: impl Into<SharedString>) -> Self {
self.description = Some(description.into());
self
}
}
impl RenderOnce for StorySection {
fn render(self, _window: &mut Window, cx: &mut App) -> impl IntoElement {
let children: SmallVec<[AnyElement; 2]> = SmallVec::from_iter(Itertools::intersperse_with(
self.children.into_iter(),
|| Story::divider(cx).into_any_element(),
));
Story::section(cx)
// Section title
.py_2()
// Section description
.when_some(self.description.clone(), |section, description| {
section.child(Story::description(description, cx))
})
.child(div().flex().flex_col().gap_2().children(children))
.child(Story::divider(cx))
}
}
impl ParentElement for StorySection {
fn extend(&mut self, elements: impl IntoIterator<Item = AnyElement>) {
self.children.extend(elements)
}
}