Latest 1.0.0
Homepage https://github.com/kukushi/SideMenu
License MIT
Platforms ios 9.0, requires ARC
Authors

SideMenuSwift

Version
SideMenuSwift
Carthage compatible
License
Platform

Overview

SideMenu is an easy-to-use side menu container controller written in Swift 4.

Besides all the features a Side Menu should have, it supports:

  • Four kinds of status bar behaviors
  • Three different menu position
  • Both storyboard and programmatically
  • Caching the content view controller and lazy initialization
  • Rubber band effect while panning
  • Custom transition animation
  • RTL supports

Preview

Menu Position / Status Menu Behavior

Above + None Below + Slide
SideMenuSwift SideMenuSwift
SideBySide + Fade SideBySide + HideOnMenu
SideMenuSwift SideMenuSwift

We call the left/right view controller as the menu view controller, the central view controller as content view controller.

Installation

For Swift 4.0, please using 0.5.1 or earlier version.

CocoaPods

To install SideMenu with CocoaPods, add the below line in your Podfile:

pod 'SideMenuSwift'
# Note it's NOT 'SideMenu'

Carthage

To install SideMenu with Carthage, add the below line in your Cartfile:

github "kukushi/SideMenu" "master"

Usages

Storyboard

To set up `SideMenu` in storyboard:

1. Open the view controller’s *Identity inspector*. Change its **Class** to `SideMenuController` and **Module** to `SideMenuSwift`.
2. Set up the menu view controller and the initial content view controller in your Storyboard. Add a **Custom** segue from the `SideMenuController` to each of them.
– Change the menu segue’s identifier to `SideMenu.Menu`, **Class** to `SideMenuSegue` and **Module** to `SideMenuSwift`.
– Change the content segue’s identifier to `SideMenu.Content`, **Class** to `SideMenuSegue` and **Module** to `SideMenuSwift`.
4. (Optional) If you want to use custom segue identifier:
– Open the `SideMenuController`’s *Attribute inspector*.
– In the **Side Menu Controller** section, modify the *Content SegueID/Menu SegueID* to the desired value and change the corresponding segue’s identifier.
5. It’s done. Check [this screenshot](https://github.com/kukushi/SideMenu/blob/develop/Images/StoryboardSample.png?raw=true) a for clear view.

Programmatically

To start the app with `SideMenu` programmatically:

“`swift
import UIKit
import SideMenuSwift
// If you are using Carthage, uses `import SideMenu`

@UIApplicationMain
class AppDelegate: UIResponder, UIApplicationDelegate {

var window: UIWindow?

@objc func applicationDidFinishLaunching(_ application: UIApplication) {
let contentViewController = …
let menuViewController = …

window = UIWindow(frame: UIScreen.main.bounds)
window?.rootViewController = SideMenuController(contentViewController: contentViewController,
menuViewController: menuViewController)

window?.makeKeyAndVisible()
return true
}
}
“`

Use the sideMenuController method which provided in UIViewController‘s extension to get the parent SideMenuController:

viewController.sideMenuController?.revealMenu()

Preferences

All the preferences of SideMenu can be found in SideMenuController.preferences. Its recommend to check out the Example to see how those options will take effect.

SideMenuController.preferences.basic.menuWidth = 240
SideMenuController.preferences.basic.statusBarBehavior = .hideOnMenu
SideMenuController.preferences.basic.position = .below
SideMenuController.preferences.basic.direction = .left
SideMenuController.preferences.basic.enablePanGesture = true
SideMenuController.preferences.basic.supportedOrientations = .portrait
SideMenuController.preferences.basic.shouldRespectLanguageDirection = true

// See a lot more options on `Preferences.swift`.

Caching the Content

One of the coolest features of SideMenu is caching.

// Cache the view controllers somewhere in your code
sideMenuController?.cache(viewController: secondViewController, with: "second")
sideMenuController?.cache(viewController: thirdViewController, with: "third")

// Switch to it when needed
sideMenuController?.setContentViewController(with: "second")

What about the content view controller initialized from the Storyboard? We can use the preferences to apply a default key for it!

SideMenuController.preferences.basic.defaultCacheKey = "default"

What if we can’t want to load all the content view controllers so early? We can use lazy caching:

sideMenuController?.cache(viewControllerGenerator: { self.storyboard?.instantiateViewController(withIdentifier: "SecondViewController") }, with: "second")
sideMenuController?.cache(viewControllerGenerator: { self.storyboard?.instantiateViewController(withIdentifier: "ThirdViewController") }, with: "third")

Requirements

  • Xcode 10
  • iOS 9.0 or later

License

SideMenu is available under the MIT license. See the LICENSE file for more info.

Latest podspec

{
    "name": "SideMenuSwift",
    "version": "1.0.0",
    "summary": "An interactive iOS side menu with rich features.",
    "description": "SideMenuSwift is an iOS container view controller written in Swift. Its easy-to-use and supports both storyboard and code. It provides several ways to reveal the menu and animate the status bar.",
    "homepage": "https://github.com/kukushi/SideMenu",
    "license": "MIT",
    "authors": {
        "kukushi": ""
    },
    "platforms": {
        "ios": "9.0"
    },
    "source": {
        "git": "https://github.com/kukushi/SideMenu.git",
        "tag": "1.0.0"
    },
    "source_files": "SideMenu/*.{h,m,swift}",
    "swift_version": "4.2",
    "requires_arc": true
}

Pin It on Pinterest

Share This