Reorderable库使用手册
安装指南
版本目录管理(Version Catalog)
对于使用版本目录管理的项目,在libs.versions.toml文件中添加以下内容:
[versions]
reorderable = "2.3.0"
[libraries]
reorderable = { module = "sh.calvin.reorderable:reorderable", version.ref = "reorderable" }
或者直接指定版本:
[libraries]
reorderable = { module = "sh.calvin.reorderable:reorderable", version = "2.3.0" }
Gradle集成
在Gradle构建脚本中,无论是Kotlin还是Groovy语法,按照下面的方式加入依赖:
Kotlin DSL
dependencies {
implementation("sh.calvin.reorderable:reorderable:2.3.0")
}
Groovy DSL
dependencies {
implementation 'sh.calvin.reorderable:reorderable:2.3.0'
}
项目使用说明
Reorderable库允许您在Jetpack Compose项目中的多种布局组件中实现拖拽重排序功能,支持包括LazyColumn, LazyRow, LazyVerticalGrid, LazyHorizontalGrid, LazyVerticalStaggeredGrid, LazyHorizontalStaggeredGrid, Column 和 Row 等。
基础使用示例
以LazyColumn为例,展示基本使用方法:
import sh.calvin.reorderable.ReorderableLazyColumn
// 在您的Compose函数中使用ReorderableLazyColumn
ReorderableLazyColumn(
modifier = Modifier.fillMaxSize(),
state = rememberLazyListState()
) {
items(items = myList) { item ->
MyListItem(item, onMove = { oldIndex, newIndex ->
// 实现item重排逻辑
myList.move(oldIndex, newIndex)
})
}
}
其中,MyListItem应包含一个可被拖动的手柄元素,并响应onMove回调以更新列表项的顺序。
功能特性
- 跨平台支持:适用于Android、iOS、桌面端、Web和其他支持Compose的平台。
- 自适应不同大小的项目:能够处理异构尺寸的列表项。
- 可选的非重排项:某些列表项可以设置为不可移动。
- 启动拖拽的方式选择:立即拖拽或长按后开始拖拽。
- 边缘滚动效果:当拖动至屏幕边缘时自动滚动(不适用于
Column和Row)。 - 动画过渡:利用最新的
animateItemPlacement进行平滑的移动动画。 - 拖拽手柄定制:可以通过子视图作为拖拽操作的手柄。
项目API使用文档
具体的API细节如ReorderableLazyColumn和相关配置的详细参数,以及如何定义onMove回调的具体逻辑,可以在库的官方GitHub页面查看最新文档或源代码注释。
注意事项
- 确保您的项目已迁移至最新版的Jetpack Compose,以兼容此库提供的所有特性。
- 测试多平台应用时,需关注各平台的具体表现,确保一致性和用户体验。
通过遵循上述指导,您可以有效地将Reorderable库集成到您的Compose项目中,轻松实现复杂的拖拽排序功能。
创作声明:本文部分内容由AI辅助生成(AIGC),仅供参考



