{"id":2601,"url":"https://github.com/romaonthego/RESideMenu","last_synced_at":"2025-08-03T00:32:10.336Z","repository":{"id":44718043,"uuid":"10740728","full_name":"romaonthego/RESideMenu","owner":"romaonthego","description":"iOS 7/8 style side menu with parallax effect.","archived":false,"fork":false,"pushed_at":"2017-12-05T17:29:00.000Z","size":11964,"stargazers_count":7095,"open_issues_count":134,"forks_count":1349,"subscribers_count":291,"default_branch":"master","last_synced_at":"2024-10-29T15:05:17.109Z","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":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/romaonthego.png","metadata":{"files":{"readme":"README.md","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":"2013-06-17T15:37:52.000Z","updated_at":"2024-10-23T14:07:46.000Z","dependencies_parsed_at":"2022-09-17T15:40:58.654Z","dependency_job_id":null,"html_url":"https://github.com/romaonthego/RESideMenu","commit_stats":null,"previous_names":[],"tags_count":34,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romaonthego%2FRESideMenu","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romaonthego%2FRESideMenu/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romaonthego%2FRESideMenu/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/romaonthego%2FRESideMenu/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/romaonthego","download_url":"https://codeload.github.com/romaonthego/RESideMenu/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":226612612,"owners_count":17659068,"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-01-05T20:16:18.046Z","updated_at":"2024-12-06T18:30:36.933Z","avatar_url":"https://github.com/romaonthego.png","language":"Objective-C","readme":"# RESideMenu\n\niOS 7/8 style side menu with parallax effect inspired by Dribbble shots ([first](http://dribbble.com/shots/1116265-Instasave-iPhone-App) and [second](http://dribbble.com/shots/1114754-Social-Feed-iOS7)).\n\nSince version 4.0 you can add menu view controllers on both left and right sides of your content view controller.\n\n\u003cimg src=\"https://github.com/romaonthego/RESideMenu/raw/master/Screenshot.png\" alt=\"RESideMenu Screenshot\" width=\"400\" height=\"568\" /\u003e\n\u003cimg src=\"https://raw.githubusercontent.com/romaonthego/RESideMenu/master/Demo.gif?2\" alt=\"RESideMenu Screenshot\" width=\"320\" height=\"568\" /\u003e\n\n## Requirements\n* Xcode 6 or higher\n* Apple LLVM compiler\n* iOS 6.0 or higher\n* ARC\n\n## Demo\n\nBuild and run the `RESideMenuExample` project in Xcode to see `RESideMenu` in action. For storyboards integration demo, build and run `RESideMenuStoryboardsExample`.\n\n## Installation\n\n### CocoaPods\n\nThe recommended approach for installating `RESideMenu` is via the [CocoaPods](http://cocoapods.org/) package manager, as it provides flexible dependency management and dead simple installation.\nFor best results, it is recommended that you install via CocoaPods \u003e= **0.28.0** using Git \u003e= **1.8.0** installed via Homebrew.\n\nInstall CocoaPods if not already available:\n\n``` bash\n$ [sudo] gem install cocoapods\n$ pod setup\n```\n\nChange to the directory of your Xcode project:\n\n``` bash\n$ cd /path/to/MyProject\n$ touch Podfile\n$ edit Podfile\n```\n\nEdit your Podfile and add RESideMenu:\n\n``` bash\nplatform :ios, '6.0'\npod 'RESideMenu', '~\u003e 4.0.7'\n```\n\nInstall into your Xcode project:\n\n``` bash\n$ pod install\n```\n\nOpen your project in Xcode from the .xcworkspace file (not the usual project file)\n\n``` bash\n$ open MyProject.xcworkspace\n```\n\nPlease note that if your installation fails, it may be because you are installing with a version of Git lower than CocoaPods is expecting. Please ensure that you are running Git \u003e= **1.8.0** by executing `git --version`. You can get a full picture of the installation details by executing `pod install --verbose`.\n\n### Manual Install\n\nAll you need to do is drop `RESideMenu` files into your project, and add `#include \"RESideMenu.h\"` to the top of classes that will use it.\n\n## Example Usage\n\nIn your AppDelegate's `- (BOOL)application:(UIApplication *)application didFinishLaunchingWithOptions:(NSDictionary *)launchOptions` create the view controller and assign content and menu view controllers.\n\n``` objective-c\n// Create content and menu controllers\n//\nDEMONavigationController *navigationController = [[DEMONavigationController alloc] initWithRootViewController:[[DEMOHomeViewController alloc] init]];\nDEMOLeftMenuViewController *leftMenuViewController = [[DEMOLeftMenuViewController alloc] init];\nDEMORightMenuViewController *rightMenuViewController = [[DEMORightMenuViewController alloc] init];\n\n// Create side menu controller\n//\nRESideMenu *sideMenuViewController = [[RESideMenu alloc] initWithContentViewController:navigationController\n                                                                leftMenuViewController:leftMenuViewController\n                                                               rightMenuViewController:rightMenuViewController];\nsideMenuViewController.backgroundImage = [UIImage imageNamed:@\"Stars\"];\n\n// Make it a root controller\n//\nself.window.rootViewController = sideMenuViewController;\n```\n\nPresent the menu view controller:\n\n```objective-c\n[self.sideMenuViewController presentLeftMenuViewController];\n```\n\nor\n\n```objective-c\n[self.sideMenuViewController presentRightMenuViewController];\n```\n\nSwitch content view controllers:\n\n```objective-c\n#import \u003cRESideMenu/RESideMenu.h\u003e\n\n....\n\n[self.sideMenuViewController setContentViewController:viewController animated:YES];\n[self.sideMenuViewController hideMenuViewController];\n```\n\n## Storyboards Example\n\n1. Create a subclass of `RESideMenu`. In this example we call it `DEMORootViewController`.\n2. In the Storyboard designate the root view's owner as `DEMORootViewController`.\n3. Make sure to `#import \"RESideMenu.h\"` in `DEMORootViewController.h`.\n4. Add more view controllers to your Storyboard, and give them identifiers \"leftMenuViewController\", \"rightMenuViewController\" and \"contentViewController\". Note that in the new XCode the identifier is called \"Storyboard ID\" and can be found in the Identity inspector.\n5. Add a method `awakeFromNib` to `DEMORootViewController.m` with the following code:\n\n```objective-c\n- (void)awakeFromNib\n{\n    self.contentViewController = [self.storyboard instantiateViewControllerWithIdentifier:@\"contentViewController\"];\n    self.leftMenuViewController = [self.storyboard instantiateViewControllerWithIdentifier:@\"leftMenuViewController\"];\n    self.rightMenuViewController = [self.storyboard instantiateViewControllerWithIdentifier:@\"rightMenuViewController\"];\n}\n```\n\n## Customization\n\nYou can customize the following properties of `RESideMenu`:\n\n``` objective-c\n@property (assign, readwrite, nonatomic) NSTimeInterval animationDuration;\n@property (strong, readwrite, nonatomic) UIImage *backgroundImage;\n@property (assign, readwrite, nonatomic) BOOL panGestureEnabled;\n@property (assign, readwrite, nonatomic) BOOL panFromEdge;\n@property (assign, readwrite, nonatomic) NSUInteger panMinimumOpenThreshold;\n@property (assign, readwrite, nonatomic) BOOL interactivePopGestureRecognizerEnabled;\n@property (assign, readwrite, nonatomic) BOOL scaleContentView;\n@property (assign, readwrite, nonatomic) BOOL scaleBackgroundImageView;\n@property (assign, readwrite, nonatomic) BOOL scaleMenuView;\n@property (assign, readwrite, nonatomic) BOOL contentViewShadowEnabled;\n@property (assign, readwrite, nonatomic) UIColor *contentViewShadowColor;\n@property (assign, readwrite, nonatomic) CGSize contentViewShadowOffset;\n@property (assign, readwrite, nonatomic) CGFloat contentViewShadowOpacity;\n@property (assign, readwrite, nonatomic) CGFloat contentViewShadowRadius;\n@property (assign, readwrite, nonatomic) CGFloat contentViewScaleValue;\n@property (assign, readwrite, nonatomic) CGFloat contentViewInLandscapeOffsetCenterX;\n@property (assign, readwrite, nonatomic) CGFloat contentViewInPortraitOffsetCenterX;\n@property (assign, readwrite, nonatomic) CGFloat parallaxMenuMinimumRelativeValue;\n@property (assign, readwrite, nonatomic) CGFloat parallaxMenuMaximumRelativeValue;\n@property (assign, readwrite, nonatomic) CGFloat parallaxContentMinimumRelativeValue;\n@property (assign, readwrite, nonatomic) CGFloat parallaxContentMaximumRelativeValue;\n@property (assign, readwrite, nonatomic) CGAffineTransform menuViewControllerTransformation;\n@property (assign, readwrite, nonatomic) BOOL parallaxEnabled;\n@property (assign, readwrite, nonatomic) BOOL bouncesHorizontally;\n@property (assign, readwrite, nonatomic) UIStatusBarStyle menuPreferredStatusBarStyle;\n@property (assign, readwrite, nonatomic) BOOL menuPrefersStatusBarHidden;\n```\n\nIf you set a backgroundImage, don't forget to set the Menu View Controller's background color to clear color.\n\nYou can implement `RESideMenuDelegate` protocol to receive the following messages:\n\n```objective-c\n- (void)sideMenu:(RESideMenu *)sideMenu didRecognizePanGesture:(UIPanGestureRecognizer *)recognizer;\n- (void)sideMenu:(RESideMenu *)sideMenu willShowMenuViewController:(UIViewController *)menuViewController;\n- (void)sideMenu:(RESideMenu *)sideMenu didShowMenuViewController:(UIViewController *)menuViewController;\n- (void)sideMenu:(RESideMenu *)sideMenu willHideMenuViewController:(UIViewController *)menuViewController;\n- (void)sideMenu:(RESideMenu *)sideMenu didHideMenuViewController:(UIViewController *)menuViewController;\n```\n\n## Contact\n\nRoman Efimov\n\n- https://github.com/romaonthego\n- https://twitter.com/romaonthego\n- romefimov@gmail.com\n\n## License\n\nRESideMenu is available under the MIT license.\n\nCopyright © 2013 Roman Efimov.\n\nPermission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the \"Software\"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:\n\nThe above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.\n\nTHE SOFTWARE IS PROVIDED \"AS IS\", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.\n","funding_links":[],"categories":["UI","Menu","awesome-ios ##","Objective-C","IOS 或 OSX","Objective-C  Stars 1000以内排名整理","etc","OOM-Leaks-Crash","Uncategorized"],"sub_categories":["Menu","Layout","Other free courses","Side Drawer","Uncategorized"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromaonthego%2FRESideMenu","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fromaonthego%2FRESideMenu","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fromaonthego%2FRESideMenu/lists"}