Index

RBSidebarContainerView.h

Protocols

Classes


RBSidebarContainerView

Manages sidebars and a content view that can be swiped to reveal the sidebar(s).

Properties

A delegate to receive RBSidebarContainerView events.
public weak delegate RBSidebarContainerViewDelegate? { get set }

The mode describing the availability of the sidebars.
public mode RBSidebarContainerViewMode { get set }

The body content view.
public bodyView UIView? { get set }

The left sidebar view.
public leftSidebarView UIView? { get set }

The right sidebar view.
public rightSidebarView UIView? { get set }

Whether or not the sidebars can be opened with a swipe/pan gesture.
public swipeEnabled Bool { get set }

The amount of swipe that is required so that on release the sidebar will open/close.
public swipeMargin CGFloat { get set }

The RBAnimator object to use when animating.
public animator RBAnimator { get }

The current state of the left sidebar.
public leftSidebarState RBSidebarViewState { get }

Whether or not the left sidebar is currently visible.
public leftSidebarIsVisible Bool { get }

Whether or not the left sidebar is currently enabled.
public leftSidebarIsEnabled Bool { get }

Whether or not the left sidebar is currently expanded.
public leftSidebarIsExpanded Bool { get }

The current state of the right sidebar.
public rightSidebarState RBSidebarViewState { get }

Whether or not the right sidebar is currently visible.
public rightSidebarIsVisible Bool { get }

Whether or not the right sidebar is currently enabled.
public rightSidebarIsEnabled Bool { get }

Whether or not the right sidebar is currently expanded.
public rightSidebarIsExpanded Bool { get }

Whether or not to automatically pin the left sidebar if there would be sufficient body width.
public pinLeftSidebarIfSufficientWidth Bool { get set }

Whether or not to automatically pin the right sidebar if there would be sufficient body width.
public pinRightSidebarIfSufficientWidth Bool { get set }

Whether or not the left sidebar should be pinned before the right sidebar when there is sufficient body width.
public pinLeftSidebarBeforeRightSidebar Bool { get set }

The body width that is required with a bar open in order for it to be automatically pinned.
public desiredMinimumBodyWidth CGFloat { get set }

Functions

Opens the left sidebar.
@param animated : Whether or not the animation should be animated.
@param completion : An optional block to be called on completion.
- (void)openLeftSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion;

Opens the right sidebar.
@param animated : Whether or not the animation should be animated.
@param completion : An optional block to be called on completion.
- (void)openRightSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion;

Closes the sidebars.
@param animated : Whether or not the animation should be animated.
@param completion : An optional block to be called on completion.
- (void)closeSidebarsWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion;

Expands the left sidebar to occupy the full width. This will do nothing if the sidebar is not open or pinned.
@param animated : Whether or not the animation should be animated.
@param completion : An optional block to be called on completion.
- (void)expandLeftSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion;

Expands the right sidebar to occupy the full width. This will do nothing if the sidebar is not open or pinned.
@param animated : Whether or not the animation should be animated.
@param completion : An optional block to be called on completion.
- (void)expandRightSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion;

Collapse the currently extended sidebar.
@param animated : Whether or not the animation should be animated.
@param completion : An optional block to be called on completion.
- (void)collapseSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion;

Pins the left sidebar so that it remains open. The body content view is adjusted.
@param animated : Whether or not the animation should be animated.
@param completion : An optional block to be called on completion.
- (void)pinLeftSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion;

Unpins the left sidebar.
@param animated : Whether or not the animation should be animated.
@param completion : An optional block to be called on completion.
- (void)unpinLeftSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion;

Pins the right sidebar so that it remains open. The body content view is adjusted.
@param animated : Whether or not the animation should be animated.
@param completion : An optional block to be called on completion.
- (void)pinRightSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion;

Unpins the right sidebar.
@param animated : Whether or not the animation should be animated.
@param completion : An optional block to be called on completion.
- (void)unpinRightSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion;