Skip to content

Commit fda677d

Browse files
jenly1314jenly1314
committed
docs
1 parent c6b2f44 commit fda677d

File tree

11 files changed

+228
-16
lines changed

11 files changed

+228
-16
lines changed

‎.editorconfig‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,11 @@
1+
root = true
2+
3+
[*]
4+
indent_style = space
5+
indent_size = 4
6+
charset = utf-8
7+
trim_trailing_whitespace = true
8+
insert_final_newline = true
9+
10+
[*.{kt, kts}]
11+
ij_kotlin_imports_layout = *

‎.github/workflows/docs.yml‎

Lines changed: 56 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,56 @@
1+
name: docs
2+
3+
on:
4+
push:
5+
branches:
6+
- master
7+
8+
env:
9+
JAVA_VERSION: 17
10+
PYTHON_VERSION: 3.x
11+
GRADLE_OPTS: "-Dorg.gradle.jvmargs=-Xmx4g -Dorg.gradle.daemon=false -Dkotlin.incremental=false"
12+
13+
permissions:
14+
contents: write
15+
id-token: write
16+
pages: write
17+
18+
jobs:
19+
docs:
20+
environment:
21+
name: github-pages
22+
url: ${{ steps.deployment.outputs.page_url }}
23+
runs-on: ubuntu-latest
24+
if: github.ref == 'refs/heads/master'
25+
26+
steps:
27+
- name: Checkout
28+
uses: actions/checkout@v4
29+
with:
30+
fetch-depth: 0
31+
32+
- name: Configure JDK
33+
uses: actions/setup-java@v4
34+
with:
35+
distribution: 'zulu'
36+
java-version: ${{ env.JAVA_VERSION }}
37+
38+
- name: Install Python
39+
uses: actions/setup-python@v5
40+
with:
41+
python-version: ${{ env.PYTHON_VERSION }}
42+
43+
- name: Install MkDocs Material
44+
run: pip install mkdocs-material
45+
46+
- name: Generate Docs
47+
run: ./build_docs.sh
48+
49+
- name: Upload to GitHub Pages
50+
uses: actions/upload-pages-artifact@v3
51+
with:
52+
path: site
53+
54+
- name: Deploy to GitHub Pages
55+
id: deployment
56+
uses: actions/deploy-pages@v4

‎CHANGELOG.md‎

Lines changed: 29 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,29 @@
1+
## 版本日志
2+
3+
#### v1.3.0 ：2024-7-20
4+
* 更新compose至v1.6.0 (v1.5.0 -> v1.6.0) （[#13](https://github.com/jenly1314/UltraSwipeRefresh/issues/13)）
5+
* 新增参数`alwaysScrollable`：是否始终可以滚动
6+
* 优化一些细节
7+
8+
#### v1.2.0 ：2024-7-1
9+
* 新增参数`contentContainer`：内容的父容器，便于统一管理
10+
* 修复了一些已知问题
11+
12+
#### v1.1.3 ：2024-6-2
13+
* 修复BUG：禁用下拉刷新或上拉加载时，上下滑动的边界值判定问题。（[#8](https://github.com/jenly1314/UltraSwipeRefresh/issues/8)）
14+
* 优化一些细节
15+
16+
#### v1.1.2 ：2024-5-22
17+
* 修复BUG：部分机型在某些特定场景下，出现“无法再次触发下拉刷新”的问题。（[#7](https://github.com/jenly1314/UltraSwipeRefresh/issues/7)）
18+
19+
#### v1.1.1 ：2024-4-20
20+
* 修复BUG：刷新状态变化太快时，导致”完成时的定格提示动画”不执行的问题。（[#4](https://github.com/jenly1314/UltraSwipeRefresh/issues/4)）
21+
* 优化一些细节
22+
23+
#### v1.1.0 ：2023-12-17
24+
* 新增`UltraSwipeRefreshTheme`：用于统一管理全局默认配置
25+
* 新增参数`finishDelayMillis`：完成时延时时间（可用于定格展示提示内容）
26+
* 新增参数`vibrateEnabled`：是否启用振动（当滑动偏移量满足触发刷新或触发加载更多时，会有振动效果）
27+
28+
#### v1.0.0 ：2023-12-3
29+
* UltraSwipeRefresh初始版本

‎README.md‎

Lines changed: 16 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -38,7 +38,7 @@
3838
```gradle
3939
// 极致体验的Compose刷新组件 (*必须)
4040
implementation 'com.github.jenly1314.UltraSwipeRefresh:refresh:1.3.0'
41-
41+
4242
// 经典样式的指示器 (可选)
4343
implementation 'com.github.jenly1314.UltraSwipeRefresh:refresh-indicator-classic:1.3.0'
4444
// Lottie动画指示器 (可选)
@@ -94,7 +94,7 @@ fun UltraSwipeRefreshSample() {
9494
val state = rememberUltraSwipeRefreshState()
9595
var itemCount by remember { mutableIntStateOf(20) }
9696
val coroutineScope = rememberCoroutineScope()
97-
97+
9898
UltraSwipeRefresh(
9999
state = state,
100100
onRefresh = {
@@ -159,7 +159,7 @@ UltraSwipeRefreshTheme：主要用于统一管理全局默认配置。
159159
```kotlin
160160
// 全局设置默认的滑动模式 （建议在Application的onCreate中进行配置）
161161
UltraSwipeRefreshTheme.config = UltraSwipeRefreshTheme.config.copy(
162-
headerScrollMode = NestedScrollMode.Translate,
162+
headerScrollMode = NestedScrollMode.Translate,
163163
footerScrollMode = NestedScrollMode.Translate,
164164
)
165165
```
@@ -169,19 +169,19 @@ UltraSwipeRefreshTheme.config = UltraSwipeRefreshTheme.config.copy(
169169

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

172-
| 默认官方样式 | 经典样式 |
172+
| 默认官方样式 | 经典样式 |
173173
|:--------------------------------------------------------------------------------------------------------------------------------|:----------------------------------------------------------------------------------------------------------------------------------|
174-
| SwipeRefreshHeader | ClassicRefreshHeader |
175-
| ![Image](art/SwipeRefreshIndicatorSample.gif) | ![Image](art/ClassicRefreshIndicatorSample.gif) |
176-
| SwipeRefreshFooter | ClassicRefreshFooter |
177-
| [对应的代码示例](app/src/main/java/com/king/ultraswiperefresh/app/sample/SwipeRefreshIndicatorSample.kt) | [对应的代码示例](app/src/main/java/com/king/ultraswiperefresh/app/sample/ClassicRefreshIndicatorSample.kt) |
174+
| SwipeRefreshHeader | ClassicRefreshHeader |
175+
| ![Image](art/SwipeRefreshIndicatorSample.gif) | ![Image](art/ClassicRefreshIndicatorSample.gif) |
176+
| SwipeRefreshFooter | ClassicRefreshFooter |
177+
| [对应的代码示例](app/src/main/java/com/king/ultraswiperefresh/app/sample/SwipeRefreshIndicatorSample.kt) | [对应的代码示例](app/src/main/java/com/king/ultraswiperefresh/app/sample/ClassicRefreshIndicatorSample.kt) |
178178

179-
| 进度条样式 | Lottie动画样式 |
179+
| 进度条样式 | Lottie动画样式 |
180180
|:-----------------------------------------------------------------------------------------------------|:--------------------------------------------------------------------------------------------------------------------------------------|
181-
| ProgressRefreshHeader | LottieRefreshHeader |
182-
| ![Image](art/ProgressRefreshIndicatorSample.gif) | ![Image](art/LottieRefreshIndicatorSample.gif) |
183-
| ProgressRefreshFooter | LottieRefreshFooter |
184-
| [对应的代码示例](app/src/main/java/com/king/ultraswiperefresh/app/sample/ProgressRefreshIndicatorSample.kt) | [对应的代码示例](app/src/main/java/com/king/ultraswiperefresh/app/sample/LottieRefreshIndicatorSample.kt) |
181+
| ProgressRefreshHeader | LottieRefreshHeader |
182+
| ![Image](art/ProgressRefreshIndicatorSample.gif) | ![Image](art/LottieRefreshIndicatorSample.gif) |
183+
| ProgressRefreshFooter | LottieRefreshFooter |
184+
| [对应的代码示例](app/src/main/java/com/king/ultraswiperefresh/app/sample/ProgressRefreshIndicatorSample.kt) | [对应的代码示例](app/src/main/java/com/king/ultraswiperefresh/app/sample/LottieRefreshIndicatorSample.kt) |
185185

186186

187187
> 如果以上的指示器效果都不满足你的需求，你可以自定义去实现Header和Footer的指示器，也可以直接使用Lottie动画样式的指示器来可快速接入任何Lottie动画。
@@ -193,7 +193,9 @@ UltraSwipeRefreshTheme.config = UltraSwipeRefreshTheme.config.copy(
193193
#### [CodeTextField](https://github.com/jenly1314/CodeTextField)一个使用 Compose 实现的验证码输入框。
194194
#### [compose-component](https://github.com/jenly1314/compose-component) 一个Jetpack Compose的组件库；主要提供了一些小组件，便于快速使用。
195195

196-
## 版本记录
196+
<!-- end -->
197+
198+
## 版本日志
197199

198200
#### v1.3.0 ：2024-7-20
199201
* 更新compose至v1.6.0 (v1.5.0 -> v1.6.0) （[#13](https://github.com/jenly1314/UltraSwipeRefresh/issues/13)）
@@ -216,13 +218,11 @@ UltraSwipeRefreshTheme.config = UltraSwipeRefreshTheme.config.copy(
216218
* 优化一些细节
217219

218220
#### v1.1.0 ：2023-12-17
219-
220221
* 新增`UltraSwipeRefreshTheme`：用于统一管理全局默认配置
221222
* 新增参数`finishDelayMillis`：完成时延时时间（可用于定格展示提示内容）
222223
* 新增参数`vibrateEnabled`：是否启用振动（当滑动偏移量满足触发刷新或触发加载更多时，会有振动效果）
223224

224225
#### v1.0.0 ：2023-12-3
225-
226226
* UltraSwipeRefresh初始版本
227227

228228
## 赞赏

‎build.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7,5 +7,6 @@ plugins {
77
id 'com.android.application' version '8.1.2' apply false
88
id 'com.android.library' version '8.1.2' apply false
99
id 'org.jetbrains.kotlin.android' version '1.9.0' apply false
10+
id 'org.jetbrains.dokka' version '1.9.20'
1011
id 'com.vanniktech.maven.publish' version '0.25.3' apply false
1112
}

‎build_docs.sh‎

Lines changed: 25 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,25 @@
1+
#!/bin/bash
2+
3+
set -ex
4+
5+
# Generate the API docs
6+
./gradlew dokkaHtmlMultiModule
7+
8+
mkdir -p docs/api
9+
mv build/dokka/htmlMultiModule/* docs/api
10+
11+
# Copy in special files that GitHub wants in the project root.
12+
GITHUB_URL=https://github.com/jenly1314/UltraSwipeRefresh/
13+
echo $GITHUB_URL
14+
sed "/<!-- end -->/q" README.md > docs/index.md
15+
# sed -i "s|app/src/main/ic_launcher-web.png|ic_logo.png|g" docs/index.md
16+
sed -i "s|](app|](${GITHUB_URL}blob/master/app|g" docs/index.md
17+
sed -i "s|](art|](${GITHUB_URL}blob/master/art|g" docs/index.md
18+
sed -i "s|](refresh|](${GITHUB_URL}blob/master/refresh|g" docs/index.md
19+
cat CHANGELOG.md | grep -v '## 版本日志' > docs/changelog.md
20+
21+
cp -r art docs/art
22+
# cp app/src/main/ic_launcher-web.png docs/ic_logo.png
23+
24+
# Build the site locally
25+
mkdocs build

‎mkdocs.yml‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# Project information
2+
site_name: UltraSwipeRefresh
3+
site_url: https://jenly1314.github.io/UltraSwipeRefresh/
4+
site_description: "UltraSwipeRefresh for Android"
5+
site_author: Jenly
6+
remote_branch: gh-pages
7+
edit_uri: ""
8+
9+
# Repository
10+
repo_name: UltraSwipeRefresh
11+
repo_url: https://github.com/jenly1314/UltraSwipeRefresh
12+
13+
# Copyright
14+
copyright: 'Copyright &copy; 2016 - 2024 Jenly'
15+
16+
# Configuration
17+
theme:
18+
name: 'material'
19+
favicon: https://jenly1314.github.io/favicon.png
20+
logo: https://jenly1314.github.io/medias/logo.png
21+
icon:
22+
repo: fontawesome/brands/github
23+
language: zh
24+
palette:
25+
- media: "(prefers-color-scheme: light)"
26+
scheme: default
27+
primary: teal
28+
accent: blue
29+
toggle:
30+
icon: octicons/sun-24
31+
name: "切换到深色模式"
32+
- media: "(prefers-color-scheme: dark)"
33+
scheme: slate
34+
primary: teal
35+
accent: blue
36+
toggle:
37+
icon: octicons/moon-24
38+
name: "切换到浅色模式"
39+
features:
40+
- navigation.instant
41+
- navigation.instant.progress
42+
- navigation.tabs
43+
- content.code.copy
44+
45+
extra:
46+
social:
47+
- icon: material/home-circle
48+
link: https://jenly1314.github.io/
49+
- icon: simple/github
50+
link: https://github.com/jenly1314/
51+
- icon: simple/gitee
52+
link: https://gitee.com/jenly1314/
53+
- icon: fontawesome/solid/paper-plane
54+
link: mailto:[email protected]
55+
56+
markdown_extensions:
57+
- smarty
58+
- footnotes
59+
- meta
60+
- toc:
61+
permalink: true
62+
- attr_list
63+
- pymdownx.betterem:
64+
smart_enable: all
65+
- pymdownx.caret
66+
- pymdownx.emoji:
67+
emoji_index: !!python/name:materialx.emoji.twemoji
68+
emoji_generator: !!python/name:materialx.emoji.to_svg
69+
- pymdownx.inlinehilite
70+
- pymdownx.magiclink
71+
- pymdownx.smartsymbols
72+
- pymdownx.superfences
73+
- pymdownx.tilde
74+
- pymdownx.tabbed:
75+
alternate_style: true
76+
- tables
77+
78+
# Plugins
79+
plugins:
80+
- search
81+
82+
nav:
83+
- '概览': index.md
84+
- 'API文档': api/index.html
85+
- '版本日志': changelog.md
86+

‎refresh-indicator-classic/build.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
plugins {
22
id 'com.android.library'
33
id 'org.jetbrains.kotlin.android'
4+
id 'org.jetbrains.dokka'
45
id 'com.vanniktech.maven.publish'
56
}
67

‎refresh-indicator-lottie/build.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
plugins {
22
id 'com.android.library'
33
id 'org.jetbrains.kotlin.android'
4+
id 'org.jetbrains.dokka'
45
id 'com.vanniktech.maven.publish'
56
}
67

‎refresh-indicator-progress/build.gradle‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,7 @@
11
plugins {
22
id 'com.android.library'
33
id 'org.jetbrains.kotlin.android'
4+
id 'org.jetbrains.dokka'
45
id 'com.vanniktech.maven.publish'
56
}
67

0 commit comments

Comments
 (0)