Struct leptos::SuspenseProps

source ·
pub struct SuspenseProps<V>
where V: IntoView + 'static,
{ pub fallback: ViewFn, pub children: Rc<dyn Fn() -> V>, }
Expand description

Props for the Suspense component.

If any Resource is read in the children of this component, it will show the fallback while they are loading. Once all are resolved, it will render the children.

Note that the children will be rendered initially (in order to capture the fact that those resources are read under the suspense), so you cannot assume that resources have Some value in children.

async fn fetch_cats(how_many: u32) -> Option<Vec<String>> { Some(vec![]) }

let (cat_count, set_cat_count) = create_signal::<u32>(1);

let cats = create_resource(move || cat_count.get(), |count| fetch_cats(count));

view! {
  <div>
    <Suspense fallback=move || view! { <p>"Loading (Suspense Fallback)..."</p> }>
      {move || {
          cats.get().map(|data| match data {
            None => view! {  <pre>"Error"</pre> }.into_view(),
            Some(cats) => cats
                .iter()
                .map(|src| {
                    view! {
                      <img src={src}/>
                    }
                })
                .collect_view(),
          })
        }
      }
    </Suspense>
  </div>
};

§Required Props

  • children: [Rc<dyn Fn() -> V>]
    • Children will be displayed once all async Resources have resolved.

§Optional Props

  • fallback: impl Into<ViewFn>
    • Returns a fallback UI that will be shown while async Resources are still loading. By default this is the empty view.

Fields§

§fallback: ViewFn

Returns a fallback UI that will be shown while async Resources are still loading. By default this is the empty view.

§children: Rc<dyn Fn() -> V>

Children will be displayed once all async Resources have resolved.

Implementations§

source§

impl<V> SuspenseProps<V>
where V: IntoView + 'static,

source

pub fn builder() -> SuspensePropsBuilder<V, ((), ())>

Create a builder for building SuspenseProps. On the builder, call .fallback(...)(optional), .children(...) to set the values of the fields. Finally, call .build() to create the instance of SuspenseProps.

Trait Implementations§

source§

impl<V> IntoView for SuspenseProps<V>
where V: IntoView + 'static,

source§

fn into_view(self) -> View

Converts the value into View.

Auto Trait Implementations§

§

impl<V> Freeze for SuspenseProps<V>

§

impl<V> !RefUnwindSafe for SuspenseProps<V>

§

impl<V> !Send for SuspenseProps<V>

§

impl<V> !Sync for SuspenseProps<V>

§

impl<V> Unpin for SuspenseProps<V>

§

impl<V> !UnwindSafe for SuspenseProps<V>

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<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> IntoEither for T

source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
source§

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

§

type Error = Infallible

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

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

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

§

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<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