Struct UseAuthentication 

pub struct UseAuthentication<C>
where
    C: BaseComponent,
    C::Properties: UseAuthenticationProperties,
{ /* private fields */ }

A component which injects the authentication into the properties of component.

The component’s properties must implement the trait UseAuthenticationProperties.

Example

use yew_oauth2::prelude::*;
use yew::prelude::*;

#[derive(Clone, Debug, PartialEq, Properties)]
pub struct Props {
   #[prop_or_default]
   pub auth: Option<Authentication>,
}

impl UseAuthenticationProperties for Props {
   fn set_authentication(&mut self, auth: Authentication) {
       self.auth = Some(auth);
   }
}

#[function_component(ViewUseAuth)]
pub fn view_use_auth(props: &Props) -> Html {
    html!(
        <>
            <h2> { "Use authentication example"} </h2>
            <code><pre>{ format!("Auth: {:?}", props.auth) }</pre></code>
        </>
    )
}

Trait Implementations

impl<C> BaseComponent for UseAuthentication<C>

where C: BaseComponent + 'static, C::Properties: UseAuthenticationProperties, Self: 'static,

type Message = ()

The Component’s Message.

type Properties = UseAuthenticationComponentProperties<C>

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<C> Debug for UseAuthentication<C>

where C: BaseComponent, C::Properties: UseAuthenticationProperties,

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

Formats the value using the given formatter.

impl<C> FunctionProvider for UseAuthentication<C>

where C: BaseComponent, C::Properties: UseAuthenticationProperties,

type Properties = UseAuthenticationComponentProperties<C>

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.