Struct Navigator 

pub struct Navigator { /* private fields */ }

A navigation stack that manages screen transitions.

The navigator is generic over the app state type and can be integrated into any GPUI application.

Example

use gpui_nav::Navigator;

pub struct AppState {
    navigator: Navigator,
    // ... other state
}

Implementations

impl Navigator

pub fn new() -> Self

Creates a new empty navigator.

Example

use gpui_nav::Navigator;

let navigator = Navigator::new();
assert!(navigator.is_empty());

pub fn push<S: Screen, T: 'static>( &mut self, screen: S, cx: &mut Context<'_, T>, )

Pushes a new screen onto the navigation stack.

The screen’s on_enter method will be called if implemented. This method is generic over the context type, allowing it to work with any app state.

Example

// In your app state method:
pub fn navigator_push<S: Screen>(&mut self, screen: S, cx: &mut Context<Self>) {
    self.navigator.push(screen, cx);
}

pub fn pop<T: 'static>(&mut self, cx: &mut Context<'_, T>) -> bool

Pops the current screen from the stack.

Returns true if a screen was popped, false if the stack has only one screen.

Example

if navigator.pop(cx) {
    println!("Navigated back");
} else {
    println!("Already at root screen");
}

pub fn replace<S: Screen, T: 'static>( &mut self, screen: S, cx: &mut Context<'_, T>, ) -> bool

Replaces the current screen with a new one.

Returns true if a screen was replaced, false if the stack is empty.

Example

if navigator.replace(LoginScreen::new(ctx), cx) {
    println!("Screen replaced");
} else {
    println!("No screen to replace, stack is empty");
}

pub fn current(&self) -> Option<&AnyView>

Returns a reference to the current screen, if any.

pub fn history(&self) -> &[&'static str]

Returns the navigation history as screen IDs.

pub fn clear_and_push<S: Screen, T: 'static>( &mut self, screen: S, cx: &mut Context<'_, T>, )

Clears the entire stack and pushes a new root screen.

Useful for logout flows or resetting the app state.

pub fn can_go_back(&self) -> bool

Returns whether the navigator can go back.

pub fn len(&self) -> usize

Returns the number of screens in the stack.

pub fn is_empty(&self) -> bool

Returns whether the navigation stack is empty.

Trait Implementations

impl Default for Navigator

fn default() -> Self

Returns the “default value” for a type.