Struct State 

pub struct State<Id> { /* private fields */ }

Available on crate feature sidebar only.

The navigation, the active item and how the sidebar is shown.

Implementations

impl<Id: Copy + PartialEq> State<Id>

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

An expanded sidebar with every group open and nothing active.

pub fn with_active(self, id: Id) -> Self

Starts with id active, opening its parent when it is a child.

pub fn with_rail(self, rail: bool) -> Self

Starts collapsed to the icon rail.

pub fn groups(&self) -> &[Group<Id>]

pub fn active(&self) -> Option<Id>

pub fn highlighted(&self) -> Option<Row<Id>>

pub fn is_rail(&self) -> bool

Whether the sidebar is set to collapse to a rail on wide windows.

pub fn is_compact(&self) -> bool

Whether the sidebar is drawn as a rail right now: collapsed on a wide window. The drawer always shows labels.

pub fn is_narrow(&self) -> bool

pub fn is_drawer_open(&self) -> bool

pub fn is_focused(&self) -> bool

pub fn shows_highlight(&self) -> bool

Whether the highlighted row gets a ring: while the sidebar has keys and the keyboard moved the highlight last.

pub fn has_keys(&self) -> bool

Whether the sidebar resolves its keymap: while focused or while the drawer is open.

pub fn is_group_open(&self, group: usize) -> bool

pub fn is_expanded(&self, id: Id) -> bool

pub fn item(&self, id: Id) -> Option<&Item<Id>>

pub fn parent_of(&self, id: Id) -> Option<Id>

The parent of a child item.

pub fn is_active_branch(&self, item: &Item<Id>) -> bool

Whether an item or one of its children is the active one, so a closed parent still shows where the page is.

pub fn rows(&self) -> Vec<Row<Id>>

The rows the keyboard moves through, in order: headings of collapsible groups and the enabled items that are showing.

pub fn update(&mut self, event: Event<Id>) -> Option<Output<Id>>

Applies an event and returns the activated item, if any.

pub fn shortcut( &self, keymap: &Keymap<Action>, key: &Event, ) -> Option<Event<Id>>

Turns a key press from keys::subscription into an event for the app-wide action, Action::ToggleRail. The sidebar resolves every other action itself while it has focus.

Trait Implementations

impl<Id: Clone> Clone for State<Id>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<Id: Debug> Debug for State<Id>

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

Formats the value using the given formatter.

impl<Id: PartialEq> PartialEq for State<Id>

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

Equality operator ==.

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

Inequality operator !=.

impl<Id: PartialEq> StructuralPartialEq for State<Id>