https://github.com/futuremind/recycler-fast-scroll
Provides fast scroll and section idexer for recycler view
https://github.com/futuremind/recycler-fast-scroll
alphabetindexer- android bubble fastscroll recyclerview recyclerview-adapter scrolling
Last synced: 18 days ago
JSON representation
Provides fast scroll and section idexer for recycler view
- Host: GitHub
- URL: https://github.com/futuremind/recycler-fast-scroll
- Owner: FutureMind
- License: apache-2.0
- Created: 2015-07-31T09:35:24.000Z (over 9 years ago)
- Default Branch: master
- Last Pushed: 2021-09-22T17:25:21.000Z (over 3 years ago)
- Last Synced: 2025-03-29T03:08:34.352Z (25 days ago)
- Topics: alphabetindexer-, android, bubble, fastscroll, recyclerview, recyclerview-adapter, scrolling
- Language: Java
- Size: 241 KB
- Stars: 495
- Watchers: 25
- Forks: 107
- Open Issues: 35
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Deprecation notice
With significant changes to recyclerview and stable jetpack compose being released, this project will no longer be maintained.
# Recycler Bubble
Provides fast scroll and section indexer for recycler view. Uses a different mechanism than similar libraries to provide smooth movement of scroller handle when scrolling the list. Can be used with vertical and horizontal RecyclerViews. You can style it or even use a custom layout and animations for your fast scroll handle and bubble.
## Usage
### Minimal working example
In your layout file:
```xml
```
In Activity/Fragment:
```java
recyclerView = (RecyclerView) findViewById(R.id.recyclerview);
fastScroller = (FastScroller) findViewById(R.id.fastscroll);
recyclerView.setLayoutManager(new LinearLayoutManager(this));
recyclerView.setAdapter(adapter);
//has to be called AFTER RecyclerView.setAdapter()
fastScroller.setRecyclerView(recyclerView);
```
In your `RecyclerView.Adapter`
```java
public class MyAdapter ... implements SectionTitleProvider{
...
@Override
public String getSectionTitle(int position) {
//this String will be shown in a bubble for specified position
return getItem(position).substring(0, 1);
}
}
```
**Note**: You have to populate your adapter with enough items for the `FastScroll` to show. I has an auto-hide mechanism in case there is nothing to scroll.
### Horizontal orientation
You can use this library with horizontal LayoutManager. To do it use android:orientation="horizontal" attribute:
```xml
```
### Styling
Styling was introduced in version 0.1.5 with a limited set of styleable attributes. More are on their way.
You can style the attributes in the xml layout:
```xml
```
Or directly in the code:
```java
fastScroller.setBubbleColor(0xffff0000);
fastScroller.setHandleColor(0xffff0000);
fastScroller.setBubbleTextAppearance(R.style.StyledScrollerTextAppearance);
```
See the example code for more info.
### Custom views
You can set custom layouts and animations for your handle and bubble, using:
```java
myViewProvider = new MyScrollerViewProvider();
fastScroller.setViewProvider(myViewProvider);
```
For more information, consult [`CustomScrollerViewProvider`](/example/src/main/java/com/futuremind/recyclerviewfastscroll/example/customview/CustomScrollerViewProvider.java) in the example code.
## Download
Download via Gradle:
```groovy
compile 'com.futuremind.recyclerfastscroll:fastscroll:0.2.5'
```
## License
Copyright 2015 Future Mind
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.