{"id":18565101,"url":"https://github.com/jenly1314/ultraswiperefresh","last_synced_at":"2025-04-05T03:03:02.143Z","repository":{"id":210544352,"uuid":"726825340","full_name":"jenly1314/UltraSwipeRefresh","owner":"jenly1314","description":" :surfer: 一个可带来极致体验的Compose刷新组件；支持下拉刷新和上拉加载，可完美替代官方的SwipeRefresh；并且支持的功能更多，可扩展性更强。","archived":false,"fork":false,"pushed_at":"2025-03-14T15:06:03.000Z","size":65931,"stargazers_count":181,"open_issues_count":0,"forks_count":11,"subscribers_count":4,"default_branch":"master","last_synced_at":"2025-03-29T02:02:42.800Z","etag":null,"topics":["android","compose","compose-refresh","jetpack","jetpack-compose","kotlin","loadmore","pull-refresh","pull-to-refresh","pullrefresh","pulltorefresh","pulltorefreshview","refresh","refresh-layout","refreshlayout","smartrefresh","smartrefreshlayout","swipe-refresh","swiperefresh","swiperefreshlayout"],"latest_commit_sha":null,"homepage":"https://jenly1314.github.io/UltraSwipeRefresh/","language":"Kotlin","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/jenly1314.png","metadata":{"files":{"readme":"README.md","changelog":"CHANGELOG.md","contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2023-12-03T14:14:07.000Z","updated_at":"2025-03-28T12:59:01.000Z","dependencies_parsed_at":"2025-01-19T14:10:37.273Z","dependency_job_id":"fcd68bc0-d365-4db2-8b49-5dafb0579721","html_url":"https://github.com/jenly1314/UltraSwipeRefresh","commit_stats":null,"previous_names":["jenly1314/ultraswiperefresh"],"tags_count":8,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenly1314%2FUltraSwipeRefresh","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenly1314%2FUltraSwipeRefresh/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenly1314%2FUltraSwipeRefresh/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/jenly1314%2FUltraSwipeRefresh/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/jenly1314","download_url":"https://codeload.github.com/jenly1314/UltraSwipeRefresh/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247280214,"owners_count":20912967,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["android","compose","compose-refresh","jetpack","jetpack-compose","kotlin","loadmore","pull-refresh","pull-to-refresh","pullrefresh","pulltorefresh","pulltorefreshview","refresh","refresh-layout","refreshlayout","smartrefresh","smartrefreshlayout","swipe-refresh","swiperefresh","swiperefreshlayout"],"created_at":"2024-11-06T22:17:45.088Z","updated_at":"2025-04-05T03:02:57.134Z","avatar_url":"https://github.com/jenly1314.png","language":"Kotlin","funding_links":[],"categories":[],"sub_categories":[],"readme":"# UltraSwipeRefresh\n\n[![Download](https://img.shields.io/badge/download-App-blue.svg)](https://raw.githubusercontent.com/jenly1314/UltraSwipeRefresh/master/app/release/app-release.apk)\n[![MavenCentral](https://img.shields.io/maven-central/v/com.github.jenly1314.UltraSwipeRefresh/refresh)](https://repo1.maven.org/maven2/com/github/jenly1314/UltraSwipeRefresh)\n[![JitPack](https://jitpack.io/v/jenly1314/UltraSwipeRefresh.svg)](https://jitpack.io/#jenly1314/UltraSwipeRefresh)\n[![CircleCI](https://circleci.com/gh/jenly1314/UltraSwipeRefresh.svg?style=svg)](https://circleci.com/gh/jenly1314/UltraSwipeRefresh)\n[![API](https://img.shields.io/badge/API-21%2B-blue.svg?style=flat)](https://android-arsenal.com/api?level=21)\n[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/mit-license.php)\n\n**UltraSwipeRefresh**：一个可带来极致体验的 **Compose** 刷新组件；支持下拉刷新和上拉加载，可完美替代官方的 **SwipeRefresh**；并且支持的功能更多，可扩展性更强。\n\n\u003e **UltraSwipeRefresh** 的设计之初，主要参考了谷歌官方的[SwipeRefresh](https://github.com/google/accompanist/tree/main/swiperefresh) 和第三方的[SmartRefreshLayout](https://github.com/scwang90/SmartRefreshLayout) ，吸取了其优秀的设计思想；致力于打造一个极致体验的 **Compose** 刷新组件。\n\n\u003e 这里简单的概括下 **UltraSwipeRefresh** 主要的一些功能特色：刷新指示器支持多种滑动方式：平移、固定内容、固定在背后、固定在前面； **headerIndicator** 和 **footerIndicator** 可任意定制，并且 **Header** 和 **Footer** 的样式与滑动模式可随意组合。\n\n\n## Gif 展示\n\n![Image](art/UltraSwipeRefresh.gif)\n\n\u003e 你也可以直接下载 [演示App](https://raw.githubusercontent.com/jenly1314/UltraSwipeRefresh/master/app/release/app-release.apk) 体验效果\n\n## 引入\n\n### Gradle:\n\n1. 在Project的 **build.gradle** 或 **setting.gradle** 中添加远程仓库\n\n    ```gradle\n    repositories {\n        //...\n        mavenCentral()\n    }\n    ```\n\n2. 在Module的 **build.gradle** 里面添加引入依赖项\n\n    ```gradle\n    // 极致体验的Compose刷新组件 (*必须)\n    implementation 'com.github.jenly1314.UltraSwipeRefresh:refresh:1.3.1'\n\n    // 经典样式的指示器 (可选)\n    implementation 'com.github.jenly1314.UltraSwipeRefresh:refresh-indicator-classic:1.3.1'\n    // Lottie动画指示器 (可选)\n    implementation 'com.github.jenly1314.UltraSwipeRefresh:refresh-indicator-lottie:1.3.1'\n    // 进度条样式的指示器 (可选)\n    implementation 'com.github.jenly1314.UltraSwipeRefresh:refresh-indicator-progress:1.3.1'\n    ```\n\n## 使用\n\n### UltraSwipeRefresh\n\n**Compose** 组件的使用大都比较直观，一般看一下 **Composable** 函数对应的参数说明基本就会使用了。\n\n#### UltraSwipeRefresh参数说明\n\n```kotlin\n/**\n * UltraSwipeRefresh：一个可带来极致体验的Compose刷新组件；支持下拉刷新和上拉加载，可完美替代官方的SwipeRefresh；并且支持的功能更多，可扩展性更强。\n *\n * @param state 状态：主要用于控制和观察[UltraSwipeRefresh]；比如：控制下拉刷新和上拉加载和观察其状态。\n * @param onRefresh 在完成滑动刷新手势时触发调用\n * @param onLoadMore 在完成滑动加载手势时触发调用\n * @param modifier 修饰符：用于装饰或添加Compose UI元素的行为。具体更详细的说明可查看[Modifier]\n * @param headerScrollMode 在进行滑动刷新时Header的滑动模式；具体更详细的样式说明可查看[NestedScrollMode]\n * @param footerScrollMode 在进行滑动加载更多时Footer的滑动模式；具体更详细的样式说明可查看[NestedScrollMode]\n * @param refreshEnabled 是否启用下拉刷新\n * @param loadMoreEnabled 是否启用上拉加载\n * @param refreshTriggerRate 触发滑动刷新的最小滑动比例；比例基于[headerIndicator]的高度；默认为：1\n * @param loadMoreTriggerRate 触发滑动加载更多最小滑动比例；比例基于[footerIndicator]的高度；默认为：1\n * @param headerMaxOffsetRate 向下滑动时[headerIndicator]可滑动的最大偏移比例；比例基于[headerIndicator]的高度；默认为：2\n * @param footerMaxOffsetRate 向上滑动时[footerIndicator]可滑动的最大偏移比例；比例基于[footerIndicator]的高度；默认为：2\n * @param dragMultiplier 触发下拉刷新或上拉加载时的阻力系数；值越小，阻力越大；默认为：0.5\n * @param finishDelayMillis 完成时延时时间；让完成时的中间状态[UltraSwipeRefreshState.isFinishing]停留一会儿，定格的展示提示内容；默认：500毫秒\n * @param vibrateEnabled 是否启用振动，如果启用则当滑动偏移量满足触发刷新或触发加载更多时，会有振动效果；默认为：false\n * @param alwaysScrollable 是否始终可以滚动；当为true时，则会忽略刷新中或加载中的状态限制，始终可以进行滚动；默认为：false\n * @param headerIndicator 下拉刷新时顶部显示的Header指示器\n * @param footerIndicator 上拉加载更多时底部显示的Footer指示器\n * @param contentContainer 内容的父容器，便于统一管理\n * @param content 可进行刷新或加载更多所包含的内容\n */\n```\n\n#### UltraSwipeRefresh使用示例\n\n比如：使用`UltraSwipeRefresh`实现一个经典样式的刷新与加载示例：\n\n```kotlin\n\n@Composable\nfun UltraSwipeRefreshSample() {\n\n   val state = rememberUltraSwipeRefreshState()\n   var itemCount by remember { mutableIntStateOf(20) }\n   val coroutineScope = rememberCoroutineScope()\n\n   UltraSwipeRefresh(\n      state = state,\n      onRefresh = {\n         coroutineScope.launch {\n            state.isRefreshing = true\n            // TODO 刷新的逻辑处理，此处的延时只是为了演示效果\n            delay(2000)\n            itemCount = 20\n            state.isRefreshing = false\n         }\n      },\n      onLoadMore = {\n         coroutineScope.launch {\n            state.isLoading = true\n            // TODO 加载更多的逻辑处理，此处的延时只是为了演示效果\n            delay(2000)\n            itemCount += 20\n            state.isLoading = false\n         }\n      },\n      modifier = Modifier.background(color = Color(0x7FEEEEEE)),\n      headerScrollMode = NestedScrollMode.Translate,\n      footerScrollMode = NestedScrollMode.Translate,\n      headerIndicator = {\n         ClassicRefreshHeader(it)\n      },\n      footerIndicator = {\n         ClassicRefreshFooter(it)\n      }\n   ) {\n      LazyColumn(Modifier.background(color = Color.White)) {\n         repeat(itemCount) {\n            item {\n               Text(\n                  text = \"UltraSwipeRefresh列表Item${it + 1}\",\n                  modifier = Modifier.padding(horizontal = 16.dp, vertical = 10.dp),\n                  color = Color(0xFF333333),\n                  fontSize = 16.sp\n               )\n               Divider(\n                  modifier = Modifier.padding(horizontal = 16.dp),\n                  color = Color(0xFFF2F3F6)\n               )\n            }\n         }\n      }\n   }\n}\n\n```\n\n\u003e 使用小提示：**headerIndicator/footerIndicator** 与 **headerScrollMode/footerScrollMode** 组合使用才更配哦。\n\n### UltraSwipeRefreshTheme（v1.1.0新增）\n\nUltraSwipeRefreshTheme：主要用于统一管理全局默认配置。\n\n\u003e 通常情况下，一个App使用的刷新样式是统一的，如果你需要进行全局统一刷新组件的样式时，可以通过`UltraSwipeRefreshTheme.config`来动态修改`UltraSwipeRefresh`的全局默认配置。\n\n#### UltraSwipeRefreshTheme使用示例\n\n```kotlin\n// 全局设置默认的滑动模式 （建议在Application的onCreate中进行配置）\nUltraSwipeRefreshTheme.config = UltraSwipeRefreshTheme.config.copy(\n   headerScrollMode = NestedScrollMode.Translate,\n   footerScrollMode = NestedScrollMode.Translate,\n)\n```\n\u003e 更多参数配置可查看：`UltraSwipeRefreshTheme.config` 的定义，这里就不一一举例了。\n\n### 指示器样式\n\n这里罗列一下目前 **UltraSwipeRefresh** 所提供的一些Header和Footer指示器样式与示例，以供参考。\n\n| 默认官方样式                                                                                                | 经典样式                                                                                                                                                                                                           |\n|:------------------------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|\n| SwipeRefreshHeader                                                                                    | ClassicRefreshHeader                                                                                                                                                                                           |\n| ![Image](art/SwipeRefreshIndicatorSample.gif)                                                         | ![Image](art/ClassicRefreshIndicatorSample.gif)                                                                                                                                                                |\n| SwipeRefreshFooter                                                                                    | ClassicRefreshFooter                                                                                                                                                                                           |\n| [官方默认的刷新样式示例](app/src/main/java/com/king/ultraswiperefresh/app/sample/SwipeRefreshIndicatorSample.kt) | [经典刷新样式示例](app/src/main/java/com/king/ultraswiperefresh/app/sample/ClassicRefreshIndicatorSample.kt)  /  [经典刷新自动加载示例](app/src/main/java/com/king/ultraswiperefresh/app/sample/ClassicRefreshAutoLoadSample.kt) |\n\n| 进度条样式                                                                                           | Lottie动画样式                                                                                                                            |\n|:-----------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------|\n| ProgressRefreshHeader                                                                                | LottieRefreshHeader                                                                                                                   |\n| ![Image](art/ProgressRefreshIndicatorSample.gif)                                                     | ![Image](art/LottieRefreshIndicatorSample.gif)                                                                                        |\n| ProgressRefreshFooter                                                                                | LottieRefreshFooter                                                                                                                   |\n| [进度条刷新样式示例](app/src/main/java/com/king/ultraswiperefresh/app/sample/ProgressRefreshIndicatorSample.kt) | [Lottie动画刷新样式示例](app/src/main/java/com/king/ultraswiperefresh/app/sample/LottieRefreshIndicatorSample.kt)                                    |\n\n\n\u003e 如果以上的指示器效果都不满足你的需求，你可以自定义去实现Header和Footer的指示器，也可以直接使用Lottie动画样式的指示器，来快速接入任何Lottie动画。\n\n更多使用详情，请查看[app](app)中的源码使用示例或直接查看 [API帮助文档](https://jenly1314.github.io/UltraSwipeRefresh/api/)\n\n## 相关推荐\n\n- [CodeTextField](https://github.com/jenly1314/CodeTextField)一个使用 Compose 实现的验证码输入框。\n- [compose-component](https://github.com/jenly1314/compose-component) 一个Jetpack Compose的组件库；主要提供了一些小组件，便于快速使用。\n\n\u003c!-- end --\u003e\n\n## 版本日志\n\n#### v1.3.1 ：2024-12-23\n* 修复BUG：快速滑动时，出现收起动画不执行的问题。 （[#21](https://github.com/jenly1314/UltraSwipeRefresh/issues/21)）\n\n\n#### [查看更多版本日志](CHANGELOG.md)\n\n## 赞赏\n\n如果您喜欢UltraSwipeRefresh，或感觉UltraSwipeRefresh帮助到了您，可以点右上角“Star”支持一下，您的支持就是我的动力，谢谢 :smiley:\n\u003cp\u003e您也可以扫描下面的二维码，请作者喝杯咖啡 :coffee:\n\n\u003cdiv\u003e\n   \u003cimg src=\"https://jenly1314.github.io/image/page/rewardcode.png\"\u003e\n\u003c/div\u003e\n\n## 关于我\n\n| 我的博客                                                                                | GitHub                                                                                  | Gitee                                                                                  | CSDN                                                                                 | 博客园                                                                            |\n|:------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------|:---------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------------|:-------------------------------------------------------------------------------|\n| \u003ca title=\"我的博客\" href=\"https://jenly1314.github.io\" target=\"_blank\"\u003eJenly's Blog\u003c/a\u003e | \u003ca title=\"GitHub开源项目\" href=\"https://github.com/jenly1314\" target=\"_blank\"\u003ejenly1314\u003c/a\u003e | \u003ca title=\"Gitee开源项目\" href=\"https://gitee.com/jenly1314\" target=\"_blank\"\u003ejenly1314\u003c/a\u003e  | \u003ca title=\"CSDN博客\" href=\"http://blog.csdn.net/jenly121\" target=\"_blank\"\u003ejenly121\u003c/a\u003e  | \u003ca title=\"博客园\" href=\"https://www.cnblogs.com/jenly\" target=\"_blank\"\u003ejenly\u003c/a\u003e  |\n\n## 联系我\n\n| 微信公众号        | Gmail邮箱                                                                          | QQ邮箱                                                                              | QQ群                                                                                                                       | QQ群                                                                                                                       |\n|:-------------|:---------------------------------------------------------------------------------|:----------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------|\n| [Jenly666](http://weixin.qq.com/r/wzpWTuPEQL4-ract92-R) | \u003ca title=\"给我发邮件\" href=\"mailto:jenly1314@gmail.com\" target=\"_blank\"\u003ejenly1314\u003c/a\u003e | \u003ca title=\"给我发邮件\" href=\"mailto:jenly1314@vip.qq.com\" target=\"_blank\"\u003ejenly1314\u003c/a\u003e | \u003ca title=\"点击加入QQ群\" href=\"https://qm.qq.com/cgi-bin/qm/qr?k=6_RukjAhwjAdDHEk2G7nph-o8fBFFzZz\" target=\"_blank\"\u003e20867961\u003c/a\u003e | \u003ca title=\"点击加入QQ群\" href=\"https://qm.qq.com/cgi-bin/qm/qr?k=Z9pobM8bzAW7tM_8xC31W8IcbIl0A-zT\" target=\"_blank\"\u003e64020761\u003c/a\u003e |\n\n\u003cdiv\u003e\n   \u003cimg src=\"https://jenly1314.github.io/image/page/footer.png\"\u003e\n\u003c/div\u003e\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenly1314%2Fultraswiperefresh","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fjenly1314%2Fultraswiperefresh","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fjenly1314%2Fultraswiperefresh/lists"}