Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/mukeshsolanki/liquidrefreshlayout
Liquid Refresh Layout is a simple SwipeToRefresh library that helps you easily integrate SwipeToRefresh and performs simple clean liquid animation
https://github.com/mukeshsolanki/liquidrefreshlayout
android gradle java kotlin library pull-to-refresh refreshlayout swipetorefresh
Last synced: about 2 months ago
JSON representation
Liquid Refresh Layout is a simple SwipeToRefresh library that helps you easily integrate SwipeToRefresh and performs simple clean liquid animation
- Host: GitHub
- URL: https://github.com/mukeshsolanki/liquidrefreshlayout
- Owner: mukeshsolanki
- License: mit
- Created: 2018-04-20T12:37:17.000Z (over 6 years ago)
- Default Branch: master
- Last Pushed: 2020-09-13T12:47:54.000Z (over 4 years ago)
- Last Synced: 2024-05-02T05:23:06.843Z (8 months ago)
- Topics: android, gradle, java, kotlin, library, pull-to-refresh, refreshlayout, swipetorefresh
- Language: Kotlin
- Homepage:
- Size: 4.76 MB
- Stars: 128
- Watchers: 8
- Forks: 16
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
Liquid Refresh Layout - Android
Liquid Refresh Layout is a simple SwipeToRefresh library that helps you easily integrate SwipeToRefresh and performs simple clean liquid animation.
# Supporting Liquid Refresh Layout
Liquid Refresh Layout is an independent project with ongoing development and support made possible thanks to donations made by [these awesome backers](BACKERS.md#sponsors). If you'd like to join them, please consider:
- [Become a backer or sponsor on Patreon](https://www.patreon.com/mukeshsolanki).
- [One-time donation via PayPal](https://www.paypal.me/mukeshsolanki)
## Getting started
Its really simple to integrate *Liquid Refresh Layout* in android. All you need to do make the following change to you build gradle.
Step 1. Add the JitPack repository to your build file. Add it in your root build.gradle at the end of repositories:
```java
allprojects {
repositories {
...
maven { url "https://jitpack.io" }
}
}
```
Step 2. Add the dependency
```java
dependencies {
implementation 'com.github.mukeshsolanki:liquidrefreshlayout:'
}
```
## How to use Liquid Refresh Layout
Its fairly simple and straight forward to use *Liquid Refresh Layout* in you application. Just add the following in your layout where you want to display the Liquid Refresh Layout.
```XML
```
and implement `LiquidRefreshLayout.OnRefreshListener` it in your activity/fragment and assign the Liquid Refresh Layout like wise.
```Java
refreshLayout.setOnRefreshListener(object : LiquidRefreshLayout.OnRefreshListener {
override fun completeRefresh() {
//Called when you call refreshLayout.finishRefreshing()
}
override fun refreshing() {
//TODO make api call here
}
})
```
to stop refreshing call `refreshLayout.finishRefreshing()`
## Author
Maintained by [Mukesh Solanki](https://www.github.com/mukeshsolanki)
## Contribution
[](https://github.com/mukeshsolanki/liquidrefreshlayout/graphs/contributors)
* Bug reports and pull requests are welcome.
* Make sure you use [square/java-code-styles](https://github.com/square/java-code-styles) to format your code.
## License
```
Copyright (c) 2018 Mukesh Solanki
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.
```