ZIm/crates/ui/src/traits.rs at 55ee72d84ab90c6f4b91aa25a3c9cf7f5dc799d3 - Yehowshua/ZIm - Forgejo: Beyond coding. We Forge.

Yehowshua/ZIm

Nate Butler f6fbf662b4

Add ui::ComponentPreview (#20319 )

The `ComponentPreview` trait enables rendering storybook-like previews
of components inside of Zed.


![CleanShot 2024-11-06 at 16 32
25@2x](https://github.com/user-attachments/assets/6894663f-1bbc-4a40-b420-33882e9e239a)


This initial version will work for any component that doesn't return a
view.

Example impl:

```rust
impl ComponentPreview for Checkbox {
    fn description() -> impl Into<Option<&'static str>> {
        "A checkbox lets people choose between opposing..."
    }

    fn examples() -> Vec<ComponentExampleGroup<Self>> {
        vec![
            example_group(
                "Default",
                vec![
                    single_example(
                        "Unselected",
                        Checkbox::new("checkbox_unselected", Selection::Unselected),
                    ),
                    // ... more examples
                ],
            ),
            // ... more examples
        ]
    }
}
```

Example usage:

```rust
fn render_components_page(&self, cx: &ViewContext<Self>) -> impl IntoElement {
        v_flex()
            .gap_2()
            .child(Checkbox::render_component_previews(cx))
            .child(Icon::render_component_previews(cx))
    }
}
```

Release Notes:

- N/A

2024-11-06 16:54:18 -05:00

7 lines

148 B

Rust

Raw Blame History

 pub mod clickable;
 pub mod component_preview;
 pub mod disableable;
 pub mod fixed;
 pub mod selectable;
 pub mod styled_ext;
 pub mod visible_on_hover;