Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/wching/Android-Indefinite-Pager-Indicator

A lightweight, plug-and-play indefinite pager indicator for RecyclerViews & ViewPagers.
https://github.com/wching/Android-Indefinite-Pager-Indicator

Last synced: 13 days ago
JSON representation

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

Host: GitHub
URL: https://github.com/wching/Android-Indefinite-Pager-Indicator
Owner: wching
License: mit
Created: 2017-11-03T19:57:05.000Z (about 7 years ago)
Default Branch: main
Last Pushed: 2023-05-23T19:10:42.000Z (over 1 year ago)
Last Synced: 2024-05-23T10:05:12.111Z (6 months ago)
Language: Kotlin
Homepage:
Size: 32.8 MB
Stars: 1,572
Watchers: 24
Forks: 149
Open Issues: 9
Metadata Files:
- Readme: README.md
- License: LICENSE

Awesome Lists containing this project

awesome-kotlin - Android-Indefinite-Pager-Indicator - A lightweight, plug-and-play indefinite pager indicator for RecyclerViews & ViewPagers. (Libraries)

README

# Android Indefinite Pager Indicator

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

![GIF Preview](/readme_assets/preview.gif)

# Usage

![Release](https://jitpack.io/v/rbro112/Android-Indefinite-Pager-Indicator.svg)

## Important Information

From now on, all the new updates will be published in [jitpack.io](https://jitpack.io/#rbro112/Android-Indefinite-Pager-Indicator).

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

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

```groovy
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

```xml

```

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

```java
findViewById(R.id.recyclerview_pager_indicator);
```

3. Attach the RecyclerView to your IndefinitePagerIndicator

```java
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

```xml

```

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

```java
findViewById(R.id.viewpager_pager_indicator);
```

3. Attach the ViewPager to your IndefinitePagerIndicator

```java
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
```shell
git clone [email protected]:rbro112/Android-Indefinite-Pager-Indicator.git
```

2. Build and run the sample module.

![Alt text](/readme_assets/run_sample.png "run sample")

## 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"` | ![Alt text](/readme_assets/dot_radius_sample.png "dotRadius") |
| selectedDotRadius | The radius of the currently selected dot indicator in DP. | 5.5dp | `indefinite_pager_indicator:selectedDotRadius="6dp"` | ![Alt text](/readme_assets/selected_dot_radius_sample.png "selectedDotRadius") |
| dotColor | The color of a dot indicator. | #e8e8e8 | `indefinite_pager_indicator:dotColor="#ff0000"` | ![Alt text](/readme_assets/dot_color_sample.png "dotColor") |
| selectedDotColor | The color of the currently selected dot indicator. | #ffffff | `indefinite_pager_indicator:selectedDotColor="#ff0000"` | ![Alt text](/readme_assets/selected_dot_color_sample.png "selectedDotColor") |
| dotSeparation | The distance from edge to edge of each dot in DP. | 10dp | `indefinite_pager_indicator:dotSeparation="16dp"` | ![Alt text](/readme_assets/dot_separation_sample.png "dotSeparation") |
| dotCount | The number of large visible dot indicators at any time. | 5 | `indefinite_pager_indicator:dotCount="3"` | ![Alt text](/readme_assets/dot_count_sample.png "dotCount") |
| fadingDotCount | The number of dot indicators that fade towards the edge. | 1 | `indefinite_pager_indicator:fadingDotCount="2"` | ![Alt text](/readme_assets/fading_dot_count_sample.png "fadingDotCount") |
| 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"` | ![](https://cldup.com/37xl-LPeNw.png) |

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

Let us know what you think!

Contributions encouraged and welcome!

## License
```
MIT License

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.
```