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

Works with any context that has access to App (Context<V>, App, etc.)

Example

use gpui_navigator::Navigator;

// Navigate to a new route
Navigator::push(cx, "/users/123");

// Go back
Navigator::pop(cx);

// Replace current route
Navigator::replace(cx, "/login");

Implementations

impl Navigator

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

Get a NavigatorHandle for the given context

This allows chained navigation calls:

use gpui_navigator::Navigator;

// Chained style
Navigator::of(cx).push("/users");
Navigator::of(cx).pop();

// Or direct style (also works)
Navigator::push(cx, "/users");
Navigator::pop(cx);

pub fn push(cx: &mut impl BorrowAppContext, route: impl IntoRoute)

Navigate to a new path

Example

use gpui_navigator::{Navigator, PageRoute};

// Simple string path
Navigator::push(cx, "/users/123");

// With PageRoute and params
Navigator::push(cx, PageRoute::builder("/profile", |_, _cx, _params| gpui::div())
    .with_param("userId".into(), "456".into()));

pub fn replace(cx: &mut impl BorrowAppContext, route: impl IntoRoute)

Replace current path without adding to history

Example

use gpui_navigator::{Navigator, PageRoute};

// Simple string path
Navigator::replace(cx, "/login");

// With PageRoute
Navigator::replace(cx, PageRoute::builder("/login", |_, _cx, _params| gpui::div())
    .with_param("redirect".into(), "/dashboard".into()));

pub fn pop(cx: &mut impl BorrowAppContext)

Go back to the previous route

Example

use gpui_navigator::Navigator;

if Navigator::can_pop(cx) {
    Navigator::pop(cx);
}

pub fn back(cx: &mut impl BorrowAppContext)

Alias for pop() - go back (kept for compatibility)

pub fn forward(cx: &mut impl BorrowAppContext)

Go forward in history

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

Get current path

Works with Context<V> since it derefs to App

Example

use gpui_navigator::Navigator;

let path = Navigator::current_path(cx);

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

Check if can go back

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

Alias for can_pop() - check if can go back (kept for compatibility)

pub fn push_named( cx: &mut impl BorrowAppContext, name: &str, params: &RouteParams, )

Navigate to a named route with parameters

Example

use gpui_navigator::{Navigator, RouteParams};

let mut params = RouteParams::new();
params.set("id".into(), "123".into());

Navigator::push_named(cx, "user.detail", &params);

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

Generate URL for a named route

Example

use gpui_navigator::{Navigator, RouteParams};

let mut params = RouteParams::new();
params.set("id".into(), "123".into());

let url = Navigator::url_for(cx, "user.detail", &params);
assert_eq!(url, Some("/users/123".to_string()));

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

Check if can go forward

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

Available on crate feature transition only.

Set transition for the next navigation

The transition will be used for the next push/replace call, then automatically cleared.

Example

use gpui_navigator::{Navigator, Transition};

Navigator::set_next_transition(cx, Transition::fade(300));
Navigator::push(cx, "/page");

pub fn push_with_transition( cx: &mut impl BorrowAppContext, route: impl IntoRoute, transition: Transition, )

Available on crate feature transition only.

Navigate with a specific transition

Example

use gpui_navigator::{Navigator, Transition};

Navigator::push_with_transition(cx, "/page", Transition::slide_left(300));

pub fn replace_with_transition( cx: &mut impl BorrowAppContext, route: impl IntoRoute, transition: Transition, )

Available on crate feature transition only.

Replace with a specific transition

Example

use gpui_navigator::{Navigator, Transition};

Navigator::replace_with_transition(cx, "/page", Transition::fade(200));

pub fn push_named_with_transition( cx: &mut impl BorrowAppContext, name: &str, params: &RouteParams, transition: Transition, )

Available on crate feature transition only.

Push named route with a specific transition

Example

use gpui_navigator::{Navigator, RouteParams, Transition};

let mut params = RouteParams::new();
params.set("id".to_string(), "123".to_string());
Navigator::push_named_with_transition(
    cx,
    "user.detail",
    &params,
    Transition::slide_right(300)
);