yew-bootstrap 0.14.0

Bootstrap 5 Components for Yew
Documentation 
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

use yew::prelude::*;

/// Controls the display variant used for a [CardImage]
#[derive(Copy, Clone, Debug, PartialEq, Eq)]
pub enum ImageVariant {
    /// Default display. Nothing special.
    Default,
    /// Image at the top of a card.
    Top,
    /// Image at the bottom of a card.
    Bottom,
}

/// # Properties of [CardImage]
#[derive(Properties, Debug, PartialEq)]
pub struct CardImageProps {
    /// The display variant to use. See [ImageVariant] for more details.
    #[prop_or(ImageVariant::Default)]
    pub variant: ImageVariant,
    /// Extra CSS classes to include, in addition to the defaults.
    #[prop_or_default]
    pub class: Classes,
    /// The image source to use. Passed directly to the `src` property of the generated `img`.
    pub src: AttrValue,
    /// Descriptive text for screen reader users.
    #[prop_or_default]
    pub alt: AttrValue,
}

/// # Card Image component
/// An image contained within a [Card](super::Card). Can be styled to match with being on the top
/// or bottom using [ImageVariant].
///
/// See [CardImageProps] for a list of properties.
#[function_component]
pub fn CardImage(props: &CardImageProps) -> Html {
    let mut classes = match props.variant {
        ImageVariant::Default => Classes::from("card-img"),
        ImageVariant::Top => Classes::from("card-img-top"),
        ImageVariant::Bottom => Classes::from("card-img-bottom"),
    };

    classes.extend(&props.class);

    html! {
        <img class={classes} data-src={props.src.clone()} style="height: 180px; width: 100%; display: block;" alt={props.alt.clone()} />
    }
}

/// # Properties of [CardImageOverlay]
#[derive(Properties, Debug, PartialEq)]
pub struct CardImageOverlayProps {
    /// Inner components (displayed in the [CardImageOverlay])
    #[prop_or_default]
    pub children: Children,
    /// Extra CSS classes to include, in addition to the defaults.
    #[prop_or_default]
    pub class: Classes,
}

/// # Card Image Overlay component
/// Used in combination with a [CardImage] to create content overlayed on an image.
///
/// See [CardImageOverlayProps] for a list of properties.
///
/// ## Examples
///
/// ```
/// use yew::prelude::*;
/// use yew_bootstrap::component::card::*;
/// fn test() -> Html {
///   html! {
///     <Card>
///         <CardImage variant={ImageVariant::Top} src="imgsrc.jpg" />
///         <CardImageOverlay>{"Text on top of image"}</CardImageOverlay>
///     </Card>
///   }
/// }
/// ```
#[function_component]
pub fn CardImageOverlay(props: &CardImageOverlayProps) -> Html {
    let mut classes = props.class.clone();
    classes.push("card-img-overlay");

    html! {
        <div class={classes}>
            {props.children.clone()}
        </div>
    }
}