Struct ContextProvider 

pub struct ContextProvider;

ContextProvider is a component that provides a context to its children.

Once a context is provided, it can be accessed by the children using the UseContext hook.

Example

struct NumberOfTheDay(i32);

#[component]
fn MyContextConsumer(hooks: Hooks) -> impl Into<AnyElement<'static>> {
    let number = hooks.use_context::<NumberOfTheDay>();

    element! {
        View(border_style: BorderStyle::Round, border_color: Color::Cyan) {
            Text(content: "The number of the day is... ")
            Text(color: Color::Green, weight: Weight::Bold, content: number.0.to_string())
            Text(content: "!")
        }
    }
}

fn main() {
    element! {
        ContextProvider(value: Context::owned(NumberOfTheDay(42))) {
            MyContextConsumer
        }
    }
    .print();
}

Trait Implementations

impl Component for ContextProvider

type Props<'a> = ContextProviderProps<'a>

The type of properties that the component accepts.

fn new(_props: &Self::Props<'_>) -> Self

Creates a new instance of the component from a set of properties.

fn update( &mut self, props: &mut Self::Props<'_>, _hooks: Hooks<'_, '_>, updater: &mut ComponentUpdater<'_, '_, '_>, )

Invoked whenever the properties of the component or layout may have changed.

fn draw(&mut self, _drawer: &mut ComponentDrawer<'_>)

Invoked to draw the component.

fn poll_change(self: Pin<&mut Self>, _cx: &mut Context<'_>) -> Poll<()>

Invoked to determine whether a change has occurred that would require the component to be updated and redrawn.

impl Default for ContextProvider

fn default() -> ContextProvider

Returns the “default value” for a type.