https://github.com/twotoasters/TWTSideMenuViewController

Side Menus for iOS 7
https://github.com/twotoasters/TWTSideMenuViewController

Last synced: about 1 month ago
JSON representation

Side Menus for iOS 7

• Host: GitHub
• URL: https://github.com/twotoasters/TWTSideMenuViewController
• Owner: twotoasters
• License: mit
• Created: 2013-08-27T13:49:01.000Z (over 11 years ago)
• Default Branch: master
• Last Pushed: 2014-09-26T17:00:18.000Z (about 10 years ago)
• Last Synced: 2024-10-31T15:41:16.893Z (about 2 months ago)
• Language: Objective-C
• Size: 5.88 MB
• Stars: 847
• Watchers: 72
• Forks: 148
• Open Issues: 18
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-cocoa - TWTSideMenuViewController

README

        
## TWTSideMenuViewController

[![Build Status](https://travis-ci.org/twotoasters/TWTSideMenuViewController.png?branch=master)](https://travis-ci.org/twotoasters/TWTSideMenuViewController)

One of the most common implementations of menu views has been the "Side Drawer", "basement", or "Side Menu" made popular in apps such as Facebook and Path. When the user taps to open the side menu the user's main context slides to the right (or left in some implementations) to display another view _below_. This works well in iOS 6 and before. What does it mean for iOS 7?

With iOS 7, apps are encouraged to use the whole screen and not rely on the 20pt status bar to be outside of the plane of your app. This breaks the existing side bar idea in that the status bar now lives over two view contexts with a single style.

![Bad Side Bar](Artifacts/side-bar-bad.png)

Working with the team at Luvocracy, we needed to find a way to show a side menu for our iOS 7 release. Many designers on [Dribbble](http://dribbble.com) began [looking at a new approach](http://dribbble.com/shots/1154748-WhatsApp-iOS-7-Redesign) for [side bars](http://dribbble.com/shots/1185823-Side-menu). Inspired by this we worked up a quick prototype that slides the view to the right and scales revealing the menu as seen in the dribbble samples above. Moving forward from this idea and inspired by other ideas from iOS 7 we changed it from a slide to more of a viewport change.

![SideMenuViewController](Artifacts/TWTSideMenu.gif)

### Usage

TWTSideMenuViewController is implemented using a single parent view controller that manages your menu and main views as child view controllers. To set it up, initialize a new instance of TWTSideMenuViewController and supply a menu view controller and a main view controller.

```objective-c

  // application:didFinishLaunchingWithOptions:

  self.menuViewController = [[UIViewController alloc] initWithNibName:nil bundle:nil];

  self.mainViewController = [[UIViewController alloc] initWithNibName:nil bundle:nil];

  

  // create a new side menu

  self.sideMenuViewController = [[TWTSideMenuViewController alloc] initWithMenuViewController:self.menuViewController mainViewController:[[UINavigationController alloc] initWithRootViewController:self.mainViewController]];

  // specify the shadow color to use behind the main view controller when it is scaled down.

  self.sideMenuViewController.shadowColor = [UIColor blackColor];

  // specify a UIOffset to offset the open position of the menu

  self.sideMenuViewController.edgeOffset = UIOffsetMake(18.0f, 0.0f);

  // specify a scale to zoom the interface — the scale is 0.0 (scaled to 0% of it's size) to 1.0 (not scaled at all). The example here specifies that it zooms so that the main view is 56.34% of it's size in open mode. 

  self.sideMenuViewController.zoomScale = 0.5634f;

  // set the side menu controller as the root view controller

  self.window.rootViewController = self.sideMenuViewController;

```

Later, when you need to change what is in the main view controller's context you can simply set the view controller with the convenience method:

```objective-c

  // All views presented in a side menu view controller have access to the side menu directly. Much like the way UINavigationController works. To swap to a new view controller simply set the main view controller:

  [self.sideMenuViewController setMainViewController:controller animated:YES closeMenu:YES];

```

### TODO

- Find additional requirements as the library is used in additional apps. (This initial version was built to meet the needs of a single app).

- Add Tests

### Requirements

- Base SDK: iOS 7

- Deployment Target: iOS 6+

### Contact

TWTSideMenuViewController was created by [Two Toasters](@twotoasters) in the development of [Luvocracy](http://www.luvocracy.com).

### License

Available under the MIT License. See the LICENSE file for more.