Skip to content

Latest commit

 

History

History
82 lines (58 loc) · 3.82 KB

README.md

File metadata and controls

82 lines (58 loc) · 3.82 KB
Raw

#Side Menu Platform License

Animated side menu with customizable UI. Made in Yalantis.
Check this project on dribbble.
Check this project on Behance.

##Requirements

iOS 7.x / 8.x (see installation instructions)

##Installation

####Using CocoaPods

Simply add the following line to your Podfile:

pod 'YALSideMenu'

(CocoaPods v0.36 or later required. See this blog post for details.)

####Manual Installation

For application targets that do not support embedded frameworks, such as iOS 7, SideMenu can be integrated by including source files from the SideMenu folder directly, optionally wrapping the top-level types into struct SideMenu to simulate a namespace. Yes, this sucks.

  1. Add SideMenu as a submodule by opening the Terminal, cd-ing into your top-level project directory, and entering the command git submodule add https://github.com/yalantis/Side-Menu.iOS.git
  2. Open the SideMenu folder, and drag SideMenu.xcodeproj into the file navigator of your app project.
  3. In Xcode, navigate to the target configuration window by clicking on the blue project icon, and selecting the application target under the "Targets" heading in the sidebar.
  4. Ensure that the deployment target of SideMenu.framework matches that of the application target.
  5. In the tab bar at the top of that window, open the "Build Phases" panel.
  6. Expand the "Target Dependencies" group, and add SideMenu.framework.
  7. Expand the "Link Binary With Libraries" group, and add SideMenu.framework
  8. Click on the + button at the top left of the panel and select "New Copy Files Phase". Rename this new phase to "Copy Frameworks", set the "Destination" to "Frameworks", and add SideMenu.framework.

##Usage

  1. Import SideMenu module

    import SideMenu

  2. Adopt the Menu protocol in your menu view controller, e.g.

    class MyFancyMenuViewController: UIViewController, Menu  {
	@IBOutlet
	var menuItems = [UIView] ()

  3. Set preferredContentSize to specify the desired menu width

  4. Use custom MenuSegue to present your menu view controller

License

The MIT License (MIT)

Copyright © 2014 Yalantis

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
THE SOFTWARE.