Skip to content

Commit 392a326

Browse files
committed
Update docs - add gif of widget showcase, image of old fashioned/classic behavior,
1 parent d18174b commit 392a326

File tree

3 files changed

+19
-12
lines changed

3 files changed

+19
-12
lines changed

README.md

Lines changed: 19 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -3,30 +3,37 @@
33
[![Download](https://api.bintray.com/packages/intik/cz.intik/overflowpagerindicator/images/download.svg)](https://bintray.com/intik/cz.intik/overflowpagerindicator/_latestVersion)
44
[![license](https://img.shields.io/badge/license-MIT%20license-blue.svg)](https://github.com/intik/overflow-pager-indicator/blob/master/LICENSE)
55

6-
Overflow Pager Indicator is a simple widget for recycler view - displaying dots indicators of
7-
currently selected page - with some fancy animation when dataset is large.
6+
Simple widget for recycler view - displaying dots indicators of currently selected page -
7+
with some fancy animation when dataset is large.
88

9-
When the dataset in recycler view is large it displays only fixed amount of dots centered around
10-
currently selected page with a nice little scaling animation of indicators on the edges. Provides
11-
fluent animation of selecting new page.
9+
**Large dataset** displays only fixed amount of dots centered around currently selected page
10+
with a nice little scaling animation of indicators on the edges. Provides fluent animation of
11+
selecting new page.
1212

13-
If dataset in recycler view is small it displays classic dot indicators line with currently selected
14-
page highlighted.
13+
**Small dataset** displays classic dot indicators line with currently selected page highlighted.
1514

1615
RecyclerView should be configured with snapping to pages vie PagerSnapHelper subclass ~ simulates
1716
behavior of classic ViewPager
1817

19-
# Usage
18+
## Widget preview
2019

21-
## Gradle dependency
20+
| :heavy_check_mark: Overflowed indicators | :x: Classic confusing indicators |
21+
| ----------------------- | ------------------------------- |
22+
| ![Widget effect animation preview](docs/images/overflow-pager-indicator.gif "Preview of widget effect of animating dots during pages swiping") | ![Classic ](docs/images/classic-indicators.png "Fujky") |
23+
24+
_Disclaimer: Having too many pages in recycler means that user needs to swipe a lot. Different layout/ui may be more user friendly._
25+
26+
## Usage
27+
28+
### Gradle dependency
2229

2330
In your gradle add dependency:
2431

2532
```gradle
26-
compile 'cz.intik:overflow-pager-indicator:1.1.1'
33+
compile "cz.intik:overflow-pager-indicator:$latestVersion"
2734
```
2835

29-
## Layout
36+
### Layout
3037

3138
Some layout with RecyclerView and OverflowPagerIndicator
3239

@@ -52,7 +59,7 @@ Some layout with RecyclerView and OverflowPagerIndicator
5259
</FrameLayout>
5360
```
5461

55-
## Code
62+
### Code
5663

5764
Attach
5865
[OverflowPagerIndicator](https://github.com/intik/overflow-pager-indicator/blob/docs-update/library/src/main/java/cz/intik/overflowindicator/OverflowPagerIndicator.java)

docs/images/classic-indicators.png

7.56 KB
Loading
528 KB
Loading

0 commit comments

Comments
 (0)