RBSidebarContainerViewController Class Reference

Inherits from UIViewController
Declared in RBSidebarContainerViewController.h

Overview

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

  view

The underlying RBSidebarContainerView object.

@property (nonatomic, retain, nonnull) RBSidebarContainerView *view

Discussion

The underlying RBSidebarContainerView object.

Declared In

RBSidebarContainerViewController.h

  delegate

A delegate to receive RBSidebarContainerViewController events.

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

Discussion

A delegate to receive RBSidebarContainerViewController events.

Declared In

RBSidebarContainerViewController.h

  mode

The mode describing the availability of the sidebars.

@property (nonatomic) RBSidebarContainerViewMode mode

Discussion

The mode describing the availability of the sidebars.

Declared In

RBSidebarContainerViewController.h

  bodyViewController

The body content view controller.

@property (nonatomic, nullable) UIViewController *bodyViewController

Discussion

The body content view controller.

Declared In

RBSidebarContainerViewController.h

  leftSidebarViewController

The left sidebar view controller.

@property (nonatomic, nullable) UIViewController *leftSidebarViewController

Discussion

The left sidebar view controller.

Declared In

RBSidebarContainerViewController.h

  rightSidebarViewController

The right sidebar view controller.

@property (nonatomic, nullable) UIViewController *rightSidebarViewController

Discussion

The right sidebar view controller.

Declared In

RBSidebarContainerViewController.h

  swipeEnabled

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

@property (nonatomic) BOOL swipeEnabled

Discussion

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

Declared In

RBSidebarContainerViewController.h

  swipeMargin

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

@property (nonatomic) CGFloat swipeMargin

Discussion

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

Declared In

RBSidebarContainerViewController.h

  animator

The RBAnimator object to use when animating.

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

Discussion

The RBAnimator object to use when animating.

Declared In

RBSidebarContainerViewController.h

  leftSidebarState

The current state of the left sidebar.

@property (nonatomic, readonly) RBSidebarViewState leftSidebarState

Discussion

The current state of the left sidebar.

Declared In

RBSidebarContainerViewController.h

  leftSidebarIsVisible

Whether or not the left sidebar is currently visible.

@property (nonatomic, readonly) BOOL leftSidebarIsVisible

Discussion

Whether or not the left sidebar is currently visible.

Declared In

RBSidebarContainerViewController.h

  leftSidebarIsEnabled

Whether or not the left sidebar is currently enabled.

@property (nonatomic, readonly) BOOL leftSidebarIsEnabled

Discussion

Whether or not the left sidebar is currently enabled.

Declared In

RBSidebarContainerViewController.h

  leftSidebarIsExpanded

Whether or not the left sidebar is currently expanded.

@property (nonatomic, readonly) BOOL leftSidebarIsExpanded

Discussion

Whether or not the left sidebar is currently expanded.

Declared In

RBSidebarContainerViewController.h

  rightSidebarState

The current state of the right sidebar.

@property (nonatomic, readonly) RBSidebarViewState rightSidebarState

Discussion

The current state of the right sidebar.

Declared In

RBSidebarContainerViewController.h

  rightSidebarIsVisible

Whether or not the right sidebar is currently visible.

@property (nonatomic, readonly) BOOL rightSidebarIsVisible

Discussion

Whether or not the right sidebar is currently visible.

Declared In

RBSidebarContainerViewController.h

  rightSidebarIsEnabled

Whether or not the right sidebar is currently enabled.

@property (nonatomic, readonly) BOOL rightSidebarIsEnabled

Discussion

Whether or not the right sidebar is currently enabled.

Declared In

RBSidebarContainerViewController.h

  rightSidebarIsExpanded

Whether or not the right sidebar is currently expanded.

@property (nonatomic, readonly) BOOL rightSidebarIsExpanded

Discussion

Whether or not the right sidebar is currently expanded.

Declared In

RBSidebarContainerViewController.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.

Discussion

Opens the left sidebar.

Declared In

RBSidebarContainerViewController.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.

Discussion

Opens the right sidebar.

Declared In

RBSidebarContainerViewController.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.

Discussion

Closes the sidebars.

Declared In

RBSidebarContainerViewController.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.

Discussion

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

Declared In

RBSidebarContainerViewController.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.

Discussion

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

Declared In

RBSidebarContainerViewController.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.

Discussion

Collapse the currently extended sidebar.

Declared In

RBSidebarContainerViewController.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.

Discussion

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

Declared In

RBSidebarContainerViewController.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.

Discussion

Unpins the left sidebar.

Declared In

RBSidebarContainerViewController.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.

Discussion

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

Declared In

RBSidebarContainerViewController.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.

Discussion

Unpins the right sidebar.

Declared In

RBSidebarContainerViewController.h

  pinLeftSidebarIfSufficientWidth

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

@property (nonatomic) BOOL pinLeftSidebarIfSufficientWidth

Discussion

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

Declared In

RBSidebarContainerViewController.h

  pinRightSidebarIfSufficientWidth

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

@property (nonatomic) BOOL pinRightSidebarIfSufficientWidth

Discussion

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

Declared In

RBSidebarContainerViewController.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

Discussion

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

Declared In

RBSidebarContainerViewController.h

  desiredMinimumBodyWidth

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

@property (nonatomic) CGFloat desiredMinimumBodyWidth

Discussion

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

Declared In

RBSidebarContainerViewController.h