Skip to content

Commit 78ab248

Browse files
committed
update readme
1 parent 8a67c8f commit 78ab248

12 files changed

+16
-9
lines changed

README.md

+16-9
Original file line numberDiff line numberDiff line change
@@ -7,27 +7,34 @@ Walkthrough
77
Following screenshots have been taken from the sample application: [<img src="http://developer.android.com/images/brand/en_generic_rgb_wo_45.png"/>][1]
88

99
<p align="center">
10-
<img src="https://github.com/vikramkakkar/SublimePicker/blob/master/img/app_info.png?raw=true" width="307" height="512" />
10+
<img src="https://github.com/vikramkakkar/SublimeNavigationView/blob/master/img/app_info.png?raw=true" width="428" height="829" />
1111
</p>
1212

1313
How the menu looks:
1414

1515
<p align="center">
16-
<img src="https://github.com/vikramkakkar/SublimePicker/blob/master/img/first_menu.png?raw=true" width="307" height="512" />
16+
<img src="https://github.com/vikramkakkar/SublimeNavigationView/blob/master/img/first_menu.png?raw=true" width="307" height="512" />
1717
</p>
1818

1919
`SublimeNavigationView` can work with any number of menus. As an example of this, the sample application shows how to handle two of them:
2020

2121
<p align="center">
22-
<img src="https://github.com/vikramkakkar/SublimePicker/blob/master/img/second_menu.png?raw=true" width="307" height="512" />
22+
<img src="https://github.com/vikramkakkar/SublimeNavigationView/blob/master/img/second_menu.png?raw=true" width="307" height="512" />
23+
</p>
24+
25+
Switching between menus:
26+
27+
<p align="center">
28+
<img src="https://github.com/vikramkakkar/SublimeNavigationView/blob/master/img/switch_menus_first_menu.png?raw=true" width="307" height="512" />
29+
<img src="https://github.com/vikramkakkar/SublimeNavigationView/blob/master/img/switch_menus_second_menu.png?raw=true" width="307" height="512" />
2330
</p>
2431

2532
`SublimeMenu` supports grouping of menu items. In addition to the standard features such as defining a `checkable` policy, ordering etc., `SublimeGroup` can be expanded/collapsed - on user input, through XML definition, or programmatically:
2633

2734
<p align="center">
2835
<span>
29-
<img src="https://github.com/vikramkakkar/SublimePicker/blob/master/img/group_collpased.png?raw=true" width="307" height="512" />
30-
<img src="https://github.com/vikramkakkar/SublimePicker/blob/master/img/group_expanded.png?raw=true" width="307" height="512" />
36+
<img src="https://github.com/vikramkakkar/SublimeNavigationView/blob/master/img/group_collpased.png?raw=true" width="307" height="512" />
37+
<img src="https://github.com/vikramkakkar/SublimeNavigationView/blob/master/img/group_expanded.png?raw=true" width="307" height="512" />
3138
</span>
3239
</p>
3340

@@ -41,7 +48,7 @@ XML definitions are quite straight-forward. An example:
4148
This would translate to:
4249

4350
<p align="center">
44-
<img src="https://github.com/vikramkakkar/SublimePicker/blob/master/img/item_with_hint.png?raw=true" width="307" height="512" />
51+
<img src="https://github.com/vikramkakkar/SublimeNavigationView/blob/master/img/item_with_hint.png?raw=true" width="307" height="512" />
4552
</p>
4653

4754
A `Text` item with an icon - and another, that shows icon space, but doesn't display an icon:
@@ -60,7 +67,7 @@ A `Text` item with an icon - and another, that shows icon space, but doesn't dis
6067
Output:
6168

6269
<p align="center">
63-
<img src="https://github.com/vikramkakkar/SublimePicker/blob/master/img/item_with_icon.png?raw=true" width="307" height="512" />
70+
<img src="https://github.com/vikramkakkar/SublimeNavigationView/blob/master/img/item_with_icon.png?raw=true" width="307" height="512" />
6471
</p>
6572

6673
`TextWithBadge` menu items can be presented in two forms - initialized & uninitialized. In uninitialized form, the item will display an indeterminate `ProgressBar` in place of `badgeText`:
@@ -71,7 +78,7 @@ Output:
7178
app:valueProvidedAsync="true"/>
7279

7380
<p align="center">
74-
<img src="https://github.com/vikramkakkar/SublimePicker/blob/master/img/text_with_badge_uninitialized.png?raw=true" width="307" height="512" />
81+
<img src="https://github.com/vikramkakkar/SublimeNavigationView/blob/master/img/text_with_badge_uninitialized.png?raw=true" width="307" height="512" />
7582
</p>
7683

7784
In initialized form, the item will have its `badgeText` set in XML:
@@ -82,7 +89,7 @@ In initialized form, the item will have its `badgeText` set in XML:
8289
app:badgeText="25"/>
8390

8491
<p align="center">
85-
<img src="https://github.com/vikramkakkar/SublimePicker/blob/master/img/text_with_badge_initialized.png?raw=true" width="307" height="512" />
92+
<img src="https://github.com/vikramkakkar/SublimeNavigationView/blob/master/img/text_with_badge_initialized.png?raw=true" width="307" height="512" />
8693
</p>
8794

8895
This feature can be used if the `badgeText` is being retrieved through a network call, or if some computation needs to be performed before it can be displayed. Once the text is available, you can display it using:

img/app_info.png

535 KB
Loading

img/first_menu.png

703 KB
Loading

img/group_collapsed.png

9.72 KB
Loading

img/group_expanded.png

32 KB
Loading

img/item_with_hint.png

9.11 KB
Loading

img/item_with_icon.png

18.3 KB
Loading

img/second_menu.png

685 KB
Loading

img/switch_menus_first_menu.png

182 KB
Loading

img/switch_menus_second_menu.png

173 KB
Loading

img/text_with_badge_initialized.png

7.59 KB
Loading

img/text_with_badge_uninitialized.png

7.57 KB
Loading

0 commit comments

Comments
 (0)