|
1 | 1 | iOS-Slide-Menu |
2 | 2 | --------- |
| 3 | +iOS Slide Menu built on top of UINavigationController, with configurable buttons, reveal animations, and tap/swiper gesture recognizers. |
3 | 4 |
|
4 | | -iOS Slide Menu built on top of UINavigationController. |
5 | | - |
6 | | -Features: |
7 | | -- Righ Menu |
8 | | -- Left Menu |
9 | | -- Configurable Buttons |
10 | | -- Allows Enable/Disable menu by implmenting delegate methods |
11 | | -- Tap/Swipe gesture recognizer to Open/Close the Menus |
12 | | -- Allows custom animation |
| 5 | +- [Setup](https://github.com/aryaxt/iOS-Slide-Menu#setup) |
| 6 | +- [Switch ViewController](https://github.com/aryaxt/iOS-Slide-Menu#switch-between-viewcontrollers) |
| 7 | +- [Enable/Disable Left/Right Menu](https://github.com/aryaxt/iOS-Slide-Menu#configuring-left-and-right-menu-for-different-viewcontrollers) |
| 8 | +- [Public Properties](https://github.com/aryaxt/iOS-Slide-Menu#public-properties) |
| 9 | +- [Public Methods](https://github.com/aryaxt/iOS-Slide-Menu#public-methods) |
| 10 | +- [Custom Animations](https://github.com/aryaxt/iOS-Slide-Menu#custom-animations) |
13 | 11 |
|
14 | 12 |  |
15 | 13 |
|
@@ -104,17 +102,6 @@ There are existing animation that can be used out of the box. These animation cl |
104 | 102 | SlideNavigationContorllerAnimatorSlideAndFade *alideAndFadeAnimator = [[SlideNavigationContorllerAnimatorSlideAndFade alloc] initWithMaximumFadeAlpha:.8 fadeColor:[UIColor redColor] andSlideMovement:100]; |
105 | 103 | [SlideNavigationController sharedInstance].menuRevealAnimator = alideAndFadeAnimator; |
106 | 104 | ``` |
107 | | -Custom Animations |
108 | | ---------- |
109 | | -SlideNavigationController allows custom reveal animations. In order to add custom animations create a new class implementing SlideNavigationContorllerAnimator protocol. For more information take a look at the existing animation classes. |
110 | | - |
111 | | -###### - (void)prepareMenuForAnimation:(Menu)menu; |
112 | | -This method gets called right before the menu is about to reveal |
113 | | -###### - (void)animateMenu:(Menu)menu withProgress:(CGFloat)progress; |
114 | | -This method gets called as the menu reveal occurs, and passes the progress to be used for animations(progress is between 0 and 1) |
115 | | -###### - (void)clear; |
116 | | -This method gets called if for any resons the instance of animator is being changed. For instance, the animator is changed from SlideNavigationContorllerAnimatorFade to SlideNavigationContorllerAnimatorSlide. In this method you should cleanup the state of the menu if neede. For instance if you added a view to the menu for reveal animation, you should remove it when clear gets called. |
117 | | -Public Methods |
118 | 105 | --------- |
119 | 106 | ###### + (SlideNavigationController *)sharedInstance; |
120 | 107 | Returns the singleton instance of SlideNavigationController |
@@ -144,3 +131,15 @@ Works exactly the same as toggleLeftMenu, but used to toggle left menu |
144 | 131 | ###### - (BOOL)isMenuOpen; |
145 | 132 | Returns a boolean stating whether the menu is open or not |
146 | 133 |
|
| 134 | +Custom Animations |
| 135 | +--------- |
| 136 | +SlideNavigationController allows custom reveal animations. In order to add custom animations create a new class implementing SlideNavigationContorllerAnimator protocol. For more information take a look at the existing animation classes. |
| 137 | + |
| 138 | +###### - (void)prepareMenuForAnimation:(Menu)menu; |
| 139 | +This method gets called right before the menu is about to reveal |
| 140 | +###### - (void)animateMenu:(Menu)menu withProgress:(CGFloat)progress; |
| 141 | +This method gets called as the menu reveal occurs, and passes the progress to be used for animations(progress is between 0 and 1) |
| 142 | +###### - (void)clear; |
| 143 | +This method gets called if for any resons the instance of animator is being changed. For instance, the animator is changed from SlideNavigationContorllerAnimatorFade to SlideNavigationContorllerAnimatorSlide. In this method you should cleanup the state of the menu if neede. For instance if you added a view to the menu for reveal animation, you should remove it when clear gets called. |
| 144 | +Public Methods |
| 145 | + |
0 commit comments