Struct NavRowFace 

pub struct NavRowFace<'a> {

    pub rect: Rect,
    pub label: &'a str,
    pub icon: Option<Icon>,
    pub count: Option<NavCount>,
    pub depth: usize,
    pub under_section: bool,
    pub disclosure: Option<bool>,
    pub state: SelectionState,
    pub focused: bool,
    pub actions: &'a [Icon],
    pub action_hover: Option<usize>,
    pub style: NavRowStyle,
    pub secondary: Option<&'a str>,
    pub meta: Option<&'a str>,
    pub status: Option<RowStatus<'a>>,
    pub status_label: Option<(&'a str, Tone)>,
    pub badge: Option<&'a str>,
    pub badge_column: Option<f64>,
    pub swatch: Option<AlphaColor<Srgb>>,
    pub avatar: Option<AvatarFace<'a>>,
    pub checked: Option<bool>,
    pub level: Option<f32>,
    pub presence: &'a [String],
}

Everything a navigation row shows. Build with NavRowFace::new and paint with paint_nav_row.

Fields

rect: Rect

The row’s full band, edge to edge of the list. The painter applies the list inset itself.

label: &'a str

icon: Option<Icon>

count: Option<NavCount>

depth: usize

Nesting level below the top level of its section.

under_section: bool

Quiet leading inset for destinations beneath a named section.

disclosure: Option<bool>

Some(expanded) when the row has children.

state: SelectionState

Selected (active), hovered, pressed.

focused: bool

Keyboard focus is on this row.

actions: &'a [Icon]

Trailing actions shown on hover or focus, in order. While they show, they take the place of the trailing parts.

action_hover: Option<usize>

The action under the pointer.

style: NavRowStyle

secondary: Option<&'a str>

One Caption line under the label (a host and port, a schedule).

meta: Option<&'a str>

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

status: Option<RowStatus<'a>>

A status dot at the trailing edge.

status_label: Option<(&'a str, Tone)>

A quiet tinted badge naming a state (“Active”).

badge: Option<&'a str>

A short leading code that classifies the row (GET).

badge_column: Option<f64>

The width of the badge column the row’s section shares; None sizes the column to this row’s own badge.

swatch: Option<AlphaColor<Srgb>>

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

avatar: Option<AvatarFace<'a>>

The person the row stands for (a participant in a call), as a small avatar in the icon’s place.

checked: Option<bool>

Some(checked): a checkbox in the leading slot. The whole row is its target.

level: Option<f32>

A usage bar under the text, 0.0..=1.0.

presence: &'a [String]

The people on this row’s place, by identity, each a mark in their presence colour.

Implementations

impl<'a> NavRowFace<'a>

pub fn new(rect: Rect, label: &'a str) -> NavRowFace<'a>

pub fn icon(self, icon: Icon) -> NavRowFace<'a>

pub fn count(self, count: NavCount) -> NavRowFace<'a>

pub fn under_section(self) -> NavRowFace<'a>

Give rows beneath a labelled section a quiet leading inset without changing tree depth, selection bounds or pointer targets.

pub fn depth(self, depth: usize) -> NavRowFace<'a>

pub fn disclosure(self, expanded: bool) -> NavRowFace<'a>

pub fn state(self, state: SelectionState) -> NavRowFace<'a>

pub fn selected(self, selected: bool) -> NavRowFace<'a>

pub fn hovered(self, hovered: bool) -> NavRowFace<'a>

pub fn focused(self, focused: bool) -> NavRowFace<'a>

pub fn actions( self, actions: &'a [Icon], hover: Option<usize>, ) -> NavRowFace<'a>

pub fn rail(self) -> NavRowFace<'a>

pub fn secondary(self, text: &'a str) -> NavRowFace<'a>

One Caption line under the label; it elides, never wraps.

pub fn meta(self, text: &'a str) -> NavRowFace<'a>

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

pub fn status(self, status: RowStatus<'a>) -> NavRowFace<'a>

A status dot at the trailing edge (a drive’s health, a connection).

pub fn status_label(self, label: &'a str, tone: Tone) -> NavRowFace<'a>

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

pub fn badge(self, code: &'a str) -> NavRowFace<'a>

A short leading code that classifies the row (an HTTP method). Pass the section’s nav_badge_column to Self::badge_column so the labels of its rows line up.

pub fn badge_column(self, width: f64) -> NavRowFace<'a>

The width of the badge column this row’s section shares.

pub fn swatch(self, color: AlphaColor<Srgb>) -> NavRowFace<'a>

The content colour the row stands for, in the icon’s place.

pub fn avatar(self, avatar: AvatarFace<'a>) -> NavRowFace<'a>

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

pub fn checked(self, checked: bool) -> NavRowFace<'a>

A checkbox in the leading slot, toggled by the whole row.

pub fn level(self, fraction: f32) -> NavRowFace<'a>

A usage bar under the text; fraction is clamped to 0..=1.

pub fn presence(self, identities: &'a [String]) -> NavRowFace<'a>

The people on this row’s place, by identity.

pub fn height(&self, theme: &Theme) -> f64

The height this row asks for in a list: nav_item_height.

Trait Implementations

impl<'a> Clone for NavRowFace<'a>

fn clone(&self) -> NavRowFace<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for NavRowFace<'a>

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

Formats the value using the given formatter.