Struct ContextProvider

pub struct ContextProvider<T: Clone + PartialEq + 'static> { /* private fields */ }

The context provider component.

Every child (direct or indirect) of this component may access the context value. In order to consume contexts, Scope::context method is used, In function components the use_context hook is used.

Trait Implementations

impl<T: Clone + PartialEq + 'static> Component for ContextProvider<T>

type Message = ()

Messages are used to make Components dynamic and interactive. Simple Component’s can declare their Message type to be (). Complex Component’s commonly use an enum to declare multiple Message types.

type Properties = ContextProviderProps<T>

The Component’s properties.

fn create(ctx: &Context<Self>) -> Self

Called when component is created.

fn changed(&mut self, ctx: &Context<Self>, old_props: &Self::Properties) -> bool

Called when properties passed to the component change

fn view(&self, ctx: &Context<Self>) -> Html

Components define their visual layout using a JSX-style syntax through the use of the html! procedural macro. The full guide to using the macro can be found in Yew’s documentation.

fn update(&mut self, ctx: &Context<Self>, msg: Self::Message) -> bool

Called when a new message is sent to the component via its scope.

fn rendered(&mut self, ctx: &Context<Self>, first_render: bool)

The rendered method is called after each time a Component is rendered but before the browser updates the page.

fn prepare_state(&self) -> Option<String>

Prepares the state during server side rendering.

fn destroy(&mut self, ctx: &Context<Self>)

Called right before a Component is unmounted.

impl<T: Debug + Clone + PartialEq + 'static> Debug for ContextProvider<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.