Struct Sidebar 

pub struct Sidebar<C, P = ()> { /* private fields */ }

A navigation column: Sidebar::new((SidebarSection::new("Workspace"), SidebarItem::new(...), ...)).

Its children scroll between an optional header and footer. With Self::collapsible it closes to icons or off the screen, by Cmd/Ctrl+B or a SidebarTrigger. With Self::narrow_below small windows show it as a sheet over the page.

use ravenrs_widgets::*;

let state = SidebarState::new(true);
let sidebar = Sidebar::new((
    SidebarGroup::new("Workspace", (
        SidebarItem::new(IconName::House, "Home").selected(true),
        SidebarItem::new(IconName::Users, "People").badge(Badge::new("3")),
    )),
))
.collapsible(SidebarCollapse::Icons)
.narrow_below(768.0)
.state(state.clone());
let trigger = SidebarTrigger::new(state);

Implementations

impl<C> Sidebar<C>

where C: ViewSeq,

pub fn new(children: C) -> Sidebar<C>

A sidebar of children, usually sections and items.

impl<C, P> Sidebar<C, P>

where C: ViewSeq,

pub fn width(self, width: f32) -> Sidebar<C, P>

Width in logical pixels (default 248).

pub fn collapsible(self, collapse: SidebarCollapse) -> Sidebar<C, P>

What it does when it closes (SidebarCollapse::Fixed by default). Rows, groups and scroll position that are not bound to app state start over after SidebarCollapse::Hidden, since nothing is built meanwhile.

pub fn variant(self, variant: SidebarVariant) -> Sidebar<C, P>

How it sits next to the page (SidebarVariant::Standard by default).

pub fn side(self, side: Side) -> Sidebar<C, P>

The window edge it belongs to (Side::Left by default). Place it on that side of the page yourself; this sets its hairline, the side of its tooltips and where its sheet comes from.

pub fn narrow_below(self, width: f32) -> Sidebar<C, P>

Below this window width, in logical pixels, it takes no room and opens as a sheet over the page. It goes by the window, not by its container.

pub fn shortcut(self, enabled: bool) -> Sidebar<C, P>

Whether Cmd/Ctrl+B toggles it, if it can close (on by default). Turn it off when a window has more than one sidebar, or the app uses that key.

pub fn rail(self, rail: bool) -> Sidebar<C, P>

A strip along its inner edge that opens and closes it with a click, for a sidebar that can close.

pub fn label(self, label: impl Into<String>) -> Sidebar<C, P>

The name screen readers announce for this landmark (the navigation word of Labels by default).

impl<C, P> Sidebar<C, P>

where C: ViewSeq, P: Into<SidebarParts>,

pub fn state(self, state: SidebarState) -> Sidebar<C, SidebarParts>

Shares whether it is open with a SidebarTrigger or the app. Without this it starts open and keeps the state itself.

pub fn header(self, header: impl View + 'static) -> Sidebar<C, SidebarParts>

A view above the content that does not scroll. Reduced to icons, it keeps its layout and shows what fits, so start it with an icon.

pub fn footer(self, footer: impl View + 'static) -> Sidebar<C, SidebarParts>

A view below the content that does not scroll, treated like the header.

Trait Implementations

impl<C, P> Debug for Sidebar<C, P>

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

Formats the value using the given formatter.

impl<C> View for Sidebar<C>

where C: ViewSeq,

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.

impl<C> View for Sidebar<C, SidebarParts>

where C: ViewSeq,

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.