Skip to main content

TransitionProps

Struct TransitionProps 

Source
pub struct TransitionProps<Chil>
where Chil: IntoView + Send + 'static,
{ pub fallback: ViewFnOnce, pub set_pending: Option<SignalSetter<bool>>, pub children: TypedChildren<Chil>, }
Expand description

Props for the Transition 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.

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 read synchronously have Some value in children. However, you can read resources asynchronously by using Suspend.

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

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

let cats = Resource::new(move || cat_count.get(), |count| fetch_cats(count));

view! {
  <div>
    <Transition fallback=move || view! { <p>"Loading (Suspense Fallback)..."</p> }>
      // you can access a resource synchronously
      {move || {
          cats.get().map(|data| {
            data
              .into_iter()
              .map(|src| {
                  view! {
                    <img src={src}/>
                  }
              })
              .collect_view()
          })
        }
      }
      // or you can use `Suspend` to read resources asynchronously
      {move || Suspend::new(async move {
        cats.await
              .into_iter()
              .map(|src| {
                  view! {
                    <img src={src}/>
                  }
              })
              .collect_view()
      })}
    </Transition>
  </div>
}

§Required Props

§Optional Props

  • fallback: impl Into<ViewFnOnce>
    • 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: ViewFnOnce

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: TypedChildren<Chil>

Implementations§

Source§

impl<Chil> TransitionProps<Chil>
where Chil: IntoView + Send + 'static,

Source

pub fn builder() -> TransitionPropsBuilder<Chil>

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§

Source§

impl<Chil> Props for TransitionProps<Chil>
where Chil: IntoView + Send + 'static,

Source§

type Builder = TransitionPropsBuilder<Chil>

Source§

fn builder() -> <TransitionProps<Chil> as Props>::Builder

Auto Trait Implementations§

§

impl<Chil> Freeze for TransitionProps<Chil>

§

impl<Chil> !RefUnwindSafe for TransitionProps<Chil>

§

impl<Chil> Send for TransitionProps<Chil>

§

impl<Chil> !Sync for TransitionProps<Chil>

§

impl<Chil> Unpin for TransitionProps<Chil>

§

impl<Chil> !UnwindSafe for TransitionProps<Chil>

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<E, T, Request, Encoding> FromReq<Patch<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Post<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, T, Request, Encoding> FromReq<Put<Encoding>, Request, E> for T
where Request: Req<E> + Send + 'static, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_req(req: Request) -> Result<T, E>

Attempts to deserialize the arguments from a request.
Source§

impl<E, Encoding, Response, T> FromRes<Patch<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Post<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
Source§

impl<E, Encoding, Response, T> FromRes<Put<Encoding>, Response, E> for T
where Response: ClientRes<E> + Send, Encoding: Decodes<T>, E: FromServerFnError,

Source§

async fn from_res(res: Response) -> Result<T, E>

Attempts to deserialize the outputs from a response.
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<E, T, Encoding, Request> IntoReq<Patch<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Post<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, T, Encoding, Request> IntoReq<Put<Encoding>, Request, E> for T
where Request: ClientReq<E>, Encoding: Encodes<T>, E: FromServerFnError,

Source§

fn into_req(self, path: &str, accepts: &str) -> Result<Request, E>

Attempts to serialize the arguments into an HTTP request.
Source§

impl<E, Response, Encoding, T> IntoRes<Patch<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Post<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<E, Response, Encoding, T> IntoRes<Put<Encoding>, Response, E> for T
where Response: TryRes<E>, Encoding: Encodes<T>, E: FromServerFnError + Send, T: Send,

Source§

async fn into_res(self) -> Result<Response, E>

Attempts to serialize the output into an HTTP response.
Source§

impl<T> SerializableKey for T

Source§

fn ser_key(&self) -> String

Serializes the key to a unique string. Read more
Source§

impl<T> StorageAccess<T> for T

Source§

fn as_borrowed(&self) -> &T

Borrows the value.
Source§

fn into_taken(self) -> T

Takes the value.
Source§

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

Source§

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

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.