Function use_route

pub fn use_route<R: Routable + Clone>() -> R

A hook that provides access to information about the current routing location.

The Routable macro will define a version of this hook with an explicit type.

Panic

• When the calling component is not nested within a Router component.

Example

#[derive(Clone, Routable)]
enum Route {
    #[route("/")]
    Index {},
}

#[component]
fn App() -> Element {
    rsx! {
        h1 { "App" }
        Router::<Route> {}
    }
}

#[component]
fn Index() -> Element {
    let path: Route = use_route();
    rsx! {
        h2 { "Current Path" }
        p { "{path}" }
    }
}