Struct yew_router::router::Router

pub struct Router<SW: Switch + Clone + 'static, STATE: RouterState = ()> { /* fields omitted */ }

Rendering control flow component.

Example

use yew::{prelude::*, virtual_dom::VNode};
use yew_router::{router::Router, Switch};

pub enum Msg {}

pub struct Model {}
impl Component for Model {
    //...

    fn view(&self) -> VNode {
        html! {
        <Router<S>
           render = Router::render(|switch: S| {
               match switch {
                   S::Variant => html!{"variant route was matched"},
               }
           })
        />
        }
    }
}

#[derive(Switch, Clone)]
enum S {
    #[to = "/v"]
    Variant,
}

Implementations

impl<SW, STATE> Router<SW, STATE> where
    STATE: RouterState,
    SW: Switch + Clone + 'static, 

pub fn render<F: RenderFn<Router<SW, STATE>, SW> + 'static>(
    f: F
) -> Render<SW, STATE>

Wrap a render closure so that it can be used by the Router.

Example

let render: Render<S> = Router::render(|switch: S| -> Html {
    match switch {
        S::Variant => html! {"Variant"},
    }
});

pub fn redirect<F: RedirectFn<SW, STATE> + 'static>(
    f: F
) -> Option<Redirect<SW, STATE>>

Wrap a redirect function so that it can be used by the Router.

Trait Implementations

impl<STATE, SW> Component for Router<SW, STATE> where
    STATE: RouterState,
    SW: Switch + Clone + 'static, 

type Message = Msg<STATE>

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 = Props<STATE, SW>

Properties are the inputs to a Component and should not mutated within a Component. They are passed to a Component using a JSX-style syntax. # use yew::{Html, Component, Properties, ComponentLink, html}; # struct Model; # #[derive(Clone, Properties)] # struct Props { # prop: String, # } # impl Component for Model { # type Message = ();type Properties = Props; # fn create(props: Self::Properties,link: ComponentLink<Self>) -> Self {unimplemented!()} # fn update(&mut self,msg: Self::Message) -> bool {unimplemented!()} # fn change(&mut self, _: Self::Properties) -> bool {unimplemented!()} # fn view(&self) -> Html { html! { <Model prop="value" /> } # }}

fn create(props: Self::Properties, link: ComponentLink<Self>) -> Self

Components are created with their properties as well as a ComponentLink which can be used to send messages and create callbacks for triggering updates.

fn update(&mut self, msg: Self::Message) -> ShouldRender

Components handle messages in their update method and commonly use this method to update their state and (optionally) re-render themselves.

fn change(&mut self, props: Self::Properties) -> ShouldRender

When the parent of a Component is re-rendered, it will either be re-created or receive new properties in the change lifecycle method. Component's can choose to re-render if the new properties are different than the previously received properties. Most Component's will use props with a PartialEq impl and will be implemented like this: # use yew::{Html, Component, ComponentLink, html, ShouldRender}; # struct Model{props: ()}; # impl Component for Model { # type Message = ();type Properties = (); # fn create(props: Self::Properties,link: ComponentLink<Self>) -> Self {unimplemented!()} # fn update(&mut self,msg: Self::Message) -> bool {unimplemented!()} # fn view(&self) -> Html {unimplemented!()} fn change(&mut self, props: Self::Properties) -> ShouldRender { if self.props != props { self.props = props; true } else { false } } # } Components which don't have properties should always return false.

fn view(&self) -> VNode

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 rendered(&mut self, _first_render: bool)

The rendered method is called after each time a Component is rendered but before the browser updates the page. ## Examples ```rust # use yew::{Html, Component, ComponentLink, html, ShouldRender}; # struct Model{props: ()}; # impl Model { fn setup_element(&self) { } } # impl Component for Model { # type Message = ();type Properties = (); # fn create(props: Self::Properties,link: ComponentLink) -> Self {unimplemented!()} # fn update(&mut self,msg: Self::Message) -> bool {unimplemented!()} # fn view(&self) -> Html {unimplemented!()} # fn change(&mut self, _props: Self::Properties) -> ShouldRender { unimplemented!() } fn rendered(&mut self, first_render: bool) { if first_render { self.setup_element(); // Similar to 'mounted' in other frameworks } } # }

fn destroy(&mut self)

The destroy method is called right before a Component is unmounted.

impl<SW: Debug + Switch + Clone + 'static, STATE: Debug + RouterState> Debug for Router<SW, STATE>

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

Formats the value using the given formatter.