compose-avatar-cropper
1.0.0indexedLightweight avatar cropping UI with touch gestures, pinch-to-zoom, pan, double-tap reset, circle and square masks, smooth animations, and simple state-driven crop API.
3
Stars
—
Used by
dependents
—
Health
/ 100
Compose Avatar Cropper
English
Compose Avatar Cropper is a lightweight and powerful image cropping library built with Kotlin Multiplatform and Jetpack Compose. It is designed for selecting and cropping user avatars with support for touch gestures.
Features
- 🚀 Multiplatform Support: Works seamlessly on Android and Desktop (JVM).
- 👆 Gestures: Supports pinch-to-zoom, pan, and double-tap to reset/zoom.
- 🎨 Custom Shapes: Supports both and cropping areas.
Installation
This library is available on Maven Central.
Add the dependency to your build.gradle.kts (commonMain):
commonMain.dependencies {
implementation("cn.mucute:compose-avatar-cropper:1.0.0")
}
Usage
1. Basic Implementation
Use the AvatarCropper composable to display the cropping interface.
import cn.mucute.compose.avatar.cropper.AvatarCropper
import cn.mucute.compose.avatar.cropper.CropShape
import cn.mucute.compose.avatar.cropper.rememberCropState
@Composable
{
cropState = rememberCropState()
AvatarCropper(
imageBitmap = imageBitmap,
state = cropState,
shape = CropShape.Circle,
modifier = Modifier.fillMaxSize(),
backgroundColor = Color.Black
)
Button(onClick = {
result = cropState.crop(imageBitmap)
}) {
Text()
}
}
2. API Reference
AvatarCropper
CropState
crop(imageBitmap: ImageBitmap): ImageBitmap?: Performs the crop operation and returns the result. Returnsnullif the crop area is invalid.reset(imageBitmap: ImageBitmap): Resets the image scale and position to fit the screen.updateShape(newShape: CropShape, imageBitmap: ImageBitmap): Dynamically changes the crop shape.
中文
Compose Avatar Cropper 是一个基于 Kotlin Multiplatform 和 Jetpack Compose 构建的轻量级且强大的图片裁剪库。专为用户头像选择和裁剪设计，支持流畅的手势操作。
功能特性
- 🚀 多平台支持: 完美支持 Android 和 Desktop (JVM)。
- 👆 手势操作: 支持双指缩放、拖拽移动以及双击复位/放大。
- 🎨 自定义形状: 支持 圆形 (Circle) 和 方形 (Square) 裁剪区域。
- 🔧 易于集成: 专为 Compose 设计的简洁 API。
- 🎭 : 内置状态切换动画。
引入教程
该库已发布到 Maven Central。
在您的 build.gradle.kts (commonMain) 中添加依赖：
commonMain.dependencies {
implementation("cn.mucute:compose-avatar-cropper:1.0.0")
}
使用文档
1. 基础实现
使用 AvatarCropper 组件来显示裁剪界面。
import cn.mucute.compose.avatar.cropper.AvatarCropper
import cn.mucute.compose.avatar.cropper.CropShape
import cn.mucute.compose.avatar.cropper.rememberCropState
@Composable
fun MyCropperScreen {
cropState = rememberCropState()
AvatarCropper(
imageBitmap = imageBitmap,
state = cropState,
shape = CropShape.Circle,
modifier = Modifier.fillMaxSize(),
backgroundColor = Color.Black
)
Button(onClick = {
result = cropState.crop(imageBitmap)
}) {
Text()
}
}
2. API 参考
AvatarCropper
CropState
crop(imageBitmap: ImageBitmap): ImageBitmap?: 执行裁剪操作并返回结果。如果裁剪区域无效则返回null。reset(imageBitmap: ImageBitmap): 重置图片缩放和位置以适应屏幕。updateShape(newShape: CropShape, imageBitmap: ImageBitmap): 动态更改裁剪形状。
License
Copyright 2024 mucute
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http:
Unless applicable law agreed to writing, software
distributed under the License distributed an BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express implied.
See the License the specific language governing permissions
limitations under the License.