Struct leptos::TransitionProps

pub struct TransitionProps {
    pub fallback: ViewFn,
    pub set_pending: Option<SignalSetter<bool>>,
    pub children: Box<dyn Fn() -> Fragment>,
}

Props for the Transition component.

If any Resources are 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. Unlike Suspense, this will not fall back to the fallback state if there are further changes after the initial load.

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 (pending, set_pending) = create_signal(false);

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

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

Required Props

• children: [Box<dyn Fn() -> Fragment>]
  • Will be displayed once all resources have resolved.

Optional Props

• fallback: impl Into<ViewFn>
  • Will be displayed while resources are pending. By default this is the empty view.
• set_pending: impl Into<SignalSetter<bool>>
  • A function that will be called when the component transitions into or out of the pending state, with its argument indicating whether it is pending (true) or not pending (false).

Fields

fallback: ViewFn

Will be displayed while resources are pending. By default this is the empty view.

set_pending: Option<SignalSetter<bool>>

A function that will be called when the component transitions into or out of the pending state, with its argument indicating whether it is pending (true) or not pending (false).

children: Box<dyn Fn() -> Fragment>

Will be displayed once all resources have resolved.

Implementations

impl TransitionProps

pub fn builder() -> TransitionPropsBuilder<((), (), ())>

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

Trait Implementations

impl IntoView for TransitionProps

fn into_view(self) -> View

Converts the value into View.