lns

LNSideMenu

A side menu for iOS written in Swift

Showing:

Popularity

Downloads/wk

0

GitHub Stars

97

Maintenance

Last Commit

3yrs ago

Contributors

1

Package

Dependencies

0

License

MIT

Categories

Readme

LNSideMenu

This lib is basically similiar to a lot of existing ones in Github for iOS, but besides of must-have features, it supilies an interesting one focusing on effects and animations like scrolling effect, faded animation for the appearance of the menu's items,.. Let's explore and enjoy it.

Demo Demo

Get Started

. Create a UINavigationController subclassed from LNSideMenuNavigationController in order.

. Initilize the menu view based on a source view:

func initialSideMenu(_ position: Position) {
    sideMenu = LNSideMenu(sourceView: view, menuPosition: position, items: items!)
    sideMenu?.menuViewController?.menuBgColor = UIColor.black.withAlphaComponent(0.85)
    sideMenu?.delegate = self
    // Bring navigationBar to front if needed
    view.bringSubview(toFront: navigationBar)
}

. Implementing delegate methods: didSelectItemAtIndex,..

. In order to change the content viewcontroller: from the your UINavigationController subclass, get the destination and set it as the content viewcontroller.

func didSelectItemAtIndex(index: Int) {
    // TODO: Get your destViewController here
    self.setContentViewController(destViewController)
}

. Toggle menu:

sideMenuManager?.toggle()

. Making navigation bar translucent by adding these code as following:

self.navigationBarTranslucentStyle()
sideMenuManager?.instance()?.menu?.isNavbarHiddenOrTransparent = true

. Digging up Example to get a comprehensive view.

Take your own menu

Initialize sidemenu as below in NavigationController subclass: The lib's currently providing 4 types of adjustable size, particularly in full, half, twothird and custom(CGFloat).

func initialCustomMenu(pos position: Position) {
    let menu = UIStoryboard(name: "Main", bundle: nil).instantiateViewController(withIdentifier: "LeftMenuTableViewController") as! LeftMenuTableViewController
    menu.delegate = self
    sideMenu = LNSideMenu(sourceView: view, menuPosition: position, customSideMenu: menu)
    sideMenu?.delegate = self
    // Enable dynamic animator
    sideMenu?.enableDynamic = true
    // Moving down the menu view under navigation bar
    sideMenu?.underNavigationBar = true
}

Configurable Properties

. disabled: default is false, disabled/enabled sidemenu
. enableDynamic: default is true, disabled/enabled dynamic animator
. enableAnimation: default is true, showing side menu with fade animation
. Gesture recognizers: allowLeftSwipe, allowRightSwipe, allowPanGesture: default is true
. animationDuration: default is 0.5, show/hide sidemenu animation duration
. hideWhenDidSelectOnCell: default is true, the sidemenu is hidden when selecting an item on menu
. SideMenu custom colors: 
- menuBgColor: default is purpleColor
- itemBgColor: default is whiteColor
- highlightColor: default is redColor
- titleColor: item title color, default is blackColor

Requirements

. Xcode 8

. iOS 8 or higher

. Swift 3/4

Installation

Cocoapods

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

Swift 3

pod 'LNSideMenu', '~> 2.3'

Swift 4

pod 'LNSideMenu', '~> 3.0'

Manual

Adding all files in LNSideMenu folder to your project folder

TODO

. Changing content viewcontroller animation

Contribution

I will be much appreciated if anyone's interested in and take your time to contribute it.

Author

Luan Nguyen

License

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

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100