Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/rubensousa/GravitySnapHelper
A SnapHelper that snaps a RecyclerView to an edge.
https://github.com/rubensousa/GravitySnapHelper
recyclerview snapping
Last synced: about 1 month ago
JSON representation
A SnapHelper that snaps a RecyclerView to an edge.
- Host: GitHub
- URL: https://github.com/rubensousa/GravitySnapHelper
- Owner: rubensousa
- License: apache-2.0
- Created: 2016-08-31T07:25:23.000Z (over 8 years ago)
- Default Branch: master
- Last Pushed: 2022-01-24T11:27:08.000Z (almost 3 years ago)
- Last Synced: 2024-10-29T15:40:01.524Z (about 1 month ago)
- Topics: recyclerview, snapping
- Language: Java
- Homepage:
- Size: 79.2 MB
- Stars: 4,998
- Watchers: 96
- Forks: 616
- Open Issues: 6
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG.md
- License: LICENSE.txt
Awesome Lists containing this project
- awesome - GravitySnapHelper - A SnapHelper that snaps a RecyclerView to an edge. (snapping)
- awesome - GravitySnapHelper - A SnapHelper that snaps a RecyclerView to an edge. (recyclerview)
README
# GravitySnapHelper
A SnapHelper that snaps a RecyclerView to an edge.
## Setup
Add this to your build.gradle:
```groovy
implementation 'com.github.rubensousa:gravitysnaphelper:2.2.2'
```
## How to use
You can either create a GravitySnapHelper, or use GravitySnapRecyclerView.
If you want to use GravitySnapHelper directly,
you just need to create it and attach it to your RecyclerView:
```kotlin
val snapHelper = GravitySnapHelper(Gravity.START)
snapHelper.attachToRecyclerView(recyclerView)
```
If you want to use GravitySnapRecyclerView, you can use the following xml attributes for customisation:
```xml
```
Example:
```xml
```
## Start snapping
```kotlin
val snapHelper = GravitySnapHelper(Gravity.START)
snapHelper.attachToRecyclerView(recyclerView)
```
## Center snapping
```kotlin
val snapHelper = GravitySnapHelper(Gravity.CENTER)
snapHelper.attachToRecyclerView(recyclerView)
```
## Limiting fling distance
If you use **setMaxFlingSizeFraction** or **setMaxFlingDistance**
you can change the maximum fling distance allowed.
## With decoration
## Features
1. **setMaxFlingDistance** or **setMaxFlingSizeFraction** - changes the max fling distance allowed.
2. **setScrollMsPerInch** - changes the scroll speed.
3. **setGravity** - changes the gravity of the SnapHelper.
4. **setSnapToPadding** - enables snapping to padding (default is false)
5. **smoothScrollToPosition** and **scrollToPosition**
6. RTL support out of the box
## Nested RecyclerViews
Take a look at these blog posts if you're using nested RecyclerViews
1. [Improving scrolling behavior of nested RecyclerViews](https://rubensousa.com/2019/08/16/nested_recyclerview_part1/)
2. [Saving scroll state of nested RecyclerViews](https://rubensousa.com/2019/08/27/saving_scroll_state_of_nested_recyclerviews/)
## License
Copyright 2018 The Android Open Source Project
Copyright 2019 Rúben Sousa
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.