Struct Skeleton 

pub struct Skeleton { /* private fields */ }

Skeleton loading placeholder with a configurable theme.

Example

fn app() -> impl IntoElement {
    let loading = use_state(|| true);
    Skeleton::new(*loading.read())
        .width(Size::px(200.))
        .height(Size::px(80.))
        .animation(SkeletonAnimation::Shimmer)
        .duration(Duration::from_millis(1200))
        .child("Some content")
}

Implementations

impl Skeleton

pub fn new(loading: bool) -> Self

pub fn theme(self, theme: SkeletonThemePartial) -> Self

Override the full theme partial at once.

Trait Implementations

impl ChildrenExt for Skeleton

fn get_children(&mut self) -> &mut Vec<Element>

Returns a mutable reference to the internal children vector.

fn children(self, children: impl IntoIterator<Item = impl IntoElement>) -> Self

Extends the children with an iterable of anything that implements IntoElement.

fn maybe_child<C>(self, child: Option<C>) -> Self

where C: IntoElement,

Appends a child only when the Option is Some.

fn child<C>(self, child: C) -> Self

where C: IntoElement,

Appends a single child element.

impl Component for Skeleton

fn render(&self) -> impl IntoElement

fn render_key(&self) -> DiffKey

impl ContainerExt for Skeleton

fn padding(self, padding: impl Into<Gaps>) -> Self

Set the inner spacing between the element’s edges and its content. See Gaps.

impl ContainerWithContentExt for Skeleton

fn direction(self, direction: Direction) -> Self

Set the axis children are stacked along. See Direction.

fn main_align(self, main_align: impl Into<Alignment>) -> Self

Set how children are aligned along the direction axis. See Alignment.

fn cross_align(self, cross_align: impl Into<Alignment>) -> Self

Set how children are aligned across the direction axis. See Alignment.

fn spacing(self, spacing: f32) -> Self

Set the gap inserted between adjacent children, in pixels.

fn content(self, content: Content) -> Self

Set how children share the available space along the direction axis. See Content.

fn center(self) -> Self

Center children on both axes. Shorthand for main_align and cross_align set to Alignment::Center.

fn offset_x(self, offset_x: f32) -> Self

Shift the element’s children horizontally by the given pixels.

fn offset_y(self, offset_y: f32) -> Self

Shift the element’s children vertically by the given pixels.

fn vertical(self) -> Self

Stack children vertically. Shorthand for direction set to Direction::Vertical.

fn horizontal(self) -> Self

Stack children horizontally. Shorthand for direction set to Direction::Horizontal.

impl Default for Skeleton

fn default() -> Self

Returns the “default value” for a type.

impl KeyExt for Skeleton

fn write_key(&mut self) -> &mut DiffKey

Returns a mutable reference to the element’s diff key.

fn key(self, key: impl Hash) -> Self

where Self: 'static,

Assign a key derived from any hashable value, used to reconcile elements in dynamic lists. The key is scoped to the element’s type, so the same value used on different element or component types never collides.

impl LayoutExt for Skeleton

fn get_layout(&mut self) -> &mut LayoutData

Returns a mutable reference to the element’s layout data.

fn layout(self, layout: LayoutData) -> Self

Replace all of the element’s layout data at once. See LayoutData.

impl PartialEq for Skeleton

fn eq(&self, other: &Skeleton) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl SkeletonThemePartialExt for Skeleton

fn background(self, background: impl Into<Color>) -> Self

fn shimmer_color(self, shimmer_color: impl Into<Color>) -> Self

fn duration(self, duration: impl Into<Duration>) -> Self

fn animation(self, animation: impl Into<SkeletonAnimation>) -> Self

fn corner_radius(self, corner_radius: impl Into<CornerRadius>) -> Self

fn shimmer_from(self, shimmer_from: f32) -> Self

fn shimmer_to(self, shimmer_to: f32) -> Self

fn shimmer_width(self, shimmer_width: f32) -> Self

impl StructuralPartialEq for Skeleton