Struct leptos::TransitionProps

source ·
pub struct TransitionProps<F, E>where
    F: Fn() -> E + 'static,
    E: IntoView,{
    pub fallback: F,
    pub set_pending: Option<SignalSetter<bool>>,
    pub children: Box<dyn Fn(Scope) -> Fragment>,
}
Expand description

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

let cats = create_resource(cx, cat_count, |count| fetch_cats(count));

view! { cx,
  <div>
    <Transition
      fallback=move || view! { cx, <p>"Loading..."</p>}
      set_pending=set_pending.into()
    >
      {move || {
          cats.read(cx).map(|data| match data {
            None => view! { cx,  <pre>"Error"</pre> }.into_any(),
            Some(cats) => view! { cx,
              <div>{
                cats.iter()
                  .map(|src| {
                    view! { cx,
                      <img src={src}/>
                    }
                  })
                  .collect::<Vec<_>>()
              }</div>
            }.into_any(),
          })
        }
      }
    </Transition>
  </div>
};

Required Props

  • cx: Scope
  • fallback: [F]
    • Will be displayed while resources are pending.
  • children: [Box<dyn Fn(Scope) -> Fragment>]
    • Will be displayed once all resources have resolved.

Optional Props

  • set_pending: 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: F

Will be displayed while resources are pending.

§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(Scope) -> Fragment>

Will be displayed once all resources have resolved.

Implementations§

source§

impl<F, E> TransitionProps<F, E>where F: Fn() -> E + 'static, E: IntoView,

source

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

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

Auto Trait Implementations§

§

impl<F, E> !RefUnwindSafe for TransitionProps<F, E>

§

impl<F, E> !Send for TransitionProps<F, E>

§

impl<F, E> !Sync for TransitionProps<F, E>

§

impl<F, E> Unpin for TransitionProps<F, E>where F: Unpin,

§

impl<F, E> !UnwindSafe for TransitionProps<F, E>

Blanket Implementations§

source§

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

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

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

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere 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 Twhere 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, U> TryFrom<U> for Twhere 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 Twhere 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