Struct NavigationDrawer 

pub struct NavigationDrawer { /* private fields */ }

An M3 navigation drawer over caller-controlled selection and open state.

Implementations

impl NavigationDrawer

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

label is the navigation landmark’s accessible name.

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

The title-small headline above the destinations.

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

The destinations. Values must be unique.

pub fn section(self, before: usize, label: impl Into<SharedString>) -> Self

A section label above item before; sections after the first are separated by a middle-inset divider.

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

pub fn modal(self, modal: bool) -> Self

Float over the content with a scrim instead of sitting beside it.

pub fn open(self, open: bool) -> Self

Whether the drawer is shown (true by default).

pub fn dense(self, dense: bool) -> Self

48dp rows instead of 56dp.

pub fn position(self, position: DrawerPosition) -> Self

pub fn width(self, width: f32) -> Self

The sheet width in design px, clamped to 240–360dp.

pub fn icons(self, icons: bool) -> Self

Show destination icons (true by default).

pub fn ripple(self, ripple: bool) -> Self

Whether presses spread a ripple (on by default).

pub fn focus_on_open(self, focus: bool) -> Self

Whether opening a modal drawer moves focus to its selected destination (on by default). Turn it off when the drawer opens in response to typing elsewhere, such as a search field filtering its destinations.

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

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

A modal drawer’s Escape key and scrim click call this; without it the drawer is not dismissible.

Trait Implementations

impl IntoElement for NavigationDrawer

type Element = ViewElement<NavigationDrawer>

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 NavigationDrawer

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.