Struct NavItem 

pub struct NavItem {

    pub id: String,
    pub label: String,
    pub icon: Option<Icon>,
    pub count: Option<NavCount>,
    pub actions: bool,
    pub children: Vec<NavItem>,
    pub expanded: bool,
    pub ensure_expanded: bool,
    pub drop_target: bool,
    pub editable_label: bool,
    pub secondary: Option<String>,
    pub meta: Option<String>,
    pub status: Option<NavItemStatus>,
    pub status_label: Option<(String, Tone)>,
    pub badge: Option<String>,
    pub swatch: Option<AlphaColor<Srgb>>,
    pub art: Option<NavArt>,
    pub checked: Option<bool>,
    pub level: Option<f32>,
    pub presence: Vec<String>,
    pub person: Option<NavPerson>,
    pub unread: bool,
    pub semantic_key: Option<String>,
    pub search_terms: Vec<NavSearchTerm>,
}

One destination. Every part but the label is optional.

Fields

id: String

Stable across rebuilds; selection, expansion and focus follow it.

label: String

icon: Option<Icon>

count: Option<NavCount>

actions: bool

Show the list’s item actions (NavList::item_actions) on this row on hover and focus.

children: Vec<NavItem>

Nested destinations, indented one step.

expanded: bool

Starts expanded (only meaningful with children).

ensure_expanded: bool

Opens even where the person folded it (the place the app just revealed).

drop_target: bool

Other items may be dragged into this one (NavList::on_move).

editable_label: bool

The label can be renamed in place (NavList::on_rename_action).

secondary: Option<String>

meta: Option<String>

status: Option<NavItemStatus>

status_label: Option<(String, Tone)>

badge: Option<String>

swatch: Option<AlphaColor<Srgb>>

art: Option<NavArt>

A picture in the icon’s place (an album’s cover).

checked: Option<bool>

level: Option<f32>

presence: Vec<String>

person: Option<NavPerson>

The person the row stands for, as their avatar in the icon’s place.

unread: bool

Something new waits behind the row (an unread conversation).

semantic_key: Option<String>

The key assistive technology and tests address the row by; the default is nav:item:{id}.

search_terms: Vec<NavSearchTerm>

What else the row is found by when the list is filtered: the things the destination holds (“Tap to click” on a touchpad page) and the words people use for them. A row found by a term that has a name shows that name under its label.

Implementations

impl NavItem

pub fn new(id: impl Into<String>, label: impl Into<String>) -> NavItem

pub fn search_terms( self, terms: impl IntoIterator<Item = NavSearchTerm>, ) -> NavItem

Also found, when the list is filtered, by terms: what the destination holds and the words people use for it.

pub fn icon(self, icon: Icon) -> NavItem

pub fn count(self, count: u32) -> NavItem

A quiet count (items in a folder). Zero shows nothing: a count means something wants attention, and nothing does.

pub fn live_count(self, count: u32) -> NavItem

A count that wants attention (unread, mentions): the list’s one filled badge, in the person’s colour. Zero shows nothing.

pub fn children(self, children: Vec<NavItem>) -> NavItem

pub fn expanded(self) -> NavItem

pub fn ensure_expanded(self) -> NavItem

Open this item whenever the sections are handed over, even where the person folded it: the place the app is revealing (the database a connection just opened).

pub fn drop_target(self) -> NavItem

pub fn editable_label(self) -> NavItem

pub fn without_actions(self) -> NavItem

This row offers none of the list’s item actions.

pub fn secondary(self, text: impl Into<String>) -> NavItem

One Caption line under the label (a host and port, a schedule). It elides; the row grows to hold it.

pub fn meta(self, text: impl Into<String>) -> NavItem

A tertiary figure at the trailing edge (a size).

pub fn status(self, status: RowStatus<'_>) -> NavItem

A status dot at the trailing edge: a drive’s health, a connection’s state, an account that needs attention, a person’s presence.

pub fn status_label(self, label: impl Into<String>, tone: Tone) -> NavItem

A quiet tinted badge naming the row’s state (“Active”).

pub fn badge(self, code: impl Into<String>) -> NavItem

A short leading code that classifies the row (GET, POST). The codes of one section share a column, so their labels line up.

pub fn swatch(self, color: AlphaColor<Srgb>) -> NavItem

The content colour the row stands for (a calendar, a project), in the icon’s place.

pub fn art(self, name: impl Into<String>, image: Option<ImageData>) -> NavItem

A small rounded picture in the icon’s place: what the destination holds (an album’s cover), or the initials of name while it has none. The label lines up with the icons of the rows around it.

pub fn checked(self, checked: bool) -> NavItem

A checkbox in the leading slot (a calendar shown or hidden). The whole row toggles it and reports through NavList::on_check_action; a checkable row is not a destination and is never selected.

pub fn level(self, fraction: f32) -> NavItem

A usage bar under the label, fraction of it filled (a backup destination’s space).

pub fn presence(self, identity: impl Into<String>) -> NavItem

Someone is on this place: a mark in their presence colour. Call once per person.

pub fn person( self, identity: impl Into<String>, colour: Option<AlphaColor<Srgb>>, speaking: bool, ) -> NavItem

The row stands for a person (someone in a call): their avatar, in colour, in the icon’s place, ringed while speaking. With no colour, the avatar takes the colour their identity carries, as every face of them does.

pub fn person_face( self, name: impl Into<String>, image: Option<ImageData>, ) -> NavItem

The face of the person the row stands for (Self::person): the name their initials come from and their picture.

pub fn unread(self, unread: bool) -> NavItem

Something new waits behind the row: its label stands out at rest.

pub fn semantic_key(self, key: impl Into<String>) -> NavItem

The key assistive technology, agents and tests address the row by.

Trait Implementations

impl Clone for NavItem

fn clone(&self) -> NavItem

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NavItem

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

Formats the value using the given formatter.

impl From<NavItemProps> for NavItem

fn from(props: NavItemProps) -> NavItem

Converts to this type from the input type.

impl PartialEq for NavItem

fn eq(&self, other: &NavItem) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for NavItem