Skip to content

Latest commit

 

History

History
112 lines (92 loc) · 5.04 KB

README.md

File metadata and controls

112 lines (92 loc) · 5.04 KB
Raw

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. If you'd like to join them, please consider:

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:

allprojects {
  repositories {
    ...
    maven { url "https://jitpack.io" }
  }
}

Step 2. Add the dependency

dependencies {
    implementation 'com.github.mukeshsolanki:liquidrefreshlayout:<latest-version>'
}

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.

<com.madapps.liquid.LiquidRefreshLayout
    android:id="@+id/refreshLayout"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:AniBackColor="@color/colorAccent"
    app:AniForeColor="@color/colorBackground"
    app:CircleSmaller="6"
    >
  <!--Add your views here for example we are using recyclerview-->
  <android.support.v7.widget.RecyclerView
      android:id="@+id/recyclerView"
      android:layout_width="match_parent"
      android:layout_height="wrap_content"
      android:scrollbars="vertical"
      />
</com.madapps.liquid.LiquidRefreshLayout>

and implement LiquidRefreshLayout.OnRefreshListener it in your activity/fragment and assign the Liquid Refresh Layout like wise.

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

Contribution

GitHub contributors

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.