Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
@jenly1314
jenly1314 committed Dec 3, 2023
1 parent 7542fcc commit 84be8a1
Showing 1 changed file with 10 additions and 6 deletions.
16 changes: 10 additions & 6 deletions README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -53,7 +53,7 @@

**Composable** 组件的使用大都比较直观，一般只需看一下 **Composable** 函数对应的参数说明基本就会使用了。

#### UltraSwipeRefresh参数说明
### UltraSwipeRefresh参数说明

```kotlin
/**
Expand All @@ -78,7 +78,7 @@
*/
```

#### 完整代码示例
### 完整代码示例

```kotlin
/**
Expand Down Expand Up @@ -150,27 +150,31 @@ fun UltraSwipeRefreshSample() {

### 提供的指示器样式

这里罗列一下目前 **UltraSwipeRefresh** 所包含的一些指示器样式与示例，方便快速查找与参考。
这里罗列一下目前 **UltraSwipeRefresh** 所包含的一些Header和Footer指示器样式，方便快速查找与参考。

| 默认官方样式 | 经典样式 |
|:--------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------|
| SwipeRefreshHeader | ClassicRefreshHeader |
| ![Image](art/SwipeRefreshIndicatorSample.gif) | ![Image](art/ClassicRefreshIndicatorSample.gif) |
| SwipeRefreshFooter | ClassicRefreshFooter |
| 默认官方样式代码示例[SwipeRefreshIndicatorSample](app/src/main/java/com/king/ultraswiperefresh/app/sample/SwipeRefreshIndicatorSample.kt) | 经典样式代码示例[ClassicRefreshIndicatorSample](app/src/main/java/com/king/ultraswiperefresh/app/sample/ClassicRefreshIndicatorSample.kt) |
| 代码示例[SwipeRefreshIndicatorSample](app/src/main/java/com/king/ultraswiperefresh/app/sample/SwipeRefreshIndicatorSample.kt) | 代码示例[ClassicRefreshIndicatorSample](app/src/main/java/com/king/ultraswiperefresh/app/sample/ClassicRefreshIndicatorSample.kt) |

| 进度条样式 | Lottie动画样式（可支持任何Lottie动画） |
| 进度条样式 | Lottie动画样式 |
|:-------------------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------|
| ProgressRefreshHeader | LottieRefreshHeader |
| ![Image](art/ProgressRefreshIndicatorSample.gif) | ![Image](art/LottieRefreshIndicatorSample.gif) |
| ProgressRefreshFooter | LottieRefreshFooter |
| 进度条样式代码示例[ProgressRefreshIndicatorSample](app/src/main/java/com/king/ultraswiperefresh/app/sample/ProgressRefreshIndicatorSample.kt) | Lottie动画样式代码示例[LottieRefreshIndicatorSample](app/src/main/java/com/king/ultraswiperefresh/app/sample/LottieRefreshIndicatorSample.kt) |
| 代码示例[ProgressRefreshIndicatorSample](app/src/main/java/com/king/ultraswiperefresh/app/sample/ProgressRefreshIndicatorSample.kt) | 代码示例[LottieRefreshIndicatorSample](app/src/main/java/com/king/ultraswiperefresh/app/sample/LottieRefreshIndicatorSample.kt) |


> 如果以上的指示器效果都不满足你的需求，你也可以自定义去实现Header和Footer的指示器，也可以直接使用Lottie动画样式的指示器来可快速接入任何Lottie动画。
更多使用详情，请查看[app](app)中的源码使用示例或直接查看 [API帮助文档](https://jitpack.io/com/github/jenly1314/UltraSwipeRefresh/latest/javadoc/)

### 相关推荐

#### [compose-component](https://github.com/jenly1314/compose-component) 一个Jetpack Compose的组件库；主要提供了一些小组件，便于快速使用。

## 版本记录

#### v1.0.0：2023-12-3
Expand Down

0 comments on commit 84be8a1

Please sign in to comment.