Struct RouterOutlet 

pub struct RouterOutlet { /* private fields */ }

RouterOutlet component that renders the active child route

RouterOutlet is a special element that dynamically renders child routes based on the current route match. It accesses the GlobalRouter to resolve which child should be displayed.

Example

use gpui_navigator::{Route, RouterOutlet, RouteParams};
use gpui::*;

// Parent layout component
fn dashboard_layout(_cx: &mut App, _params: &RouteParams) -> AnyElement {
    div()
        .child("Dashboard Header")
        .child(RouterOutlet::new()) // Child routes render here
        .into_any_element()
}

// Configure nested routes
Route::new("/dashboard", dashboard_layout)
    .children(vec![
        Route::new("overview", |_, _cx, _params| div().into_any_element()),
        Route::new("settings", |_, _cx, _params| div().into_any_element()),
    ]);

Implementations

impl RouterOutlet

pub fn new() -> Self

Create a new default outlet

pub fn named(name: impl Into<String>) -> Self

Create a named outlet

Named outlets allow multiple outlet locations in a single parent route.

Example

use gpui_navigator::{RouterOutlet, RouteParams};
use gpui::*;

// Parent layout with multiple outlets
fn app_layout(_cx: &mut App, _params: &RouteParams) -> AnyElement {
    div()
        .child(RouterOutlet::new()) // Main content
        .child(RouterOutlet::named("sidebar")) // Sidebar content
        .into_any_element()
}

Trait Implementations

impl Clone for RouterOutlet

fn clone(&self) -> RouterOutlet

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for RouterOutlet

fn default() -> Self

Returns the “default value” for a type.

impl Render for RouterOutlet

fn render( &mut self, window: &mut Window, cx: &mut Context<'_, Self>, ) -> impl IntoElement

Render this view into an element tree.