Struct NavigationSuite 

pub struct NavigationSuite { /* private fields */ }

Adaptive navigation around caller-owned content.

The selection is controlled: report it through Self::on_change and pass it back with Self::selected. It survives a change of navigation, and so does keyboard focus, because all three forms share this element’s id and therefore their focus handles.

use gpui_kit_material::prelude::*;

let suite = NavigationSuite::new("suite", "Main")
    .items([
        NavItem::new("home", "Home", NavIcon::new("home", "home")),
        NavItem::new("mail", "Mail", NavIcon::new("mail", "mail")),
    ])
    .selected("home")
    .expanded_type(NavigationSuiteType::RailExpanded);

Implementations

impl NavigationSuite

pub fn new(id: impl Into<ElementId>, label: impl Into<SharedString>) -> Self

label is the navigation landmark’s accessible name.

pub fn items(self, items: impl IntoIterator<Item = NavItem>) -> Self

The destinations, shown by every form.

pub fn selected(self, value: impl Into<SharedString>) -> Self

The selected destination’s value.

pub fn layout_type(self, layout_type: Option<NavigationSuiteType>) -> Self

Fix the navigation, overriding the adaptive rule. None is adaptive.

pub fn size_class(self, size_class: Option<WindowSizeClass>) -> Self

Classify this size instead of the window’s: for a suite framed inside a larger window, as previews are. None reads the window.

pub fn expanded_from(self, from: Option<WindowWidthClass>) -> Self

The width class the navigation expands at (large by default). None never expands.

pub fn expanded_type(self, expanded_type: NavigationSuiteType) -> Self

What the expanded navigation is: NavigationSuiteType::Drawer by default, or NavigationSuiteType::RailExpanded as m3e defaults to.

pub fn navigation_hidden(self, hidden: bool) -> Self

Hide the navigation; the content takes the freed space. The change animates, and a hidden navigation cannot take focus.

pub fn primary_action(self, action: impl IntoElement) -> Self

The primary action, typically a FAB: floating above a bar, heading a rail, or first in a drawer. It stays above a hidden bar.

pub fn child(self, child: impl IntoElement) -> Self

Add to the content area, which fills the space the navigation leaves.

pub fn on_change( self, handler: impl Fn(&SharedString, &mut Window, &mut App) + 'static, ) -> Self

Called with a newly selected destination’s value.

pub fn on_type_change( self, handler: impl Fn(&NavigationSuiteType, &mut Window, &mut App) + 'static, ) -> Self

Called when the size or an option changes the navigation form.

Trait Implementations

impl IntoElement for NavigationSuite

type Element = ViewElement<NavigationSuite>

The specific type of element into which the implementing type is converted. Useful for converting other types into elements automatically, like Strings

fn into_element(self) -> Self::Element

Convert self into a type that implements [Element].

fn into_any_element(self) -> AnyElement

Convert self into a dynamically-typed [AnyElement].

impl RenderOnce for NavigationSuite

fn render(self, window: &mut Window, cx: &mut App) -> impl IntoElement

Render this component into an element tree. Note that this method takes ownership of self, as compared to [Render::render()] method which takes a mutable reference.