RevealMenuController

Menu controller with expandable item groups, custom position and appearance animation written with Swift. Similar to ActionSheet style of UIAlertController.

Code Quality Rank: L4

Programming language: Swift

License: MIT License

Tags: UI     Menu    

Latest version: v0.4.0

README

Easy to implement controller with expanding menu items. Design is very similar to iOS native ActionSheet presentation style of a UIAlertController. As an additional feature you can set small image icon beside menu item text. Take a look at example screenshot to see all available features.

Features:

• [x] Expandable menu groups
• [x] Custom presentation position (top, center or bottom)
• [x] Custom text alignment
• [x] Menu items can have images

Here are few screenshot with possible usage. I've added a small video (~5Mb) also where you can see live example without installation and launching demo project.

Installation

CocoaPods

RevealMenuController is available through CocoaPods. To install it, simply add the following line to your Podfile:

pod "RevealMenuController"

Cartage

Support will be added in version 1.0

Usage

Initialize RevealMenuController and set required properties:

let revealController = RevealMenuController(title: "Contact Support", position: .Center)
revealController.displayCancel = true           // Display Cancel menu item
revealController.hideOnBackgorundTap = true     // Hide menu when user taps outside of items area
revealController.statusBarStyle = .LightContent // Status bar style

Now you can add actions to menu. Take a look at image property: this menu item will have small icon places beside a text.

let webImage = UIImage(named: "IconHome")
let webAction = RevealMenuAction(title: "Open web page", image: webImage, handler: { (controller, action) in
    // Code to support tap on this item
})
revealController.addAction(webAction)

Adding of action groups is very similar:

let emailImage = UIImage(named: "IconEmail")
let phoneImage = UIImage(named: "IconCall")
let techGroup = RevealMenuActionGroup(title: "Contact support", actions: [
    RevealMenuAction(title: "[email protected]", image: emailImage, handler: { (controller, action) in
        // Code to support tap on this item
    }),
    RevealMenuAction(title: "1-866-752-7753", image: phoneImage, handler: { (controller, action) in
        // Code to support tap on this item
    })
])
revealController.addAction(techGroup)

When you're ready to present controller call:

revealController.displayOnController(self)

Appearance animation depends on it's position:

• Top: Controller appearance will have top-to-bottom slide animation.
• Center: Appearance with fade-in animation
• Bottom: Appearance with bottom-to-top slide animation.

Disappearance will have reverse animation.

Dismissing

To dismiss RevealMenuController call next method. Collapse animation will be reversed to appearance one.

controller.dismissViewControllerAnimated(true, completion: {
    // Completion block
})

RevealMenuAction

RevealMenuAction can be initialized in few ways. Title is always required for action. Image is an optional value. Default text alignment is Center. Handler is also not required but if you will not specify this property there will be no response for user tap on this item.

List of initializers:

init(title: String, image: UIImage?, alignment: NSTextAlignment, handler: RevealControllerHandler?)
init(title: String, image: UIImage?, handler: RevealControllerHandler?)
init(title: String, alignment: NSTextAlignment, handler: RevealControllerHandler?)
init(title: String, handler: RevealControllerHandler?)

RevealMenuActionGroup

Action groups will keep few RevealMenuActions inside. When user press on such menu item group will expand and show list of available actions. Second tap will collapse actions list.

Title is also required for action group. It can have it's own icon image and text alignment, similar to RevealMenuAction. The only difference is that group has no tap handler but actions array instead of it.

List of initializers:

init(title: String, image: UIImage?, alignment: NSTextAlignment, actions: [RevealMenuAction])
init(title: String, alignment: NSTextAlignment, actions: [RevealMenuAction])
init(title: String, image: UIImage, actions: [RevealMenuAction])
init(title: String, actions: [RevealMenuAction])

TODO

• [ ] Custom sizes for iPad
• [ ] Menu item labels customization (font, color)
• [ ] Implement menu title
• [ ] Support for multiline items

Write me or make a pull request if you have any ideas what else functionality could be useful for RevealMenuController.

Author

• [email protected]
• @anatoliy_v
• LinkedIn

License

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