Struct Router

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

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, _: &Context<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 + PartialEq + 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 + PartialEq + 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>

The Component’s properties.

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

Called when component is created.

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

Called when a new message is sent to the component via it’s scope.

fn view(&self, ctx: &Context<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 changed(&mut self, ctx: &Context<Self>) -> bool

Called when properties passed to the component change

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 destroy(&mut self, ctx: &Context<Self>)

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.