-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
Showing
1 changed file
with
26 additions
and
5 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,28 @@ | ||
# Pull To Refresh for Jetpack Compose | ||
|
||
A library provides a layout to the pull-to-refresh UX Pattern. | ||
This project is inspired by one of Google extension libraries for Jetpack Compose, called [SwipeRefresh](https://google.github.io/accompanist/swiperefresh/). | ||
The concept of scrolling the content are absolutely the same. However, instead of showing just a progressbar indicator from the top to the bottom while the | ||
content itself being scrolled down, the layout would show an additional customizable layouts that correspond to the refresh state. This layout could be an indicator, | ||
an animation, or just text to show. It's totally customizable. | ||
A library provides a layout to the pull-to-refresh UX Pattern. This project is inspired by one of | ||
Google extension libraries for Jetpack Compose, | ||
called [SwipeRefresh](https://google.github.io/accompanist/swiperefresh/). The concept of scrolling | ||
the content are absolutely the same. However, instead of showing just a progressbar indicator from | ||
the top to the bottom while the content itself being scrolled down, the layout would show an | ||
additional customizable layouts that correspond to the refresh state. This layout could be an | ||
indicator, an animation, or just text to show. It's totally customizable. | ||
|
||
## Download | ||
|
||
**Step 1.** Add the JitPack repository to your build file | ||
|
||
```gradle | ||
repositories { | ||
... | ||
maven { url 'https://jitpack.io' } | ||
} | ||
``` | ||
|
||
**Step 2.** Add the dependency | ||
|
||
```gradle | ||
dependencies { | ||
implementation 'com.github.rllyhz:pullrefresh-compose:<version>' | ||
} | ||
``` |