Swift Ruby Objective-C
Switch branches/tags
Latest commit 0a047e9 Jan 13, 2017 @serejahh serejahh committed on GitHub Update ISSUE_TEMPLATE.md

README.md

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+
  • Swift 3
  • Xcode 8

Installation

Using CocoaPods

Simply add the following line to your Podfile:

pod 'YALSideMenu', '~> 2.0'

(CocoaPods v1.1 or later is required)

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 in menu view controller to specify the desired menu width

  4. In content view controller store an animator, that will animate our menu.

    import SideMenu
    class ContentViewController: UIViewController  {
    var menuAnimator : MenuTransitionAnimator!
    }
  5. Initialize an animator for presentation with parameters

    menuAnimator = MenuTransitionAnimator(mode: .presentation, shouldPassEventsOutsideMenu: false) { [unowned self] in
        self.dismiss(animated: true, completion: nil)
    }

If you want, for example, to dismiss your menu when a tap outside menu takes place, you should pass 'false' to 'shouldPassEventsOutsideMenu' flag and assign a 'tappedOutsideHandler'.In fact, you are free to do whatever you want when a tap outside menu occurs or, if you want to have access to your content view controller, just pass 'true' and assign 'tappedOutsideHandler' to nil. 6. Implement class of UIViewControllerTransitioningDelegate that will return our menuAnimator from method animationControllerForPresentedController and assign it to transitioningDelegate of menu view controller(Don't forget to set .Custom modal presentation style). To dismiss menu you should return MenuTransitionAnimator(mode: .Dismissal) from animationControllerForDismissedController method.

```swift
override func prepare(for segue: UIStoryboardSegue, sender: Any?) {
    let menu = segue.destination as! MenuViewController
    menu.transitioningDelegate = self
    menu.modalPresentationStyle = .custom
}

func animationController(forPresented presented: UIViewController, presenting _: UIViewController,
    source _: UIViewController) -> UIViewControllerAnimatedTransitioning? {
        return menuAnimator
}

func animationController(forDismissed dismissed: UIViewController) -> UIViewControllerAnimatedTransitioning? {
    return MenuTransitionAnimator(mode: .dismissal)
}
```

Let us know!

We’d be really happy if you sent us links to your projects where you use our component. Just send an email to github@yalantis.com And do let us know if you have any questions or suggestion regarding the animation.

P.S. We’re going to publish more awesomeness wrapped in code and a tutorial on how to make UI for iOS (Android) better than better. Stay tuned!

License

The MIT License (MIT)

Copyright © 2017 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.