TKSideDrawer Class Reference

Inherits from	TKView : UIView
Declared in	TKSideDrawer.h

Overview

TKSideDrawer extends the popular slide-out menu design pattern which is mainly associated with navigational purposes. The control allows for embedding any content inside the sliding view from text and icons to sliders and filters. The control is revealed when the end-user swipes a finger from the left/right/top/bottom edge of the screen or when the user touches the menu icon in the navigation bar.

Tasks

content property
theme property
allowScroll property
cancelTransition property
allowEdgeSwipe property
edgeSwipeTreshold property
allowGestures property
title property
position property
width property
transitionManager property
transition property
transitionDuration property
headerView property
footerView property
delegate property
style property
hostview property
isVisible property
sections property
+ findSideDrawerAtIndex:forViewController:
– show
– showWithTransition:
– dismiss
– addSection:
– addSectionWithTitle:
– addSectionWithTitle:image:
– removeSection:
– removeAllSections
– insertSection:atIndex:
– selectItemAtIndexPath:

Properties

allowEdgeSwipe

Determines if sidebar should be shown with edge swipe.

@property (nonatomic) BOOL allowEdgeSwipe

Declared In

TKSideDrawer.h

allowGestures

Determines if TKSideDrawer should respond to gestures.

@property (nonatomic) BOOL allowGestures

Declared In

TKSideDrawer.h

allowScroll

Determines if scrolling is enabled.

@property (nonatomic) BOOL allowScroll

Declared In

TKSideDrawer.h

cancelTransition

Allows canceling the current show/dismiss transition.

@property (nonatomic) BOOL cancelTransition

Declared In

TKSideDrawer.h

content

TKSideDrawer’s content. If not set, it is an instance of TKSideDrawerTableView.

@property (nonatomic, strong) UIView *content

Declared In

TKSideDrawer.h

delegate

TKSideDrawer’s delegate

@property (nonatomic, weak) id<TKSideDrawerDelegate> delegate

Declared In

TKSideDrawer.h

edgeSwipeTreshold

Treshold used to determine if a swipe should be considered edge swipe.

@property (nonatomic) CGFloat edgeSwipeTreshold

Declared In

TKSideDrawer.h

footerView

Returns TKSideDrawer’s footer view.

@property (nonatomic, strong) UIView *footerView

Declared In

TKSideDrawer.h

headerView

Returns the header view.

@property (nonatomic, strong) UIView *headerView

Declared In

TKSideDrawer.h

hostview

Returns the host view. A host view is the view at which the TKSideDrawer appears. Depending on the transition effect, the host view is pushed, covered, etc. by the TKSideDrawer view.

@property (nonatomic, weak, readonly) UIView *hostview

Declared In

TKSideDrawer.h

isVisible

Determines if TKSideDrawer’s view is displayed on screen.

@property (nonatomic, readonly) BOOL isVisible

Declared In

TKSideDrawer.h

position

Determines the edge of the screen from which TKSideDrawer will appear.

@property (nonatomic) TKSideDrawerPosition position

Declared In

TKSideDrawer.h

sections

Returns an array containing all TKSideDrawer sections.

@property (nonatomic, strong, readonly) NSArray *sections

Declared In

TKSideDrawer.h

style

Returns the sidebar style. Use the style properties to customize the visual appearance of TKSideDrawer.

@property (nonatomic, strong, readonly) TKSideDrawerStyle *style

Declared In

TKSideDrawer.h

theme

TKSideDrawer’s theme.

@property (nonatomic, strong) TKTheme *theme

Declared In

TKSideDrawer.h

title

TKSideDrawer’s title used by the default header view.

@property (nonatomic, copy) NSString *title

Declared In

TKSideDrawer.h

transition

The transition effect used to display or hide the TKSideDrawer view.

@property (nonatomic) TKSideDrawerTransitionType transition

Declared In

TKSideDrawer.h

transitionDuration

The duration of the show/dismiss animation.

@property (nonatomic) CGFloat transitionDuration

Declared In

TKSideDrawer.h

transitionManager

The transition object responsible used to display or hide the Sidebar panel. Setting your own TKSideDrawerTransition descendant will allow you to use your own custom transition.

@property (nonatomic, strong) TKSideDrawerTransition *transitionManager

Declared In

TKSideDrawer.h

width

The width of TKSideDrawer’s view.

@property (nonatomic) CGFloat width

Declared In

TKSideDrawer.h

Class Methods

findSideDrawerAtIndex:forViewController:

Associates a TKSideDrawer with a UIViewController. Should be used only with a TKSideDrawerController.

+ (TKSideDrawer *)findSideDrawerAtIndex:(NSUInteger)index forViewController:(UIViewController *)viewController

Parameters

index: The index of the requested side drawer.

viewController: The view controller TKSideDrawer will be associated with.

Declared In

TKSideDrawer.h

Instance Methods

addSection:

Adds a section to TKSideDrawer.

- (void)addSection:(TKSideDrawerSection *)section

Parameters

section: The TKSideDrawerSection that will be added to TKSideDrawer.

Declared In

TKSideDrawer.h

addSectionWithTitle:

Adds a section to TKSideDrawer.

- (TKSideDrawerSection *)addSectionWithTitle:(NSString *)title

Parameters

title: The title of the TKSideDrawerSection that will be added.

Return Value

The added TKSideDrawerSection.

Declared In

TKSideDrawer.h

addSectionWithTitle:image:

Adds a section to the TKSideDrawer.

- (TKSideDrawerSection *)addSectionWithTitle:(NSString *)title image:(UIImage *)image

Parameters

title: The title of the TKSideDrawerSection that is added.

image: The image of the TKSideDrawerSection that is added.

Return Value

The added TKSideDrawerSection.

Declared In

TKSideDrawer.h

dismiss

Dismisses TKSideDrawer using the current active transition animation.

- (void)dismiss

Declared In

TKSideDrawer.h

insertSection:atIndex:

Inserts a section in TKSideDrawer at a specified index.

- (void)insertSection:(TKSideDrawerSection *)section atIndex:(NSInteger)index

Parameters

section: TKSideDrawerSection that is inserted.

index: The index at which the section is inserted.

Declared In

TKSideDrawer.h

removeAllSections

Removes all sections from TKSideDrawer.

- (void)removeAllSections

Declared In

TKSideDrawer.h

removeSection:

Removes a section from TKSideDrawer.

- (void)removeSection:(TKSideDrawerSection *)section

Parameters

section: The TKSideDrawerSection that is removed from TKSideDrawer.

Declared In

TKSideDrawer.h

selectItemAtIndexPath:

Selects an item at specified index path.

- (void)selectItemAtIndexPath:(NSIndexPath *)indexPath

Parameters

indexPath: TKSideDrawerItem’s index path.

Declared In

TKSideDrawer.h

show

Displays a TKSideDrawer on sthe creen using the last active transition animation.

- (void)show

Declared In

TKSideDrawer.h

showWithTransition:

Displays a TKSideDrawer using the transition type.

- (void)showWithTransition:(TKSideDrawerTransitionType)transition

Parameters

transition: The transition that is used to display TKSideDrawer.

Declared In

TKSideDrawer.h