Skip to main content

StatProps

Struct StatProps 

Source
pub struct StatProps {
    pub label: String,
    pub value: String,
    pub detail: String,
    pub detail_icon: Option<IconData>,
    pub detail_icon_label: String,
    pub accent: String,
    pub chart: Vec<f64>,
    pub icon: Option<IconData>,
    pub href: Option<String>,
    pub attrs: Attributes,
}
Expand description

One figure for a dashboard: what it counts, the value, and an optional line under it. With an href the whole tile is a link, such as to the list the figure counts.

Lay several out in a grid of your own:

view! {
    <div class="grid gap-4 sm:grid-cols-2 xl:grid-cols-4">
        stat(
            label: "Posts",
            value: "66",
            detail: "65 drafts",
            icon: icons::FILE_TEXT,
            href: "/admin/posts".to_string(),
        )
        stat(
            label: "Comments",
            value: "4",
            detail: "2 more than last week",
            detail_icon: icons::ARROW_UP,
            accent: "text-success",
            chart: vec![1.0, 3.0, 2.0, 4.0],
        )
    </div>
}

Fields§

§label: String

What the value counts, e.g. "Posts".

§value: String

The figure, formatted, e.g. "1,204" or "98%".

§detail: String

Optional line under the value, e.g. "12 this week".

§detail_icon: Option<IconData>

Optional icon before the detail line, such as an arrow for its trend.

§detail_icon_label: String

What the detail icon says to a screen reader, e.g. "Up"; the icon alone is hidden from it.

§accent: String

The text-color class of the detail line and the chart, e.g. "text-success"; muted when empty.

§chart: Vec<f64>

Optional values the tile draws as a sparkline under the value, oldest first. Fewer than two finite values draw none.

§icon: Option<IconData>

Optional icon before the label.

§href: Option<String>

Optional URL the tile links to.

§attrs: Attributes

Extra attributes for the tile.

Implementations§

Source§

impl StatProps

Source

pub fn builder() -> StatPropsBuilder<label, value>

Returns a StatPropsBuilder with no properties set.

Trait Implementations§

Source§

impl Props for StatProps

Source§

type Builder = StatPropsBuilder

The builder type in its initial state, with no properties set.
Source§

fn builder() -> Self::Builder

Returns a builder with no properties set.

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<ST, DT> CastableFrom<ST, Initialized, Initialized> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<ST, DT> CastableFrom<ST, Uninit, Uninit> for DT
where ST: ?Sized, DT: ?Sized,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> Read<Exclusive, BecauseExclusive> for T
where T: ?Sized,

Source§

impl<T> Same for T

Source§

type Output = T

Should always be Self
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, !>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
Source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

Source§

fn vzip(self) -> V

Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more