Struct leptos::ShowProps

source ·
pub struct ShowProps<W>
where W: Fn() -> bool + 'static,
{ pub children: ChildrenFn, pub when: W, pub fallback: ViewFn, }
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.

The fallback prop is optional and defaults to rendering nothing.

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

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

§Required Props

  • children: ChildrenFn
    • The children will be shown whenever the condition in the when closure returns true.
  • when: [W]
    • A closure that returns a bool that determines whether this thing runs

§Optional Props

  • fallback: impl Into<ViewFn>
    • A closure that returns what gets rendered if the when statement is false. By default this is the empty view.

Fields§

§children: ChildrenFn

The children will be shown whenever the condition in the when closure returns true.

§when: W

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

§fallback: ViewFn

A closure that returns what gets rendered if the when statement is false. By default this is the empty view.

Implementations§

source§

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

source

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

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

Trait Implementations§

source§

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

source§

fn into_view(self) -> View

Converts the value into View.

Auto Trait Implementations§

§

impl<W> Freeze for ShowProps<W>
where W: Freeze,

§

impl<W> !RefUnwindSafe for ShowProps<W>

§

impl<W> !Send for ShowProps<W>

§

impl<W> !Sync for ShowProps<W>

§

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

§

impl<W> !UnwindSafe for ShowProps<W>

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