Struct Router 

pub struct Router { /* private fields */ }

A router instance. Clone to share across closures.

Not a global singleton — create one per navigation scope. Pass it through your UI builder or store it in context state.

Implementations

impl Router

pub fn push(&self, path: impl Into<String>)

Navigate to a path

pub fn replace(&self, path: impl Into<String>)

Replace current route (no history entry)

pub fn back(&self)

Go back

pub fn forward(&self)

Go forward

pub fn can_go_back(&self) -> bool

pub fn can_go_forward(&self) -> bool

pub fn current_path(&self) -> String

Get the current path

pub fn current_route(&self) -> Option<MatchedRoute>

Get the current matched route

pub fn params(&self) -> RouteParams

Get current route parameters

pub fn query(&self) -> QueryParams

Get current query parameters

pub fn has_route(&self, path: &str) -> bool

Check if a path matches any registered route

pub fn path_for(&self, name: &str) -> Option<String>

Get the path template for a named route

pub fn push_named(&self, name: &str, params: &[(&str, &str)])

Navigate to a named route with parameters

pub fn handle_deep_link(&self, uri: &str)

Handle a deep link URI from the platform.

Parses the URI and navigates to the extracted path. Call this from the platform runner when receiving a deep link.

pub fn register_back_handler(&self) -> BackHandlerHandle

Register this router as the handler for the system back button.

When back is pressed and the router can go back, it navigates back and consumes the event. Otherwise, the event propagates (app exit).

pub fn outlet(&self) -> Div

Build the current route’s view.

Pushes this router onto the context stack so use_router() returns this router inside views and child components.

When the route changes, the old view is dropped (its animations clean up automatically via AnimatedValue::drop). The new view is built fresh. Use inside a Stateful container with route signal deps for reactive updates.

Trait Implementations

impl Clone for Router

fn clone(&self) -> Router

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.