Struct SideBarProviderState 

pub struct SideBarProviderState { /* private fields */ }

Manages the open/closed state of a side_bar_provider.

This state object must be created by the application and passed to the side_bar_provider. It is used to control the visibility of the side bar programmatically. Clone the handle freely to share it across UI parts.

Example

use tessera_ui_basic_components::side_bar::SideBarProviderState;

let state = SideBarProviderState::new();
assert!(!state.is_open()); // Initially closed
state.open();
assert!(state.is_open()); // Now open
state.close();
assert!(!state.is_open()); // Closed again

Implementations

impl SideBarProviderState

pub fn new() -> Self

Creates a new handle. Equivalent to Default::default().

pub fn open(&self)

Initiates the animation to open the side bar.

If the side bar is already open this has no effect. If it is currently closing, the animation will reverse direction and start opening from the current animated position.

pub fn close(&self)

Initiates the animation to close the side bar.

If the side bar is already closed this has no effect. If it is currently opening, the animation will reverse direction and start closing from the current animated position.

pub fn is_open(&self) -> bool

Returns whether the side bar is currently open.

pub fn is_animating(&self) -> bool

Returns whether the side bar is currently animating.

Trait Implementations

impl Clone for SideBarProviderState

fn clone(&self) -> SideBarProviderState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Default for SideBarProviderState

fn default() -> SideBarProviderState

Returns the “default value” for a type.