1
1
# PullToRefresh
2
2
3
-
4
3
` PullToRefresh ` 是 Miuix 中的下拉刷新组件,可为列表和其他可滚动内容提供刷新功能。它采用“状态提升”模式,提供了带动画的交互式刷新指示器,适用于需要刷新数据的各种场景。
5
4
6
5
::: warning 注意
7
6
该组件只适用于支持触控的场景,并且在网页构建目标中工作不佳!
8
7
:::
9
8
10
-
11
- 如需演示,请查看 <a href =" https://miuix-kotlin-multiplatform.github.io/miuix-jsCanvas/ " target =" _blank " rel =" noopener noreferrer " >Miuix Example</a > 的 DropDown 页。
12
-
9
+ 如需演示,请查看 <a href =" https://miuix-kotlin-multiplatform.github.io/miuix-jsCanvas/ " target =" _blank " >Miuix Example</a > 的 DropDown 页。
13
10
14
11
## 引入
15
12
@@ -18,7 +15,6 @@ import top.yukonga.miuix.kmp.basic.PullToRefresh
18
15
import top.yukonga.miuix.kmp.basic.rememberPullToRefreshState
19
16
```
20
17
21
-
22
18
## 基本用法
23
19
24
20
PullToRefresh 组件可以包裹任何可滚动的内容,采用“状态提升”模式:
@@ -71,19 +67,19 @@ PullToRefresh 组件有以下几种状态:
71
67
72
68
### PullToRefresh 属性
73
69
74
- | 属性名 | 类型 | 说明 | 默认值 | 是否必须 |
75
- | ------------------------ | ---------------------- | ------------------------ | -------------------------------------- | -------- |
76
- | isRefreshing | Boolean | 是否正在刷新 | 无 | 是 |
77
- | onRefresh | () -> Unit | 刷新触发时的回调函数 | 无 | 是 |
78
- | modifier | Modifier | 应用于容器的修饰符 | Modifier | 否 |
79
- | pullToRefreshState | PullToRefreshState | 下拉刷新状态控制器 | rememberPullToRefreshState() | 否 |
80
- | contentPadding | PaddingValues | 内容区的内边距 | PaddingValues(0.dp) | 否 |
81
- | topAppBarScrollBehavior | ScrollBehavior | 顶部应用栏滚动行为 | null | 否 |
82
- | color | Color | 刷新指示器的颜色 | PullToRefreshDefaults.color | 否 |
83
- | circleSize | Dp | 刷新指示器圆圈的大小 | PullToRefreshDefaults.circleSize | 否 |
84
- | refreshTexts | List<String > | 不同状态下显示的文本列表 | PullToRefreshDefaults.refreshTexts | 否 |
85
- | refreshTextStyle | TextStyle | 刷新文本的样式 | PullToRefreshDefaults.refreshTextStyle | 否 |
86
- | content | @Composable () -> Unit | 可滚动内容的可组合函数 | 无 | 是 |
70
+ | 属性名 | 类型 | 说明 | 默认值 | 是否必须 |
71
+ | ----------------------- | ---------------------- | ------------------------ | -------------------------------------- | -------- |
72
+ | isRefreshing | Boolean | 是否正在刷新 | 无 | 是 |
73
+ | onRefresh | () -> Unit | 刷新触发时的回调函数 | 无 | 是 |
74
+ | modifier | Modifier | 应用于容器的修饰符 | Modifier | 否 |
75
+ | pullToRefreshState | PullToRefreshState | 下拉刷新状态控制器 | rememberPullToRefreshState() | 否 |
76
+ | contentPadding | PaddingValues | 内容区的内边距 | PaddingValues(0.dp) | 否 |
77
+ | topAppBarScrollBehavior | ScrollBehavior | 顶部应用栏滚动行为 | null | 否 |
78
+ | color | Color | 刷新指示器的颜色 | PullToRefreshDefaults.color | 否 |
79
+ | circleSize | Dp | 刷新指示器圆圈的大小 | PullToRefreshDefaults.circleSize | 否 |
80
+ | refreshTexts | List\ < String> | 不同状态下显示的文本列表 | PullToRefreshDefaults.refreshTexts | 否 |
81
+ | refreshTextStyle | TextStyle | 刷新文本的样式 | PullToRefreshDefaults.refreshTextStyle | 否 |
82
+ | content | @Composable () -> Unit | 可滚动内容的可组合函数 | 无 | 是 |
87
83
88
84
89
85
@@ -109,7 +105,7 @@ PullToRefreshDefaults 提供下拉刷新组件的默认值。
109
105
| ---------------- | ------------- | -------------------- | ----------------------------------------------------------------------------------------- |
110
106
| color | Color | 刷新指示器的默认颜色 | Color.Gray |
111
107
| circleSize | Dp | 指示器圆圈的默认大小 | 20.dp |
112
- | refreshTexts | List<String > | 默认的刷新文本列表 | [ "Pull down to refresh", "Release to refresh", "Refreshing...", "Refreshed successfully"] |
108
+ | refreshTexts | List\ < String> | 默认的刷新文本列表 | [ "Pull down to refresh", "Release to refresh", "Refreshing...", "Refreshed successfully"] |
113
109
| refreshTextStyle | TextStyle | 默认的文本样式 | TextStyle(fontSize = 14.sp, fontWeight = Bold, color = color) |
114
110
115
111
0 commit comments