Struct Navigator 

pub struct Navigator;

Navigation API for convenient route navigation.

Provides static methods for navigation operations:

• Navigator::push(cx, "/path") — Navigate to a new page
• Navigator::pop(cx) — Go back to previous page
• Navigator::replace(cx, "/path") — Replace current page

All navigation methods run the full pipeline (guards, middleware).

Example

use gpui_navigator::Navigator;

Navigator::push(cx, "/users/123");
Navigator::pop(cx);
Navigator::replace(cx, "/login");

Implementations

impl Navigator

pub fn of<C: BorrowAppContext + BorrowMut<App>>( cx: &mut C, ) -> NavigatorHandle<'_, C>

Get a NavigatorHandle for chained navigation calls.

pub fn push( cx: &mut (impl BorrowAppContext + BorrowMut<App>), route: impl IntoRoute, )

Navigate to a new path.

pub fn replace( cx: &mut (impl BorrowAppContext + BorrowMut<App>), route: impl IntoRoute, )

Replace current path without adding to history.

pub fn push_with_state( cx: &mut (impl BorrowAppContext + BorrowMut<App>), route: impl IntoRoute, state: HistoryState, )

Push a new path with associated HistoryState data.

pub fn replace_with_state( cx: &mut (impl BorrowAppContext + BorrowMut<App>), route: impl IntoRoute, state: HistoryState, )

Replace current path with associated HistoryState data.

pub fn current_entry(cx: &App) -> HistoryEntry

Return the current HistoryEntry (path + optional state).

pub fn pop(cx: &mut (impl BorrowAppContext + BorrowMut<App>))

Go back to the previous route.

pub fn back(cx: &mut (impl BorrowAppContext + BorrowMut<App>))

Alias for pop.

pub fn forward(cx: &mut (impl BorrowAppContext + BorrowMut<App>))

Go forward in history.

pub fn current_path(cx: &App) -> String

Get current path.

pub fn can_pop(cx: &App) -> bool

Check if can go back.

pub fn can_go_back(cx: &App) -> bool

Alias for can_pop.

pub fn can_go_forward(cx: &App) -> bool

Check if can go forward.

pub fn push_named( cx: &mut (impl BorrowAppContext + BorrowMut<App>), name: &str, params: &RouteParams, )

Navigate to a named route with parameters.

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

Generate URL for a named route.

pub fn set_next_transition( cx: &mut impl BorrowAppContext, transition: Transition, )

Available on crate feature transition only.

Set transition for the next navigation.

pub fn push_with_transition( cx: &mut (impl BorrowAppContext + BorrowMut<App>), route: impl IntoRoute, transition: Transition, )

Available on crate feature transition only.

Navigate with a specific transition.

pub fn replace_with_transition( cx: &mut (impl BorrowAppContext + BorrowMut<App>), route: impl IntoRoute, transition: Transition, )

Available on crate feature transition only.

Replace with a specific transition.

pub fn push_named_with_transition( cx: &mut (impl BorrowAppContext + BorrowMut<App>), name: &str, params: &RouteParams, transition: Transition, )

Available on crate feature transition only.

Push named route with a specific transition.