Struct SidebarState 

pub struct SidebarState { /* private fields */ }

Whether the sidebar is open, how wide it is, and how it collapses.

Shared by every page that shows the sidebar, so the width and the open state survive navigation. Edit it through its methods so the layout and the trigger observe the change.

Implementations

impl SidebarState

pub fn new(cx: &App) -> Self

An open sidebar at the theme’s sidebar width that narrows to a rail of icons when closed.

pub fn closed(self) -> Self

Starts closed.

pub fn with_width(self, width: Pixels) -> Self

Starts at width, clamped to the range.

pub fn with_width_range(self, range: Range<Pixels>) -> Self

The widths a drag can reach. The current width is clamped into it.

pub fn with_collapsible(self, collapsible: SidebarCollapsible) -> Self

How the sidebar closes.

pub fn with_icon_width(self, width: Pixels) -> Self

The width of the rail when collapsed to icons. The theme’s icon_sidebar_width unless set. A window whose rail sits under the macOS window controls gives it the theme’s window_controls_inset.

pub fn icon_width(&self) -> Pixels

The width of the rail when collapsed to icons.

pub fn is_open(&self) -> bool

Whether the sidebar is open. A sidebar that cannot collapse is always open beside the content; as a sheet it still opens and closes.

pub fn is_icon_only(&self) -> bool

Whether the sidebar is showing only icons: closed beside the content, and collapsing to icons. A sheet never shows icons.

pub fn is_sheet(&self) -> bool

Whether the sidebar floats over the content as a sheet, which the layout decides from the window width. A sheet starts closed, opens from the trigger, and closes from the trigger or a tap outside it.

pub fn width(&self) -> Pixels

The width the sidebar has when open.

pub fn width_range(&self) -> &Range<Pixels>

The widths a drag can reach.

pub fn collapsible(&self) -> SidebarCollapsible

How the sidebar closes.

pub fn is_resizing(&self) -> bool

Whether a drag on the handle is in progress.

pub fn set_open(&mut self, open: bool, cx: &mut Context<'_, Self>)

Opens or closes the sidebar: the sheet while the sidebar is one, the sidebar beside the content otherwise.

pub fn toggle(&mut self, cx: &mut Context<'_, Self>)

Closes an open sidebar and opens a closed one.

pub fn set_width(&mut self, width: Pixels, cx: &mut Context<'_, Self>)

Sets the width, clamped to the range.

pub fn set_icon_width(&mut self, width: Pixels, cx: &mut Context<'_, Self>)

Changes the width of the rail when collapsed to icons.

pub fn set_collapsible( &mut self, collapsible: SidebarCollapsible, cx: &mut Context<'_, Self>, )

Changes how the sidebar closes.

Trait Implementations

impl EventEmitter<SidebarEvent> for SidebarState