Skip to content

rroohit/ImageCropView

Repository files navigation

Jetpack Compose ImageCropView

Image crop view for jetpack compose applications.

ImageCropView(@Composable) is a Jetpack Compose library for easy and customizable image cropping view in Android apps.

It supports various cropping styles like free-form, square, and circular cropping for profile pictures, making it simple to integrate cropping functionality into your Compose UI.

ImageCropView.MOV

Add in your project

Maven Central

Add this dependency to your module-level build.gradle in dependencies section :

dependencies {
    implementation 'io.github.rroohit:ImageCropView:2.3.0'
}

Using the ImageCropView

First We have to create an instance of ImageCrop(bitmap) by passing an bitmap.

Using .ImageCropView(...) you can customize your crop view. .ImageCropView(...) is jetpack compose @Composable function.

To get cropped bitmap invoke .onCrop().

private lateinit var imageCrop: ImageCrop
imageCrop = ImageCrop(bitmap)

// You can customize ImageCropView with following attributes.
imageCrop.ImageCropView(
    modifier = Modifier,            
    guideLineColor = Color.LightGray,
    guideLineWidth = 2.dp,
    edgeCircleSize = 5.dp,
    showGuideLines = true,
    cropType = CropType.SQUARE
)

imageCrop.onCrop() // To get the cropped image in bitmap format.

// Crop Types avail...
// 1 - CropType.FREE_STYLE
// 2 - CropType.SQUARE 
// 3 - CropType.PROFILE_CIRCLE

License

Copyright 2022 rohit

   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://www.apache.org/licenses/LICENSE-2.0

   Unless required by applicable law or agreed to in writing, software
   distributed under the License is distributed on an "AS IS" BASIS,
   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
   See the License for the specific language governing permissions and
   limitations under the License.