Ecosyste.ms: Awesome

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

Awesome Lists | Featured Topics | Projects

https://github.com/myinnos/alphabetindex-fast-scroll-recyclerview

A Powerful AlphabetIndex FastScroller Library for Android's RecyclerView!
https://github.com/myinnos/alphabetindex-fast-scroll-recyclerview

alphabetindex-fastscroller android android-recyclerview indexing kotlin recyclerview

Last synced: 4 days ago
JSON representation

A Powerful AlphabetIndex FastScroller Library for Android's RecyclerView!

Awesome Lists containing this project

README

        

# AlphabetIndex Fast Scroll RecyclerView
A Powerful AlphabetIndex FastScroller for Android's RecyclerView!

[![](https://jitpack.io/v/myinnos/AlphabetIndex-Fast-Scroll-RecyclerView.svg)](https://jitpack.io/#myinnos/AlphabetIndex-Fast-Scroll-RecyclerView) [![MyInnos website](https://img.shields.io/badge/visit-website-red.svg?logo=firefox)](https://www.myinnos.in/) [![](https://jitpack.io/v/jitpack/maven-simple/month.svg)](https://jitpack.io/#myinnos/AlphabetIndex-Fast-Scroll-RecyclerView) Android Language Badge

![AlphabetIndex-Fast-Scroll-RecyclerView - Example1](https://raw.githubusercontent.com/myinnos/AlphabetIndex-Fast-Scroll-RecyclerView/0d6c4f2f0b9f3b573a4f2abf2c87b62237081286/images-gif/AlphabetIndex-Fast-Scroll-RecyclerView_1.gif)
![AlphabetIndex-Fast-Scroll-RecyclerView - Example2](https://raw.githubusercontent.com/myinnos/AlphabetIndex-Fast-Scroll-RecyclerView/0d6c4f2f0b9f3b573a4f2abf2c87b62237081286/images-gif/AlphabetIndex-Fast-Scroll-RecyclerView_2.gif)
![AlphabetIndex-Fast-Scroll-RecyclerView - Example3](https://raw.githubusercontent.com/myinnos/AlphabetIndex-Fast-Scroll-RecyclerView/master/images-gif/AlphabetIndex-Fast-Scroll-RecyclerView_3.gif)

#### Kindly use the following links to use this library:

In build.gradle (Project)
```java
allprojects {
repositories {
...
maven { url "https://jitpack.io" }
}
}
```
And then in the other gradle file(may be your app gradle or your own module library gradle, but never add in both of them to avoid conflict.)
```java
dependencies {
implementation 'com.github.myinnos:AlphabetIndex-Fast-Scroll-RecyclerView:2.0'

// AppCompat version
// implementation 'com.github.myinnos:AlphabetIndex-Fast-Scroll-RecyclerView:1.0.92'
// or
// AndroidX version
// implementation 'com.github.myinnos:AlphabetIndex-Fast-Scroll-RecyclerView:1.0.95'

}
```
How to use
-----
**Step 1:** add this to your xml:
```xml

```
**Step 2:** implement SectionIndexer to RecyclerViewAdapter.
```java
public class RecyclerViewAdapter extends RecyclerView.Adapter implements SectionIndexer {

private List mDataArray;
private ArrayList mSectionPositions;

.....

@Override
public int getSectionForPosition(int position) {
return 0;
}

@Override
public Object[] getSections() {
List sections = new ArrayList<>(26);
mSectionPositions = new ArrayList<>(26);
for (int i = 0, size = mDataArray.size(); i < size; i++) {
String section = String.valueOf(mDataArray.get(i).charAt(0)).toUpperCase();
if (!sections.contains(section)) {
sections.add(section);
mSectionPositions.add(i);
}
}
return sections.toArray(new String[0]);
}

@Override
public int getPositionForSection(int sectionIndex) {
return mSectionPositions.get(sectionIndex);
}

}
```
#### Note: mDataArray: this is your recycler data array model.

Features
-----
- Change IndexTextSize:
```java
mRecyclerView.setIndexTextSize(12);
```
- Change IndexBarTextColor:
```java
mRecyclerView.setIndexBarTextColor("#FFFFFF");

mRecyclerView.setIndexBarTextColor(R.color.index_bar_text_color);
```
- Change IndexBarColor:
```java
mRecyclerView.setIndexBarColor("#33334c");

mRecyclerView.setIndexBarColor(R.color.index_bar_color);
```
- Change IndexBarCornerRadius:
```java
mRecyclerView.setIndexBarCornerRadius(3);
```
- Change IndexBarTransparentValue:
```java
mRecyclerView.setIndexBarTransparentValue((float) 0.4);
```
- Change IndexBarMargin:
```java
mRecyclerView.setIndexBarMargin(4);
```
- Change IndexBarWidth:
```java
mRecyclerView.setIndexBarWidth(40);
```
- Change PreviewPadding:
```java
mRecyclerView.setPreviewPadding(2);
```
- Change PreviewVisibility:
```java
mRecyclerView.setPreviewVisibility(false);
```
- Change Typeface:
```java
Typeface typeface = Typeface.createFromAsset(context.getAssets(), "Custom-Font.ttf");
mRecyclerView.setTypeface(typeface);
```
- To hide/show Fast Scroll IndexBar:
```java
mRecyclerView.setIndexBarVisibility(true);
```
- Change IndexBarHighLateTextColor:
```java
mRecyclerView.setIndexBarHighLightTextColor("#33334c);

mRecyclerView.setIndexBarHighLightTextColor(R.color.index_bar_highlight_text_color);
```
- To hide/show IndexBarHighLightText:
```java
mRecyclerView.setIndexBarHighLightTextVisibility(true);
```
- To hide/show IndexBarStroke:
```java
mRecyclerView.setIndexBarStrokeVisibility(true);
```
- Change IndexBarStrokeWidth:
```java
mRecyclerView.setIndexBarStrokeWidth(1);
```
- Change IndexBarStrokeColor:
```java
mRecyclerView.setIndexBarStrokeColor("#000000");
```

Compatibility
-----
This library works with any layout manager but is optimized for the use with a LinearLayoutManager.

##### Any Queries? or Feedback, please let me know by opening a [new issue](https://github.com/myinnos/AlphabetIndex-Fast-Scroll-RecyclerView/issues/new)!

## Contact
#### Prabhakar Thota
* :globe_with_meridians: Website: [myinnos.in](http://www.myinnos.in "Prabhakar Thota")
* :email: e-mail: [email protected]
* :mag_right: LinkedIn: [PrabhakarThota](https://www.linkedin.com/in/prabhakarthota "Prabhakar Thota on LinkedIn")
* :thumbsup: Twitter: [@myinnos](https://twitter.com/myinnos "Prabhakar Thota on twitter")
* :camera: Instagram: [@prabhakar_t_](https://www.instagram.com/prabhakar_t_/ "Prabhakar Thota on Instagram")

>⚡ If you appreciate my work, consider buying me a cup of :coffee: to keep me recharged :metal: by [GitHub](https://github.com/sponsors/myinnos) or [PayPal](https://www.paypal.me/fansfolio)

### Contributing

Thanks to all the people who contributed to AlphabetIndex Fast Scroll RecyclerView



License
-------

Copyright 2017 - 2022 MyInnos

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.