Struct leptos::ProviderProps

source ·
pub struct ProviderProps<T>
where T: Clone + 'static,
{ pub value: T, pub children: Children, }
Expand description

Props for the Provider component.

Uses the context API to provide_context to its children and descendants, without overwriting any contexts of the same type in its own reactive scope.

This prevents issues related to “context shadowing.”

#[component]
pub fn App() -> impl IntoView {
    // each Provider will only provide the value to its children
    view! {
        <Provider value=1u8>
            // correctly gets 1 from context
            {use_context::<u8>().unwrap_or(0)}
        </Provider>
        <Provider value=2u8>
            // correctly gets 2 from context
            {use_context::<u8>().unwrap_or(0)}
        </Provider>
        // does not find any u8 in context
        {use_context::<u8>().unwrap_or(0)}
    }
}

§Required Props

  • value: [T]
    • The value to be provided via context.
  • children: Children

Fields§

§value: T

The value to be provided via context.

§children: Children

Implementations§

source§

impl<T> ProviderProps<T>
where T: Clone + 'static,

source

pub fn builder() -> ProviderPropsBuilder<T, ((), ())>

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

Trait Implementations§

source§

impl<T> IntoView for ProviderProps<T>
where T: Clone + 'static,

source§

fn into_view(self) -> View

Converts the value into View.

Auto Trait Implementations§

§

impl<T> Freeze for ProviderProps<T>
where T: Freeze,

§

impl<T> !RefUnwindSafe for ProviderProps<T>

§

impl<T> !Send for ProviderProps<T>

§

impl<T> !Sync for ProviderProps<T>

§

impl<T> Unpin for ProviderProps<T>
where T: Unpin,

§

impl<T> !UnwindSafe for ProviderProps<T>

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