Struct leptos::ShowProps

source ·
pub struct ShowProps<F, W, IV>where
    W: Fn() -> bool + 'static,
    F: Fn(Scope) -> IV + 'static,
    IV: IntoView,{
    pub children: Box<dyn Fn(Scope) -> Fragment>,
    pub when: W,
    pub fallback: F,
}
Expand description

Props for the Show component.

A component that will show its children when the when condition is true, and show the fallback when it is false, without rerendering every time the condition changes.

Note: Because of the nature of generic arguments, it’s not really possible to make the fallback optional. If you want an empty fallback state—in other words, if you want to show the children if when is true and noting otherwise—use fallback=|_| () (i.e., a fallback function that returns the unit type ()).

let (value, set_value) = create_signal(cx, 0);

view! { cx,
  <Show
    when=move || value() < 5
    fallback=|cx| view! { cx, "Big number!" }
  >
    "Small number!"
  </Show>
}

Required Props

  • cx: Scope
    • The scope the component is running in
  • children: [Box<dyn Fn(Scope) -> Fragment>]
    • The components Show wraps
  • when: [W]
    • A closure that returns a bool that determines whether this thing runs
  • fallback: [F]
    • A closure that returns what gets rendered if the when statement is false

Fields§

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

The components Show wraps

§when: W

A closure that returns a bool that determines whether this thing runs

§fallback: F

A closure that returns what gets rendered if the when statement is false

Implementations§

source§

impl<F, W, IV> ShowProps<F, W, IV>where W: Fn() -> bool + 'static, F: Fn(Scope) -> IV + 'static, IV: IntoView,

source

pub fn builder() -> ShowPropsBuilder<F, W, IV, ((), (), ())>

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

Auto Trait Implementations§

§

impl<F, W, IV> !RefUnwindSafe for ShowProps<F, W, IV>

§

impl<F, W, IV> !Send for ShowProps<F, W, IV>

§

impl<F, W, IV> !Sync for ShowProps<F, W, IV>

§

impl<F, W, IV> Unpin for ShowProps<F, W, IV>where F: Unpin, W: Unpin,

§

impl<F, W, IV> !UnwindSafe for ShowProps<F, W, IV>

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