You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+32-2Lines changed: 32 additions & 2 deletions
Original file line number
Diff line number
Diff line change
@@ -17,13 +17,22 @@ It supports following customization:
17
17
18
18
All these parameters could vary for different orientations.
19
19
20
+
## Communication
21
+
22
+
- If you **need help or found a bug**, please, open an issue.
23
+
- If you **have a feature request**, open an issue.
24
+
- If you **are ready to contribute**, submit a pull request.
25
+
- If you **like Interactive Side Menu**, please, give it a star.
26
+
- If you **use Interactive Side Menu in your application published to AppStore**, [send us a link](https://github.com/handsomecode/InteractiveSideMenu/issues/new) and we'll create the list with applications used our library.
27
+
20
28
# Installation
21
29
22
30
## CocoaPods
23
31
To install it through [CocoaPods](https://cocoapods.org/), add the following line to your Podfile:
24
32
```
25
33
pod 'InteractiveSideMenu'
26
34
```
35
+
Please, don't forget to run `pod update` command to update your local specs repository during migration from one version to another.
27
36
28
37
## Carthage
29
38
To install it through [Carthage](https://github.com/Carthage/Carthage), add the following line to your Cartfile:
@@ -40,6 +49,7 @@ To implement your side menu you should create subclasses of basic View Controlle
40
49
Also, ensure that every menu item ViewController adopts relevant protocol.
41
50
-```SideMenuItemContent``` is a ViewController's protocol for data that corresponds menu item
42
51
52
+
## HostViewController implementation
43
53
To setup your side menu you need to do three things:
44
54
- Provide implementation of base ```MenuViewController``` and assing it to ```menuViewController``` property
45
55
- Provide implementation of menu content and assing array of content controllers to ```contentViewControllers``` property
@@ -66,6 +76,7 @@ class HostViewController: MenuContainerViewController {
66
76
}
67
77
```
68
78
79
+
## Items content
69
80
To show menu, call ```showSideMenu()``` method from `SideMenuItemContent` protocol.
70
81
```swift
71
82
importInteractiveSideMenu
@@ -80,13 +91,32 @@ class KittyViewController: UIViewController, SideMenuItemContent {
80
91
81
92
To change content view, choose desired content controller and hide menu.
To use menu with **TabBar** or **NavigationController**, ensure that you indicate UITabBarController or UINavigationController as item content directly, not any corresponding ViewControllers.
Please, find UITabBarController implementation details in [Sample](./Sample).
118
+
119
+
## Animation Customization
90
120
To customize animation for menu opening or closing, update ```transitionOptions``` property that is available in ```MenuContainerViewColtroller``` class. Initial setup could be done, for example, on controller's ```viewDidLoad()```.
0 commit comments