Struct yew_notifications::NotificationsProvider

pub struct NotificationsProvider<N: Notifiable + PartialEq + Clone, F: NotifiableComponentFactory<N> + PartialEq + Clone> { /* private fields */ }

The notification provider component.

Every child (direct or indirect) of this component can use use_notification hook to spawn new notifications. N - type of the notification. F - notification factory type.

Example

let component_creator = NotificationFactory::default();

html! {
    <NotificationsProvider<Notification, NotificationFactory> {component_creator}>
        <MyComponent />
    </NotificationsProvider<Notification, NotificationFactory>>
}

Trait Implementations

impl<N, F> BaseComponent for NotificationsProvider<N, F>

where N: 'static + Notifiable + PartialEq + Clone, F: 'static + NotifiableComponentFactory<N> + PartialEq + Clone, Self: 'static,

type Message = ()

The Component’s Message.

type Properties = NotificationsProviderProps<N, F>

The Component’s Properties.

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

Creates a component.

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

Updates component’s internal state.

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

React to changes of component properties.

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

Returns a component layout to be rendered.

fn rendered(&mut self, _ctx: &Context<Self>, _first_render: bool)

Notified after a layout is rendered.

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

Notified before a component is destroyed.

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

Prepares the server-side state.

impl<N: Notifiable + PartialEq + Clone, F: NotifiableComponentFactory<N> + PartialEq + Clone> Debug for NotificationsProvider<N, F>

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

Formats the value using the given formatter.

impl<N: Notifiable + PartialEq + Clone, F: NotifiableComponentFactory<N> + PartialEq + Clone> FunctionProvider for NotificationsProvider<N, F>

type Properties = NotificationsProviderProps<N, F>

Properties for the Function Component.

fn run(ctx: &mut HookContext, props: &Self::Properties) -> HtmlResult

Render the component. This function returns the Html to be rendered for the component.