Skip to content

Commit 8fe0489

Browse files
Update README.md
1 parent 0e165f0 commit 8fe0489

1 file changed

Lines changed: 21 additions & 7 deletions

File tree

README.md

Lines changed: 21 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -1,11 +1,11 @@
11
# BottomSheetMenu [![Release](https://jitpack.io/v/buggysofts-com/BottomSheetMenu.svg)](https://jitpack.io/#buggysofts-com/BottomSheetMenu)
2+
23
A powerful & customizable menu implementation for android. It supports any level of nested menu structures along with custom header and footer views, and much more. Follow the steps below to import the library to your project. You will also find some sample codes.
34

45
<br />
56

67
## Import
7-
8-
#### Add JitPack repository to your project level build.gradle file
8+
Add JitPack repository to your project level build.gradle file
99
```
1010
...
1111
@@ -16,8 +16,7 @@ allprojects {
1616
}
1717
}
1818
```
19-
20-
#### Or, in newer android projects, if you need to the add repository in settings.gradle file...
19+
Or, in newer android projects, if you need to the add repository in settings.gradle file...
2120
```
2221
...
2322
@@ -29,8 +28,7 @@ dependencyResolutionManagement {
2928
}
3029
}
3130
```
32-
33-
#### Finally add this dependency to your app/module level build.gradle file
31+
Finally, add this dependency to your app/module level build.gradle file
3432
```
3533
...
3634
@@ -123,5 +121,21 @@ bottomSheetMenu
123121
```
124122
The above code selects different views for different selected menu item(having submenu). Also, it selects an initial header view. Similarly, you can set footer views with ```footerViewSelector(...)``` method.
125123

124+
<br />
125+
126+
## Images
127+
Here are some example images of the menu containing a header and a footer view. The one above the top divider line is the header view, and the one below the bottom divider line is the footer view. You can select your desider header or footer views, or customize the menu styles and behaviours by following the topics above. Note, the styling applied to the menu does not apply on header and footer views, they are external views and you should apply necessary styling to them before using them in the menu.
128+
129+
Root menu:
130+
![Root menu](/app/src/main/res/drawable/root_menu.png)
131+
132+
Nested submenu:
133+
![Nested submenu](/app/src/main/res/drawable/menu_level_2.png)
134+
135+
136+
<br />
137+
<br />
138+
139+
Please share & rate the library if you find it useful.
126140

127-
#### Happy Coding!
141+
### Happy coding!

0 commit comments

Comments
 (0)