Struct SidebarItem 

pub struct SidebarItem { /* private fields */ }

A sidebar row with an icon, a label, an optional count or badge, actions and a submenu.

Implementations

impl SidebarItem

pub fn new(icon: IconName, label: impl Into<String>) -> Self

An item with this icon and label.

pub fn text(label: impl Into<String>) -> Self

An item with only a label, the usual entry of a submenu. Reduced to icons, its first letter stands in for the icon.

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

Highlights the item as the current location.

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

Dims the item and takes it out of clicks and of keyboard focus.

pub fn count(self, count: impl Into<String>) -> Self

A count badge at the end of the row (e.g. unread items). Reduced to icons, a dot on the icon stands for it, and screen readers read it.

pub fn badge(self, badge: Badge) -> Self

A Badge at the end of the row, treated like Self::count: for a tone or a word such as “New”.

pub fn shortcut(self, keys: impl Into<String>) -> Self

Shows the keys that do the same, at the end of the row.

pub fn compact(self) -> Self

A denser row (32 px, callout text) for panels with many items.

pub fn on_click(self, handler: impl Fn() + 'static) -> Self

Runs handler when the item is clicked.

pub fn action(self, action: impl View + 'static) -> Self

Adds a control at the end of the row, beside its button: usually a small IconButton with a label, or a DropdownMenu. Hidden when reduced to icons.

pub fn item(self, item: SidebarItem) -> Self

Adds a row to the submenu that unfolds under this one. Clicking this row folds and unfolds it; reduced to icons, clicking it opens the sidebar too.

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

Whether the submenu starts unfolded. By default, only if it holds the selected item.

pub fn expanded_binding(self, expanded: Binding<bool>) -> Self

Reads and writes whether the submenu is unfolded from the app.

Trait Implementations

impl Debug for SidebarItem

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl View for SidebarItem

fn build(&self, cx: &mut BuildCx<'_>) -> NodeId

Creates this view’s node for the current build.

fn type_name(&self) -> &'static str

The name the diagnostics panel shows this view’s cost under.