{"id":13849245,"url":"https://github.com/mikefrederick/MFSideMenu","last_synced_at":"2025-07-12T16:31:15.143Z","repository":{"id":2771076,"uuid":"3769838","full_name":"mikefrederick/MFSideMenu","owner":"mikefrederick","description":"Facebook-like side menu for iOS","archived":false,"fork":false,"pushed_at":"2017-04-17T13:39:20.000Z","size":1608,"stargazers_count":1165,"open_issues_count":65,"forks_count":291,"subscribers_count":84,"default_branch":"master","last_synced_at":"2024-10-29T17:50:18.677Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":"","language":"Objective-C","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"other","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/mikefrederick.png","metadata":{"files":{"readme":"README.mdown","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2012-03-19T23:26:10.000Z","updated_at":"2024-10-12T12:20:53.000Z","dependencies_parsed_at":"2022-08-20T21:50:17.773Z","dependency_job_id":null,"html_url":"https://github.com/mikefrederick/MFSideMenu","commit_stats":null,"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikefrederick%2FMFSideMenu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikefrederick%2FMFSideMenu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikefrederick%2FMFSideMenu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/mikefrederick%2FMFSideMenu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/mikefrederick","download_url":"https://codeload.github.com/mikefrederick/MFSideMenu/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":225669488,"owners_count":17505387,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":[],"created_at":"2024-08-04T19:01:11.835Z","updated_at":"2024-11-22T01:30:42.099Z","avatar_url":"https://github.com/mikefrederick.png","language":"Objective-C","funding_links":[],"categories":["Objective-C"],"sub_categories":[],"readme":"#MFSideMenu\n\nThis project was inspired by the side-menu functionality seen in the Facebook iOS app. MFSideMenu utilizes view controller containment and gives you a simple API for implementing side-menu functionality. It integrates with storyboard-based apps as well as traditional setups.\n\n=======\n\n![](http://i.imgur.com/Ah5mP.png)  \u0026nbsp;  ![](http://i.imgur.com/KN4IB.png)\n\n##Features\n\n- Universal device support (iPhone + iPad)\n- Universal orientation support (Portrait + Landscape)\n- Menus on the left and right side of the screen.\n- Storyboard support\n- View controller containment\n- Works with UINavigationController, UITabBarController, and other types of view controllers\n- Nice set of configuration options\n- Lightweight, simple and readable code.\n\n\n##Installation\n\n####CocoaPods\nAdd `pod 'MFSideMenu'` to your Podfile.\n\n####Manually\nAdd the `MFSideMenu` folder to your project. Add QuartzCore to your project. MFSideMenu uses ARC. If you have a project that doesn't use ARC, just add the `-fobjc-arc` compiler flag to the MFSideMenu files.\n\n\n##Usage\n\n###Basic Setup\n\nIn your app delegate:\u003cbr /\u003e\n```objective-c\n#import \"MFSideMenu.h\"\n\nMFSideMenuContainerViewController *container = [MFSideMenuContainerViewController\n                                                containerWithCenterViewController:centerViewController\n                                                leftMenuViewController:leftMenuViewController\n                                                rightMenuViewController:rightMenuViewController];\nself.window.rootViewController = container;\n[self.window makeKeyAndVisible];\n```\n\n###Opening \u0026 Closing Menus\n\n```objective-c\n// toggle the left side menu\n[self.menuContainerViewController toggleLeftSideMenuCompletion:^{}];\n// toggle the right side menu\n[self.menuContainerViewController toggleRightSideMenuCompletion:^{}];\n// close the side menu\n[self.menuContainerViewController setMenuState:MFSideMenuStateClosed completion:^{}];\n// open the left side menu\n[self.menuContainerViewController setMenuState:MFSideMenuStateLeftMenuOpen completion:^{}];\n// open the right side menu\n[self.menuContainerViewController setMenuState:MFSideMenuStateRightMenuOpen completion:^{}];\n```\n\n###Pan Modes\n\nYou can specify which areas you want to allow pan gestures on:\n\n```objective-c\n// enable panning on the center view controllers \u0026 the side menus (this is the default behavior):\nmenuContainerViewController.panMode = MFSideMenuPanModeCenterViewController | MFSideMenuPanModeSideMenu;\n\n// disable panning on the side menus, only allow panning on the center view controller:\nmenuContainerViewController.panMode = MFSideMenuPanModeCenterViewController;\n\n// disable all panning\nmenuContainerViewController.panMode = MFSideMenuPanModeNone;\n```\n\n###Panning Custom Views\n\nYou can add panning to any view like so:\n\n```objective-c\n[panView addGestureRecognizer:[self.menuContainerViewController panGestureRecognizer]];\n```\n\n###Listening for Menu Events\n\nYou can listen for menu state event changes (i.e. menu will open, menu did open, etc.). See MFSideMenuContainerViewController.h for the different types of events.\n\n```objective-c\n[[NSNotificationCenter defaultCenter] addObserver:self\n                                            selector:@selector(menuStateEventOccurred:)\n                                                name:MFSideMenuStateNotificationEvent\n                                              object:nil];\n- (void)menuStateEventOccurred:(NSNotification *)notification {\n    MFSideMenuStateEvent event = [[[notification userInfo] objectForKey:@\"eventType\"] intValue];\n    MFSideMenuContainerViewController *containerViewController = notification.object;\n    // ...\n}\n```\n\n###Menu Slide Animation\n\nWith this option enabled, the side menus will slide in \u0026 out with the center view controller. This effect is similar to the Wunderlist side menu.\n\n```objective-c\n// enable the menu slide animation\n[menuContainerViewController setMenuSlideAnimationEnabled:YES];\n\n// control the exaggeration of the menu slide animation\n[menuContainerViewController setMenuSlideAnimationFactor:3.0f];\n```\n\n###Shadow\n\nMFSideMenu gives you the option to show a shadow between the center view controller \u0026 the side menus.\n\n```objective-c\n// enable/disable the shadow\n[menuContainerViewController.shadow setEnabled:YES];\n\n// set the radius of the shadow\n[menuContainerViewController.shadow setRadius:10.0f];\n\n// set the color of the shadow\n[menuContainerViewController.shadow setColor:[UIColor blackColor]];\n\n// set the opacity of the shadow\n[menuContainerViewController.shadow setOpacity:0.75f];\n\n```\n\n##Contact\n\n[@mike_frederick](http://twitter.com/mike_frederick)\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikefrederick%2FMFSideMenu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmikefrederick%2FMFSideMenu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmikefrederick%2FMFSideMenu/lists"}