Struct GlobalRouter 

pub struct GlobalRouter { /* private fields */ }

Global router state accessible from any component

Implementations

impl GlobalRouter

pub fn new() -> Self

Create a new global router

pub fn add_route(&mut self, route: Route)

Register a route

pub fn push_named( &mut self, name: &str, params: &RouteParams, ) -> Option<RouteChangeEvent>

Navigate to a named route with parameters

pub fn url_for(&self, name: &str, params: &RouteParams) -> Option<String>

Generate URL for a named route

pub fn push(&mut self, path: String) -> RouteChangeEvent

Navigate to a path

pub fn replace(&mut self, path: String) -> RouteChangeEvent

Replace current path

pub fn back(&mut self) -> Option<RouteChangeEvent>

Go back

pub fn forward(&mut self) -> Option<RouteChangeEvent>

Go forward

pub fn current_path(&self) -> &str

Get current path

pub fn current_match(&mut self) -> Option<RouteMatch>

Get current route match (with caching, requires mutable)

pub fn current_match_immutable(&self) -> Option<RouteMatch>

Get current route match (immutable, no caching)

Use this from Render implementations and other immutable contexts

pub fn current_route(&self) -> Option<&Arc<Route>>

Get the current matched Route

Returns the shared Arc<Route> that matched the current path. Useful for accessing the route’s children and builder without cloning.

pub fn can_go_back(&self) -> bool

Check if can go back

pub fn can_go_forward(&self) -> bool

Check if can go forward

pub fn state_mut(&mut self) -> &mut RouterState

Get mutable state reference

pub fn state(&self) -> &RouterState

Get state reference

pub fn nested_cache_mut(&mut self) -> &mut RouteCache

Available on crate feature cache only.

Get nested route cache (mutable)

pub fn cache_stats(&self) -> &CacheStats

Available on crate feature cache only.

Get nested route cache statistics

pub fn set_next_transition(&mut self, transition: Transition)

Available on crate feature transition only.

Set transition for the next navigation

This override will be used for the next push/replace operation, then automatically cleared.

Example

use gpui_navigator::{GlobalRouter, Transition};

cx.update_global::<GlobalRouter, _>(|router, _| {
    router.set_next_transition(Transition::fade(300));
    router.push("/page".to_string());
});

pub fn take_next_transition(&mut self) -> Option<Transition>

Available on crate feature transition only.

Get and consume the next transition override

Returns the transition override if set, and clears it. Used internally by navigation methods.

pub fn has_next_transition(&self) -> bool

Available on crate feature transition only.

Check if there’s a transition override set

pub fn clear_next_transition(&mut self)

Available on crate feature transition only.

Clear transition override without consuming it

pub fn push_with_transition( &mut self, path: String, transition: Transition, ) -> RouteChangeEvent

Available on crate feature transition only.

Navigate with a specific transition

Convenience method that sets the transition and navigates in one call.

Example

use gpui_navigator::{GlobalRouter, Transition};

cx.update_global::<GlobalRouter, _>(|router, _| {
    router.push_with_transition("/page".to_string(), Transition::slide_left(300));
});

pub fn replace_with_transition( &mut self, path: String, transition: Transition, ) -> RouteChangeEvent

Available on crate feature transition only.

Replace with a specific transition

Trait Implementations

impl Clone for GlobalRouter

fn clone(&self) -> GlobalRouter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for GlobalRouter

fn default() -> Self

Returns the “default value” for a type.

impl Global for GlobalRouter