Struct NavSection 

pub struct NavSection {
    pub id: String,
    pub title: String,
    pub collapsible: bool,
    pub collapsed: bool,
    pub trailing_action: Option<NavAction>,
    pub empty_caption: Option<String>,
    pub pending: u8,
    pub filterable: bool,
    pub editable_title: bool,
    pub menu: bool,
    pub items: Vec<NavItem>,
}

A group of destinations under a sentence-case title.

Fields

id: String

title: String

Sentence case (“Mailboxes”, “On this device”). An empty title draws no header: the items stand at the top level.

collapsible: bool

The person can fold the section away.

collapsed: bool

The section starts folded.

trailing_action: Option<NavAction>

A trailing action on the header (usually “New …” with Icon::Plus); reported through NavList::on_section_action.

empty_caption: Option<String>

The one quiet line the section shows while it has no items.

pending: u8

Rows standing in, while it has no items, for items still being read.

filterable: bool

The window’s filter narrows this section’s items.

editable_title: bool

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

menu: bool

The header has a menu (NavList::on_context_menu).

items: Vec<NavItem>

Implementations

impl NavSection

pub fn new( id: impl Into<String>, title: impl Into<String>, items: Vec<NavItem>, ) -> NavSection

pub fn untitled(id: impl Into<String>, items: Vec<NavItem>) -> NavSection

Items with no header above them.

pub fn collapsible(self) -> NavSection

pub fn collapsed(self) -> NavSection

Fold the section when it first appears (it stays foldable).

pub fn trailing_action(self, action: NavAction) -> NavSection

pub fn empty_caption(self, caption: impl Into<String>) -> NavSection

What the section says while it holds nothing (“No drafts”): one sentence, in tertiary ink, where its first row would be.

pub fn pending(self, rows: u8) -> NavSection

While the section has no items because they are still being read, rows rows stand in for them: the shape of a row (its icon and its label), in the skeleton tone, so nothing moves when the items arrive. They are not destinations: nothing selects them, the arrow keys pass over them, and assistive technology hears “Loading”.

pub fn filterable(self) -> NavSection

Let the window’s search narrow this section’s items: the window bar’s field, or a shell’s own super::NavShell::with_filter field. The section draws no field itself. Sections that do not opt in (a list of connections above the tables being filtered) stay as they are.

pub fn editable_title(self) -> NavSection

The person can rename the section in place: F2 on its header, or NavFeed::begin_rename from its menu.

pub fn with_menu(self) -> NavSection

The header asks for its menu as an item’s row does: a right click, a long press, the Menu key (NavList::on_context_menu, with the section’s id).

Trait Implementations

impl Clone for NavSection

fn clone(&self) -> NavSection

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for NavSection

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

Formats the value using the given formatter.

impl PartialEq for NavSection

fn eq(&self, other: &NavSection) -> 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 NavSection