17 breaking releases

0.18.0 Sep 29, 2023
0.17.0 Nov 25, 2022
0.16.0 Dec 11, 2021
0.15.0 May 15, 2021
0.3.0 Jul 24, 2019

#823 in Web programming

Download history 4130/week @ 2023-12-14 2994/week @ 2023-12-21 2166/week @ 2023-12-28 5672/week @ 2024-01-04 4155/week @ 2024-01-11 4410/week @ 2024-01-18 3491/week @ 2024-01-25 3964/week @ 2024-02-01 4217/week @ 2024-02-08 4840/week @ 2024-02-15 4358/week @ 2024-02-22 4428/week @ 2024-02-29 4171/week @ 2024-03-07 3561/week @ 2024-03-14 4324/week @ 2024-03-21 3234/week @ 2024-03-28

15,873 downloads per month
Used in 26 crates (22 directly)

MIT/Apache

610KB
14K SLoC

yew-router

A routing library for the Yew frontend framework.

Read on how to use it on yew.rs


lib.rs:

Provides routing faculties using the browser history API to build Single Page Applications (SPAs) using Yew web framework.

Usage

use yew::functional::*;
use yew::prelude::*;
use yew_router::prelude::*;

#[derive(Debug, Clone, Copy, PartialEq, Routable)]
enum Route {
    #[at("/")]
    Home,
    #[at("/secure")]
    Secure,
    #[not_found]
    #[at("/404")]
    NotFound,
}

#[function_component(Secure)]
fn secure() -> Html {
    let navigator = use_navigator().unwrap();

    let onclick_callback = Callback::from(move |_| navigator.push(&Route::Home));
    html! {
        <div>
            <h1>{ "Secure" }</h1>
            <button onclick={onclick_callback}>{ "Go Home" }</button>
        </div>
    }
}

#[function_component(Main)]
fn app() -> Html {
    html! {
        <BrowserRouter>
            <Switch<Route> render={switch} />
        </BrowserRouter>
    }
}

fn switch(routes: Route) -> Html {
    match routes {
        Route::Home => html! { <h1>{ "Home" }</h1> },
        Route::Secure => html! {
            <Secure />
        },
        Route::NotFound => html! { <h1>{ "404" }</h1> },
    }
}

Internals

The router registers itself as a context provider and makes location information and navigator available via hooks or RouterScopeExt.

State

The Location API has a way to access / store state associated with session history. Please consult location.state() for detailed usage. A module that provides universal session history and location information. Prelude module to be imported when working with yew-router.

This module re-exports the frequently used types from the crate.

Dependencies

~12–16MB
~281K SLoC