Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/romandanylyk/PageIndicatorView
An page indicator for Android ViewPager
https://github.com/romandanylyk/PageIndicatorView
android pageindicatorview viewpager viewpager-indicator viewpagerindicator
Last synced: 1 day ago
JSON representation
An page indicator for Android ViewPager
- Host: GitHub
- URL: https://github.com/romandanylyk/PageIndicatorView
- Owner: romandanylyk
- Created: 2016-08-20T19:25:32.000Z (about 8 years ago)
- Default Branch: master
- Last Pushed: 2021-10-15T05:11:14.000Z (about 3 years ago)
- Last Synced: 2024-08-02T19:35:47.337Z (3 months ago)
- Topics: android, pageindicatorview, viewpager, viewpager-indicator, viewpagerindicator
- Language: Java
- Homepage:
- Size: 32.4 MB
- Stars: 4,620
- Watchers: 105
- Forks: 551
- Open Issues: 55
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
- awesome-list - romandanylyk/PageIndicatorView - An page indicator for Android ViewPager (Java)
- awesome-github-android-ui - PageIndicatorView - 能够指示选定页的ViewPage (ViewPager)
README
### **PageIndicatorView**
[  ](https://bintray.com/romandanylyk/maven/pageindicatorview/_latestVersion)[](https://android-arsenal.com/details/1/4555)
[](https://android-arsenal.com/api?level=14)
`PageIndicatorView` is light library to indicate ViewPager's selected page with different animations and ability to customise it as you need.
### **Integration**
To add `pageindicatorview` to your project, first make sure in root `build.gradle` you have specified the following repository:
```groovy
repositories {
jcenter()
}
```
>***Note***: by creating new project in Android Studio it will have `jcenter` repository specified by default, so you will not need to add it manually.
Once you make sure you have `jcenter` repository in your project, all you need to do is to add the following line in `dependencies` section of your project `build.gradle`.
See latest library version [  ](https://bintray.com/romandanylyk/maven/pageindicatorview/_latestVersion)
```groovy
implementation 'com.romandanylyk:pageindicatorview:X.X.X'
```
If your project already use `appcompat-v7` support library, you can omit `PageIndicatorView` dependencies by adding a single .aar file to your project, that will decrease total amount of methods used in your project.
```groovy
implementation 'com.romandanylyk:pageindicatorview:X.X.X@aar'
```
Keep in mind, that `PageIndicatorView` has min [API level 14](https://developer.android.com/about/dashboards/index.html) and these dependencies:
```groovy
implementation 'com.android.support:appcompat-v7:27.1.1'
implementation 'com.android.support:recyclerview-v7:27.1.1'
implementation 'com.android.support:support-core-ui:27.1.1'
```
### **Usage Sample**
Usage of `PageIndicatorView` is quite simple. All you need to do is to declare a view in your `layout.xml` and call `setSelection` method to select specific indicator - that's it!
```java
PageIndicatorView pageIndicatorView = findViewById(R.id.pageIndicatorView);
pageIndicatorView.setCount(5); // specify total count of indicators
pageIndicatorView.setSelection(2);
```
But if you're as lazy as I'm - then there is another option to handle `PageIndicatorView`
```xml
```
All the `piv_` attributes here are specific for `PageIndicatorView` so you can customise it as you want with attributes - pretty handy.
But what is more important here is `app:piv_viewPager="@id/viewPager"`.
What it actually do is catch up your `ViewPager` and automatically handles all the event's to selected the right page - so you don't need to call `setSelection` method on your own.
Another handy options here that works with your `ViewPager` as a whole is
`app:piv_dynamicCount="true"` and ` app:piv_interactiveAnimation="true"`
Dynamic count will automatically updates `PageIndicatorView` total count as you updates pages count in your `ViewPager` - so that's pretty useful.
While interactive animation will progress the animation process within your swipe position, which makes animation more natural and responsive to end user.
> ***Note***: Because `setViewPagerId` uses an instance of `ViewPager`, using it in recycler could lead to id conflicts, so `PageIndicatorView` will not know properly what is the right `ViewPager` to work with. Instead you should handle selected indicators on your own programatically.
```java
pager.addOnPageChangeListener(new ViewPager.OnPageChangeListener() {
@Override
public void onPageScrolled(int position, float positionOffset, int positionOffsetPixels) {/*empty*/}
@Override
public void onPageSelected(int position) {
pageIndicatorView.setSelection(position);
}
@Override
public void onPageScrollStateChanged(int state) {/*empty*/}
});
```
Here you can see all the animations `PageIndicatorView` support.
Name| Support version| Preview
-------- | --- | ---
`AnimationType.NONE`| 0.0.1 | 
`AnimationType.COLOR`| 0.0.1 |
`AnimationType.SCALE`| 0.0.1 |
`AnimationType.SLIDE`| 0.0.1 |
`AnimationType.WORM`| 0.0.1 |
`AnimationType.FILL`| 0.0.6 |
`AnimationType.THIN_WORM`| 0.0.7 |
`AnimationType.DROP`| 0.1.0 |
`AnimationType.SWAP`| 0.1.1 |
### **Release Note**
See release notes on [github releases](https://github.com/romandanylyk/PageIndicatorView/releases) or [Bintray release notes](https://bintray.com/romandanylyk/maven/pageindicatorview#release).
### **License**
Copyright 2017 Roman Danylyk
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.