pelican_ui_std 0.2.17

Standard UI tools and components built off Pelican UI of the RAMP stack.
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94

use pelican_ui::events::OnEvent;
use pelican_ui::drawable::{Drawable, Component, ShapeType, Shape, Color};
use pelican_ui::layout::{Area, SizeRequest};
use pelican_ui::Context;

/// # Rectangle
///
/// A rectangle component with a customizable background and optional outline.  
/// Supports rounded corners and adjustable stroke thickness.
///
/// - `background`: background color
/// - `outline`: outline color
/// - `radius`: corner radius
/// - `stroke`: optional outline thickness (`None` → no outline)
///
/// Rectangles expand to fill available space, so wrap them in a [`Bin`]  
/// with a [`Stack`] layout to control the size.
///
/// <img src="https://raw.githubusercontent.com/ramp-stack/pelican_ui_std/main/src/examples/outlined_rectangle.png"
///      alt="Rectangle Example"
///      width="400">
///
/// ## Example
/// ```rust
/// let background = ctx.theme.colors.brand;
/// let outline = ctx.theme.colors.outline.primary;
/// let rect = Rectangle::new(background, outline, 8.0, Some(8.0));
/// let layout = Stack(Offset::Center, Offset::Center, Size::Static(100.0), Size::Static(100.0), Padding::default());
/// let shape = Bin(layout, rect);
/// ```
#[derive(Debug)]
pub struct Rectangle(Shape, Option<Shape>);

impl OnEvent for Rectangle {}

impl Rectangle {
    pub fn new(background: Color, radius: f32, outline: Option<(f32, Color)>) -> Self {
        Rectangle(
            Shape{shape: ShapeType::RoundedRectangle(0.0, (0.0, 0.0), radius, 0.0), color: background},
            outline.map(|(s, c)| Shape{shape: ShapeType::RoundedRectangle(s, (0.0, 0.0), radius, 0.0), color: c})
        )
    }

    pub fn background(&mut self) -> &mut Color {&mut self.0.color}
    pub fn outline(&mut self) -> Option<&mut Color> {self.1.as_mut().map(|r| &mut r.color)}
    pub fn size(&self) -> (f32, f32) {self.0.shape.size()}
}

impl Component for Rectangle {
    fn children_mut(&mut self) -> Vec<&mut dyn Drawable> {vec![&mut self.0]}
    fn children(&self) -> Vec<&dyn Drawable> {vec![&self.0]}
    fn request_size(&self, _ctx: &mut Context, _children: Vec<SizeRequest>) -> SizeRequest {
        SizeRequest::fill()
    }
    fn build(&mut self, _ctx: &mut Context, size: (f32, f32), _children: Vec<SizeRequest>) -> Vec<Area> {
        if let ShapeType::RoundedRectangle(_, s, _, _) = &mut self.0.shape {
            *s = size;
        }
        if let Some(shape) = &mut self.1 {
            if let ShapeType::RoundedRectangle(_, s, _, _) = &mut shape.shape {
                *s = size;
            }
        }
        vec![Area { offset: (0.0, 0.0), size }]
    }
}

/// # Circle
///
/// Creates a circle with a specified size and color.  
/// Supports an optional outline by setting `outlined = true`.
///
/// - `size`: diameter of the circle
/// - `color`: fill color
/// - `outlined`: if true, a proportional outline is added
///
/// <img src="https://raw.githubusercontent.com/ramp-stack/pelican_ui_std/main/src/examples/circle.png"
///      alt="Circle Example"
///      width="200">
///
/// ## Example
/// ```rust
/// let color = ctx.theme.colors.brand;
/// let circle = Circle::new(100.0, color, true); 
/// ```
pub struct Circle;

impl Circle {
    #[allow(clippy::new_ret_no_self)]
    pub fn new(size: f32, color: Color, outlined: bool) -> Shape {
        let outline = if outlined { size * 0.06 } else { 0.0 };
        Shape { shape: ShapeType::Ellipse(outline, (size, size), 0.0), color }
    }
}