Initial commit

jenly1314 · Dec 3, 2023 · 410bb0e · 410bb0e
commit 410bb0e
Show file tree

Hide file tree

Showing 122 changed files with 5,129 additions and 0 deletions.
diff --git a/.circleci/config.yml b/.circleci/config.yml
@@ -0,0 +1,13 @@
+version: 2.1
+
+orbs:
+  android: circleci/[email protected]
+
+jobs:
+  build:
+    docker:
+      - image: cimg/android:2023.08
+    steps:
+      - checkout
+      - run:
+          command: ./gradlew build
diff --git a/.github/workflows/build.yml b/.github/workflows/build.yml
@@ -0,0 +1,20 @@
+name: Android CI
+
+on:
+  push:
+    branches: [ master ]
+  pull_request:
+    branches: [ master ]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+
+    steps:
+      - uses: actions/checkout@v2
+      - name: Set up JDK 17
+        uses: actions/setup-java@v1
+        with:
+          java-version: 17
+      - name: Build with Gradle
+        run: ./gradlew build
diff --git a/.gitignore b/.gitignore
@@ -0,0 +1,10 @@
+*.iml
+.gradle
+/local.properties
+/.idea
+.DS_Store
+/build
+/captures
+.externalNativeBuild
+.cxx
+local.properties
diff --git a/LICENSE b/LICENSE
@@ -0,0 +1,21 @@
+The MIT License (MIT)
+
+Copyright (c) 2023 Jenly Yu
+
+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.
diff --git a/README.md b/README.md
@@ -0,0 +1,210 @@
+# UltraSwipeRefresh
+
+[![Download](https://img.shields.io/badge/download-App-blue.svg)](https://raw.githubusercontent.com/jenly1314/UltraSwipeRefresh/master/app/release/app-release.apk)
+[![MavenCentral](https://img.shields.io/maven-central/v/com.github.jenly1314.UltraSwipeRefresh/refresh)](https://repo1.maven.org/maven2/com/github/jenly1314/UltraSwipeRefresh)
+[![JitPack](https://jitpack.io/v/jenly1314/UltraSwipeRefresh.svg)](https://jitpack.io/#jenly1314/UltraSwipeRefresh)
+[![CircleCI](https://circleci.com/gh/jenly1314/UltraSwipeRefresh.svg?style=svg)](https://circleci.com/gh/jenly1314/UltraSwipeRefresh)
+[![API](https://img.shields.io/badge/API-21%2B-blue.svg?style=flat)](https://android-arsenal.com/api?level=21)
+[![License](https://img.shields.io/badge/license-MIT-blue.svg)](https://opensource.org/licenses/mit-license.php)
+[![Blog](https://img.shields.io/badge/blog-Jenly-9933CC.svg)](https://jenly1314.github.io/)
+[![QQGroup](https://img.shields.io/badge/QQGroup-20867961-blue.svg)](http://shang.qq.com/wpa/qunwpa?idkey=8fcc6a2f88552ea44b1.1.982c94fd124f7bb3ec227e2a400dbbfaad3dc2f5ad)
+
+**UltraSwipeRefresh**：一个可带来极致体验的 **Compose** 刷新组件；支持下拉刷新和上拉加载，可完美替代官方的 **SwipeRefresh**；并且支持的功能更多，可扩展性更强。
+
+> **UltraSwipeRefresh** 的设计之初，主要参考了谷歌官方的[SwipeRefresh](https://github.com/google/accompanist/tree/main/swiperefresh) 和第三方的[SmartRefreshLayout](https://github.com/scwang90/SmartRefreshLayout) ，吸取了其优秀的设计思想；致力于打造一个极致体验的 **Compose** 刷新组件。
+
+> 这里概括下其主要的功能特点：支持多种滑动方式：平移、固定内容、固定在背后、固定在前面； **headerIndicator** 和 **footerIndicator** 可随意定制，并且 **Header** 和 **Footer** 的样式与滑动模式可随意组合。
+
+
+## Gif 展示
+
+![Image](art/UltraSwipeRefresh.gif)
+
+> 你也可以直接下载 [演示App](https://raw.githubusercontent.com/jenly1314/UltraSwipeRefresh/master/app/release/app-release.apk) 体验效果
+
+## 引入
+
+### Gradle:
+
+1. 在Project的 **build.gradle** 或 **setting.gradle** 中添加远程仓库
+
+    ```gradle
+    repositories {
+        //...
+        mavenCentral()
+    }
+    ```
+
+2. 在Module的 **build.gradle** 里面添加引入依赖项
+
+    ```gradle
+    // 极致体验的Compose刷新组件 (*必须)
+    implementation 'com.github.jenly1314.UltraSwipeRefresh:refresh:1.0.0'
+   
+    // 经典样式的指示器 (可选)
+    implementation 'com.github.jenly1314.UltraSwipeRefresh:refresh-indicator-classic:1.0.0'
+    // Lottie动画指示器 (可选)
+    implementation 'com.github.jenly1314.UltraSwipeRefresh:refresh-indicator-lottie:1.0.0'
+    // 进度条样式的指示器 (可选)
+    implementation 'com.github.jenly1314.UltraSwipeRefresh:refresh-indicator-progress:1.0.0'
+    ```
+
+## 使用说明
+
+**Composable** 组件的使用大都比较直观，一般只需看一下 **Composable** 函数对应的参数说明基本就会使用了。
+
+#### UltraSwipeRefresh参数说明
+
+```kotlin
+/**
+ * UltraSwipeRefresh：一个可带来极致体验的Compose刷新组件；支持下拉刷新和上拉加载，可完美替代官方的SwipeRefresh；并且支持的功能更多，可扩展性更强。
+ *
+ * @param state 状态：主要用于控制和观察[UltraSwipeRefresh]；比如：控制下拉刷新和上拉加载和观察其状态。
+ * @param onRefresh 在完成滑动刷新手势时触发调用
+ * @param onLoadMore 在完成滑动加载手势时触发调用
+ * @param modifier 修饰符：用于装饰或添加Compose UI元素的行为。具体更详细的说明可查看[Modifier]
+ * @param headerScrollMode 在进行滑动刷新时Header的滑动模式；具体更详细的样式说明可查看[NestedScrollMode]
+ * @param footerScrollMode 在进行滑动加载更多时Footer的滑动模式；具体更详细的样式说明可查看[NestedScrollMode]
+ * @param refreshEnabled 是否启用下拉刷新
+ * @param loadMoreEnabled 是否启用上拉加载
+ * @param refreshTriggerRate 触发滑动刷新的最小滑动比例；比例基于[headerIndicator]的高度；默认为：1
+ * @param loadMoreTriggerRate 触发滑动加载更多最小滑动比例；比例基于[footerIndicator]的高度；默认为：1
+ * @param headerMaxOffsetRate 向下滑动时[headerIndicator]可滑动的最大偏移比例；比例基于[headerIndicator]的高度；默认为：2
+ * @param footerMaxOffsetRate 向上滑动时[footerIndicator]可滑动的最大偏移比例；比例基于[footerIndicator]的高度；默认为：2
+ * @param dragMultiplier 触发下拉刷新或上拉加载时的阻力系数；值越小，阻力越大；默认为：0.5
+ * @param headerIndicator 下拉刷新时顶部显示的Header指示器
+ * @param footerIndicator 上拉加载更多时底部显示的Footer指示器
+ * @param content 可进行滑动刷新或加载更多包含的内容
+ */
+```
+
+#### 完整代码示例
+
+```kotlin
+/**
+ * 代码示例
+ */
+@Composable
+fun UltraSwipeRefreshSample() {
+
+   val state = rememberUltraSwipeRefreshState()
+
+   var itemCount by remember { mutableIntStateOf(20) }
+
+   LaunchedEffect(state.isRefreshing) {
+      if (state.isRefreshing) {
+         // TODO 刷新的逻辑处理，此处的延时只是为了演示效果
+         delay(2000)
+         itemCount = 20
+         state.isRefreshing = false
+      }
+   }
+
+   LaunchedEffect(state.isLoading) {
+      if (state.isLoading) {
+         // TODO 加载更多的逻辑处理，此处的延时只是为了演示效果
+         delay(2000)
+         itemCount += 20
+         state.isLoading = false
+      }
+   }
+
+   UltraSwipeRefresh(
+      state = state,
+      onRefresh = {
+         state.isRefreshing = true
+      },
+      onLoadMore = {
+         state.isLoading = true
+      },
+      modifier = Modifier.background(color = Color(0x7FEEEEEE)),
+      headerScrollMode = NestedScrollMode.Translate,
+      footerScrollMode = NestedScrollMode.Translate,
+      headerIndicator = {
+         ClassicRefreshHeader(it)
+      },
+      footerIndicator = {
+         ClassicRefreshFooter(it)
+      }
+   ) {
+      LazyColumn(Modifier.background(color = Color.White)) {
+         repeat(itemCount) {
+            item {
+               val title = "UltraSwipeRefresh列表Item${it + 1}"
+               Text(
+                  text = title,
+                  color = Color(0xFF333333),
+                  fontSize = 16.sp,
+               )
+               Divider(
+                  modifier = Modifier.padding(horizontal = 16.dp),
+                  color = Color(0xFFF2F3F6)
+               )
+            }
+         }
+      }
+   }
+}
+
+```
+
+### 提供的指示器样式
+
+这里罗列一下目前 **UltraSwipeRefresh** 所包含的一些指示器样式与示例，方便快速查找与参考。
+
+| 默认官方样式                                                                                                                          | 经典样式                                                                                                                              | 
+|:--------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------|
+| 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) | 
+
+| 进度条样式                                                                                                                                | 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) | 
+
+
+> 如果以上的指示器效果都不满足你的需求，你也可以自定义去实现Header和Footer的指示器，也可以直接使用Lottie动画样式的指示器来可快速接入任何Lottie动画。
+
+更多使用详情，请查看[app](app)中的源码使用示例或直接查看 [API帮助文档](https://jitpack.io/com/github/jenly1314/UltraSwipeRefresh/latest/javadoc/)
+
+## 版本记录
+
+#### v1.0.0：2023-12-3
+
+* UltraSwipeRefresh初始版本
+
+## 赞赏
+
+如果您喜欢UltraSwipeRefresh，或感觉UltraSwipeRefresh帮助到了您，可以点右上角“Star”支持一下，您的支持就是我的动力，谢谢 :
+smiley:<p>
+您也可以扫描下面的二维码，请作者喝杯咖啡 :coffee:
+<div>
+<img src="https://jenly1314.github.io/image/pay/sponsor.png" width="98%">
+</div>
+
+## 关于我
+
+Name: <a title="关于作者" href="https://jenly1314.github.io" target="_blank">Jenly</a>
+
+Email: <a title="欢迎邮件与我交流" href="mailto:[email protected]" target="_blank">
+jenly1314#gmail.com</a> / <a title="给我发邮件" href="mailto:[email protected]" target="_blank">
+jenly1314#vip.qq.com</a>
+
+CSDN: <a title="CSDN博客" href="http://blog.csdn.net/jenly121" target="_blank">jenly121</a>
+
+CNBlogs: <a title="博客园" href="https://www.cnblogs.com/jenly" target="_blank">jenly</a>
+
+GitHub: <a title="GitHub开源项目" href="https://github.com/jenly1314" target="_blank">jenly1314</a>
+
+Gitee: <a title="Gitee开源项目" href="https://gitee.com/jenly1314" target="_blank">jenly1314</a>
+
+加入QQ群: <a title="点击加入QQ群" href="http://shang.qq.com/wpa/qunwpa?idkey=8fcc6a2f88552ea44b1411582c94fd124f7bb3ec227e2a400dbbfaad3dc2f5ad" target="_blank">
+20867961</a>
+   <div>
+       <img src="https://jenly1314.github.io/image/jenly666.png">
+       <img src="https://jenly1314.github.io/image/qqgourp.png">
+   </div>
diff --git a/app/.gitignore b/app/.gitignore
@@ -0,0 +1 @@
+/build
diff --git a/app/build.gradle b/app/build.gradle
@@ -0,0 +1,78 @@
+plugins {
+    id 'com.android.application'
+    id 'org.jetbrains.kotlin.android'
+}
+
+android {
+    namespace 'com.king.ultraswiperefresh.app'
+    compileSdk build_versions.compileSdk
+
+    defaultConfig {
+        applicationId "com.king.ultraswiperefresh.app"
+        minSdk build_versions.minSdk
+        targetSdk build_versions.targetSdk
+        versionCode app_version.versionCode
+        versionName app_version.versionName
+
+        testInstrumentationRunner "androidx.test.runner.AndroidJUnitRunner"
+        vectorDrawables {
+            useSupportLibrary true
+        }
+    }
+
+    buildTypes {
+        release {
+            minifyEnabled false
+            proguardFiles getDefaultProguardFile('proguard-android-optimize.txt'), 'proguard-rules.pro'
+        }
+    }
+    compileOptions {
+        sourceCompatibility JavaVersion.VERSION_11
+        targetCompatibility JavaVersion.VERSION_11
+    }
+    kotlinOptions {
+        jvmTarget = JavaVersion.VERSION_11.toString()
+    }
+    buildFeatures {
+        compose true
+    }
+    composeOptions {
+        kotlinCompilerExtensionVersion '1.4.3'
+    }
+    lint {
+        abortOnError false
+    }
+    packagingOptions {
+        resources {
+            excludes += '/META-INF/{AL2.0,LGPL2.1}'
+        }
+    }
+}
+
+dependencies {
+
+    implementation "androidx.core:core-ktx:$versions.core_ktx"
+    implementation "androidx.lifecycle:lifecycle-runtime-ktx:$versions.lifecycle_runtime_ktx"
+    implementation "androidx.activity:activity-compose:$versions.activity_compose"
+    implementation platform("androidx.compose:compose-bom:$versions.compose_bom")
+    implementation "androidx.compose.ui:ui"
+    implementation "androidx.compose.ui:ui-graphics"
+    implementation "androidx.compose.ui:ui-tooling-preview"
+    implementation "androidx.compose.material:material"
+    implementation "androidx.navigation:navigation-compose:$versions.navigation_compose"
+
+    implementation "com.airbnb.android:lottie-compose:$versions.lottie_compose"
+
+    testImplementation "junit:junit:$versions.junit"
+    androidTestImplementation "androidx.test.ext:junit:$versions.android_ext_junit"
+    androidTestImplementation "androidx.test.espresso:espresso-core:$versions.espresso"
+
+    debugImplementation 'androidx.compose.ui:ui-tooling'
+    debugImplementation 'androidx.compose.ui:ui-test-manifest'
+
+    implementation project(':refresh')
+    implementation project(":refresh-indicator-classic")
+    implementation project(":refresh-indicator-lottie")
+    implementation project(":refresh-indicator-progress")
+
+}
diff --git a/app/proguard-rules.pro b/app/proguard-rules.pro
@@ -0,0 +1,21 @@
+# Add project specific ProGuard rules here.
+# You can control the set of applied configuration files using the
+# proguardFiles setting in build.gradle.
+#
+# For more details, see
+#   http://developer.android.com/guide/developing/tools/proguard.html
+
+# If your project uses WebView with JS, uncomment the following
+# and specify the fully qualified class name to the JavaScript interface
+# class:
+#-keepclassmembers class fqcn.of.javascript.interface.for.webview {
+#   public *;
+#}
+
+# Uncomment this to preserve the line number information for
+# debugging stack traces.
+#-keepattributes SourceFile,LineNumberTable
+
+# If you keep the line number information, uncomment this to
+# hide the original source file name.
+#-renamesourcefileattribute SourceFile
diff --git a/app/release/app-release.apk b/app/release/app-release.apk