Struct Menu 

pub struct Menu<Msg> { /* private fields */ }

The navigation column of an application: groups of destinations under faint headings.

With no options it is the plainest menu: the selected item is raised with the accent pillar, a hovered item rises softly, and the icon and label of both slide one cell while badges stay anchored. It is usually the content of an AppShell sidebar.

Keys while focused move a cursor, drawn like hover, without leaving the current page: ↑/↓, Home/End, and typing a letter jumps to the next item starting with it. Enter or Space opens the item under the cursor; a click opens at once. The application owns the selection. There is only ever one such highlight: moving the pointer onto a row moves the cursor there, and the keyboard continues from it.

collapsible lets groups with a title fold: the heading gets a chevron, a click or Enter on it toggles, → opens and ← closes it, and ← on an item goes to its heading. A foldable heading rises and slides its title like an item; its chevron stays anchored.

Style keys: menu-item with hover, selected, focus, pressed; menu-badge with the same states; menu-heading with hover; scrollbar.

Implementations

impl<Msg: 'static> Menu<Msg>

pub fn new(groups: impl IntoIterator<Item = MenuGroup>) -> Self

A menu of groups.

pub fn selected(self, key: Option<&str>) -> Self

The key of the current item.

pub fn on_select(self, message: impl Fn(&str) -> Msg + 'static) -> Self

Message for opening the item with key.

pub fn collapsible(self, message: impl Fn(&str, bool) -> Msg + 'static) -> Self

Lets titled groups fold: message(group, open) asks the application to open or close a group. Pass the closed groups with collapsed.

pub fn collapsed( self, groups: impl IntoIterator<Item = impl Into<String>>, ) -> Self

Keys of the groups that are closed in a collapsible menu.

Trait Implementations

impl<Msg: 'static> Widget<Msg> for Menu<Msg>

fn measure(&self, _cx: &mut MeasureCx<'_>, available: Size) -> Size

The size the widget wants when it may use up to available.

fn paint(&self, cx: &mut PaintCx<'_>, area: Rect)

Draws the widget into area.

fn event(&self, cx: &mut EventCx<'_, Msg>, event: &Event) -> bool

Handles input. Returns true when the event was used; unused key and scroll events bubble to the parent widget.

fn focusable(&self) -> bool

Whether the widget can take keyboard focus.

fn paint_overlay(&self, _cx: &mut PaintCx<'_>, _anchor: Rect)

Draws the widget’s overlay after the whole view was painted, when it asked for one with PaintCx::request_overlay. anchor is the area the widget was painted in.

fn children(&self) -> &[Node<Msg>]

Child nodes, for widgets that contain other widgets.

fn children_mut(&mut self) -> &mut [Node<Msg>]

Mutable child nodes, used to assign ids.