Android Indefinite Pager Indicator

A lightweight, plug-and-play indefinite pager indicator for RecyclerViews & ViewPagers.

Usage

Important Information

From now on, all the new updates will be published in jitpack.io.

To use the IndefinitePagerIndicator, simply add the gradle dependency to your module's build.gradle file:

implementation 'com.github.rbro112:Android-Indefinite-Pager-Indicator:Tag'

or

implementation 'com.github.wching:Android-Indefinite-Pager-Indicator:Tag'

both of them work 😃

Min SDK supported is version 16 - Jelly Bean.

Getting Started

Attaching the indicator to a RecyclerView / Viewpager / Viewpager2 takes only one line of code. After this, the Indefinite Pager Indicator will handle everything else.

RecyclerView

1. Add the IndefinitePagerIndicator view to your XML file

<com.rbrooks.indefinitepagerindicator.IndefinitePagerIndicator
        android:id="@+id/recyclerview_pager_indicator"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        ... 
        />

2. Find the view in your activity, fragment, etc.

findViewById(R.id.recyclerview_pager_indicator);

3. Attach the RecyclerView to your IndefinitePagerIndicator

indefinitePagerIndicator.attachToRecyclerView(recyclerView);

That's it! The IndefinitePagerIndicator will handle updating as your RecyclerView does.

ViewPager

1. Add the IndefinitePagerIndicator view to your XML file

<com.rbrooks.indefinitepagerindicator.IndefinitePagerIndicator
        android:id="@+id/viewpager_pager_indicator"
        android:layout_width="wrap_content"
        android:layout_height="wrap_content"
        ... 
        />

2. Find the view in your activity, fragment, etc.

findViewById(R.id.viewpager_pager_indicator);

3. Attach the ViewPager to your IndefinitePagerIndicator

indefinitePagerIndicator.attachToViewPager(viewPager);

That's it! The IndefinitePagerIndicator will handle updating as your ViewPager does.

The position of the ViewPager can also be changed programmatically with viewPager.setCurrentItem(position) and the IndefinitePagerIndicator will update successfully.

Sample

A sample application is included in the repository. To view the sample:

1. Clone the repository locally

git clone [email protected]:rbro112/Android-Indefinite-Pager-Indicator.git

2. Build and run the sample module.

Customizing

To customize the IndefinitePagerIndicator, modify any of the following attributes in the XML code (or set them programmatically) for your IndefinitePagerIndicator view.

Attribute	Explanation	Default Value	Example Code	Result
dotRadius	The radius of a dot indicator in DP.	4dp	indefinite_pager_indicator:dotRadius="8dp"
selectedDotRadius	The radius of the currently selected dot indicator in DP.	5.5dp	indefinite_pager_indicator:selectedDotRadius="6dp"
dotColor	The color of a dot indicator.	#e8e8e8	indefinite_pager_indicator:dotColor="#ff0000"
selectedDotColor	The color of the currently selected dot indicator.	#ffffff	indefinite_pager_indicator:selectedDotColor="#ff0000"
dotSeparation	The distance from edge to edge of each dot in DP.	10dp	indefinite_pager_indicator:dotSeparation="16dp"
dotCount	The number of large visible dot indicators at any time.	5	indefinite_pager_indicator:dotCount="3"
fadingDotCount	The number of dot indicators that fade towards the edge.	1	indefinite_pager_indicator:fadingDotCount="2"
supportRTL	Adds support for RTL ViewPagers	false	indefinite_pager_indicator:supportRTL="true"	If current layout mode is RTL, indicator will move from right to left with scrolling.
verticalSupport	Adds support for a vertical setup	false	indefinite_pager_indicator::verticalSupport="true"

If you would like to help, submit a PR! We have the following features pending:

• "Instagram" style -- Selected dot starts at the left of the view rather than starting in the center.

• Support for padding.

• Support for small drawables.

Notes

Follow us on Twitter: @rbro112 @wchingb

Let us know what you think!

Contributions encouraged and welcome!

License

MIT License

Copyright (c) 2022 Ryan Brooks

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.