SideMenu

Gestures must be enabled via code using SideMenuManager. To use gestures, you must first assign your menu controllers to SideMenuManager.default.leftMenuNavigationController or SideMenuManager.default.rightMenuNavigationController (typically in AppDelegate).

// 1. Define and assign menus in AppDelegate
let leftMenuNavigationController = SideMenuNavigationController(rootViewController: YourViewController)
SideMenuManager.default.leftMenuNavigationController = leftMenuNavigationController

let rightMenuNavigationController = SideMenuNavigationController(rootViewController: YourViewController)
SideMenuManager.default.rightMenuNavigationController = rightMenuNavigationController

// 2. Setup gestures (e.g., in a ViewController)
SideMenuManager.default.addPanGestureToPresent(toView: self.navigationController!.navigationBar)
SideMenuManager.default.addScreenEdgePanGesturesToPresent(toView: self.navigationController!.view)

Adhere to SideMenuNavigationControllerDelegate in your view controller to receive lifecycle notifications when the menu is displayed or dismissed. If your view controller implements this protocol, the methods are called automatically without needing to manually set a sideMenuDelegate.

extension MyViewController: SideMenuNavigationControllerDelegate {

    func sideMenuWillAppear(menu: SideMenuNavigationController, animated: Bool) {
        print("SideMenu Appearing! (animated: \(animated))")
    }

    func sideMenuDidAppear(menu: SideMenuNavigationController, animated: Bool) {
        print("SideMenu Appeared! (animated: \(animated))")
    }

    func sideMenuWillDisappear(menu: SideMenuNavigationController, animated: Bool) {
        print("SideMenu Disappearing! (animated: \(animated))")
    }

    func sideMenuDidDisappear(menu: SideMenuNavigationController, animated: Bool) {
        print("SideMenu Disappeared! (animated: \(animated))")
    }
}

To create a custom transition, subclass SideMenuPresentationStyle and override its properties (like backgroundColor, menuScaleFactor, presentingEndAlpha, etc.) and transition methods (presentationTransitionWillBegin, dismissalTransitionDidEnd, etc.).

class MyPresentStyle: SideMenuPresentationStyle {

    override init() {
        super.init()
        backgroundColor = .black
        menuStartAlpha = 1
        menuOnTop = false
        menuTranslateFactor = 0
        menuScaleFactor = 1
        onTopShadowColor = .black
        onTopShadowRadius = 5
        onTopShadowOpacity = 0
        onTopShadowOffset = .zero
        presentingEndAlpha = 1
        presentingTranslateFactor = 0
        presentingScaleFactor = 1
        presentingParallaxStrength = .zero
    }

    override func presentationTransitionWillBegin(to presentedViewController: UIViewController, from presentingViewController: UIViewController) {}
    override func presentationTransition(to presentedViewController: UIViewController, from presentingViewController: UIViewController) {}
    override func presentationTransitionDidEnd(to presentedViewController: UIViewController, from presentingViewController: UIViewController, _ completed: Bool) {}
    override func dismissalTransitionWillBegin(to presentedViewController: UIViewController, from presentingViewController: UIViewController) {}
    override func dismissalTransition(to presentedViewController: UIViewController, from presentingViewController: UIViewController) {}
    override func dismissalTransitionDidEnd(to presentedViewController: UIViewController, from presentingViewController: UIViewController, _ completed: Bool) {}
}

SideMenuNavigationController is a subclass of UINavigationController that controls the appearance, animation, and behavior of the side menu.

var allowPushOfSameClassTwice: Bool = true
var alwaysAnimate: Bool = true
var animationOptions: UIView.AnimationOptions = .curveEaseInOut
var blurEffectStyle: UIBlurEffect.Style? = nil
var completeGestureDuration: Double = 0.35
var completionCurve: UIView.AnimationCurve = .curveEaseInOut
var dismissDuration: Double = 0.35
var dismissOnPresent: Bool = true
var dismissOnPush: Bool = true
var dismissOnRotation: Bool = true
var dismissWhenBackgrounded: Bool = true
var enableSwipeToDismissGesture: Bool = true
var enableTapToDismissGesture: Bool = true
var initialSpringVelocity: CGFloat = 1
var leftSide: Bool = false
var menuWidth: CGFloat = 240
var presentDuration: Double = 0.35
var presentingViewControllerUserInteractionEnabled: Bool = false
var presentingViewControllerUseSnapshot: Bool = false
var presentationStyle: SideMenuPresentStyle = .viewSlideOut
var pushStyle: MenuPushStyle = .default
var statusBarEndAlpha: CGFloat = 0
var usingSpringWithDamping: CGFloat = 1
var isHidden: Bool