Function use_route

pub fn use_route<'hook, R>() -> impl 'hook + Hook<Output = Option<R>>
where
    R: Routable + 'static + 'hook,

A hook to access the current route.

This hook will return None if there’s no available location or none of the routes match.

Note

If your Routable has a #[not_found] route, you can use .unwrap_or_default() instead of .unwrap() to unwrap.

Note

When used in function components and hooks, this hook is equivalent to:

/// A hook to access the current route.
///
/// This hook will return [`None`] if there's no available location or none of the routes match.
///
/// # Note
///
/// If your `Routable` has a `#[not_found]` route, you can use `.unwrap_or_default()` instead of
/// `.unwrap()` to unwrap.
pub fn use_route<R>() -> Option<R>
where
    R: Routable + 'static,
{
    /* implementation omitted */
}