RBSidebarContainerView Class Reference

Inherits from UIView
Conforms to UIGestureRecognizerDelegate
Declared in RBSidebarContainerView.h

Overview

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

  delegate

A delegate to receive RBSidebarContainerView events.

@property (nonatomic, weak, nullable) id<RBSidebarContainerViewDelegate> delegate

Declared In

RBSidebarContainerView.h

  mode

The mode describing the availability of the sidebars.

@property (nonatomic) RBSidebarContainerViewMode mode

Declared In

RBSidebarContainerView.h

  bodyView

The body content view.

@property (nonatomic, nullable) UIView *bodyView

Declared In

RBSidebarContainerView.h

  leftSidebarView

The left sidebar view.

@property (nonatomic, nullable) UIView *leftSidebarView

Declared In

RBSidebarContainerView.h

  rightSidebarView

The right sidebar view.

@property (nonatomic, nullable) UIView *rightSidebarView

Declared In

RBSidebarContainerView.h

  swipeEnabled

Whether or not the sidebars can be opened with a swipe/pan gesture.

@property (nonatomic) BOOL swipeEnabled

Declared In

RBSidebarContainerView.h

  swipeMargin

The amount of swipe that is required so that on release the sidebar will open/close.

@property (nonatomic) CGFloat swipeMargin

Declared In

RBSidebarContainerView.h

  animator

The RBAnimator object to use when animating.

@property (nonatomic, readonly, nonnull) RBAnimator *animator

Declared In

RBSidebarContainerView.h

  leftSidebarState

The current state of the left sidebar.

@property (nonatomic, readonly) RBSidebarViewState leftSidebarState

Declared In

RBSidebarContainerView.h

  leftSidebarIsVisible

Whether or not the left sidebar is currently visible.

@property (nonatomic, readonly) BOOL leftSidebarIsVisible

Declared In

RBSidebarContainerView.h

  leftSidebarIsEnabled

Whether or not the left sidebar is currently enabled.

@property (nonatomic, readonly) BOOL leftSidebarIsEnabled

Declared In

RBSidebarContainerView.h

  leftSidebarIsExpanded

Whether or not the left sidebar is currently expanded.

@property (nonatomic, readonly) BOOL leftSidebarIsExpanded

Declared In

RBSidebarContainerView.h

  rightSidebarState

The current state of the right sidebar.

@property (nonatomic, readonly) RBSidebarViewState rightSidebarState

Declared In

RBSidebarContainerView.h

  rightSidebarIsVisible

Whether or not the right sidebar is currently visible.

@property (nonatomic, readonly) BOOL rightSidebarIsVisible

Declared In

RBSidebarContainerView.h

  rightSidebarIsEnabled

Whether or not the right sidebar is currently enabled.

@property (nonatomic, readonly) BOOL rightSidebarIsEnabled

Declared In

RBSidebarContainerView.h

  rightSidebarIsExpanded

Whether or not the right sidebar is currently expanded.

@property (nonatomic, readonly) BOOL rightSidebarIsExpanded

Declared In

RBSidebarContainerView.h

– openLeftSidebarWithAnimation:completion:

Opens the left sidebar.

- (void)openLeftSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion

Parameters

animated

Whether or not the animation should be animated.

completion

An optional block to be called on completion.

Declared In

RBSidebarContainerView.h

– openRightSidebarWithAnimation:completion:

Opens the right sidebar.

- (void)openRightSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion

Parameters

animated

Whether or not the animation should be animated.

completion

An optional block to be called on completion.

Declared In

RBSidebarContainerView.h

– closeSidebarsWithAnimation:completion:

Closes the sidebars.

- (void)closeSidebarsWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion

Parameters

animated

Whether or not the animation should be animated.

completion

An optional block to be called on completion.

Declared In

RBSidebarContainerView.h

– expandLeftSidebarWithAnimation:completion:

Expands the left sidebar to occupy the full width. This will do nothing if the sidebar is not open or pinned.

- (void)expandLeftSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion

Parameters

animated

Whether or not the animation should be animated.

completion

An optional block to be called on completion.

Declared In

RBSidebarContainerView.h

– expandRightSidebarWithAnimation:completion:

Expands the right sidebar to occupy the full width. This will do nothing if the sidebar is not open or pinned.

- (void)expandRightSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion

Parameters

animated

Whether or not the animation should be animated.

completion

An optional block to be called on completion.

Declared In

RBSidebarContainerView.h

– collapseSidebarWithAnimation:completion:

Collapse the currently extended sidebar.

- (void)collapseSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion

Parameters

animated

Whether or not the animation should be animated.

completion

An optional block to be called on completion.

Declared In

RBSidebarContainerView.h

– pinLeftSidebarWithAnimation:completion:

Pins the left sidebar so that it remains open. The body content view is adjusted.

- (void)pinLeftSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion

Parameters

animated

Whether or not the animation should be animated.

completion

An optional block to be called on completion.

Declared In

RBSidebarContainerView.h

– unpinLeftSidebarWithAnimation:completion:

Unpins the left sidebar.

- (void)unpinLeftSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion

Parameters

animated

Whether or not the animation should be animated.

completion

An optional block to be called on completion.

Declared In

RBSidebarContainerView.h

– pinRightSidebarWithAnimation:completion:

Pins the right sidebar so that it remains open. The body content view is adjusted.

- (void)pinRightSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion

Parameters

animated

Whether or not the animation should be animated.

completion

An optional block to be called on completion.

Declared In

RBSidebarContainerView.h

– unpinRightSidebarWithAnimation:completion:

Unpins the right sidebar.

- (void)unpinRightSidebarWithAnimation:(BOOL)animated completion:(nullable dispatch_block_t)completion

Parameters

animated

Whether or not the animation should be animated.

completion

An optional block to be called on completion.

Declared In

RBSidebarContainerView.h

  pinLeftSidebarIfSufficientWidth

Whether or not to automatically pin the left sidebar if there would be sufficient body width.

@property (nonatomic) BOOL pinLeftSidebarIfSufficientWidth

Declared In

RBSidebarContainerView.h

  pinRightSidebarIfSufficientWidth

Whether or not to automatically pin the right sidebar if there would be sufficient body width.

@property (nonatomic) BOOL pinRightSidebarIfSufficientWidth

Declared In

RBSidebarContainerView.h

  pinLeftSidebarBeforeRightSidebar

Whether or not the left sidebar should be pinned before the right sidebar when there is sufficient body width.

@property (nonatomic) BOOL pinLeftSidebarBeforeRightSidebar

Declared In

RBSidebarContainerView.h

  desiredMinimumBodyWidth

The body width that is required with a bar open in order for it to be automatically pinned.

@property (nonatomic) CGFloat desiredMinimumBodyWidth

Declared In

RBSidebarContainerView.h