Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/lyrebirdstudio/Croppy

Image Cropping Library for Android
https://github.com/lyrebirdstudio/Croppy

android crop crop-image cropper imagecropper kotlin ucrop view

Last synced: 16 days ago
JSON representation

Image Cropping Library for Android

Host: GitHub
URL: https://github.com/lyrebirdstudio/Croppy
Owner: lyrebirdstudio
Created: 2019-10-04T06:33:25.000Z (over 4 years ago)
Default Branch: master
Last Pushed: 2022-06-02T15:31:31.000Z (about 2 years ago)
Last Synced: 2024-02-23T00:35:53.788Z (4 months ago)
Topics: android, crop, crop-image, cropper, imagecropper, kotlin, ucrop, view
Language: Kotlin
Size: 20.8 MB
Stars: 1,104
Watchers: 20
Forks: 80
Open Issues: 16
Metadata Files:
- Readme: README.md

Lists

awesome-kotlin - Croppy - Image Cropping Library for Android (Libraries)
awesome-list - lyrebirdstudio/Croppy - Image Cropping Library for Android (Kotlin)
awesome-kotlin - Croppy - Image Cropping Library for Android (Libraries)

README

# Croppy

# Basic Usage
```kotlin
//Start croppy (source uri is the original image.)
val cropRequest = CropRequest.Auto(sourceUri = uri, requestCode = 101)
Croppy.start(this, cropRequest)
```
```kotlin
override fun onActivityResult(requestCode: Int, resultCode: Int, data: Intent?) {
super.onActivityResult(requestCode, resultCode, data)
if (requestCode == 101) {
imageview.setImageURI(data.data)
}
}
```

# Custom Usage

Create cropped image result in external storage
```kotlin
val externalCropRequest = CropRequest.Auto(sourceUri = uri, requestCode = RC_CROP_IMAGE)
```

Create cropped image result in cache storage
```kotlin
val cacheCropRequest = CropRequest.Auto(
sourceUri = uri,
requestCode = RC_CROP_IMAGE,
storageType = StorageType.CACHE
)
```

If you want to create destination file manually

```kotlin
val destinationUri = ...
val manuelCropRequest = CropRequest.Manual(
sourceUri = uri,
destinationUri = destinationUri,
requestCode = RC_CROP_IMAGE
)
```

If you want to exclude some specific aspect ratio from bottom aspect ratio list view.

```kotlin
val excludeAspectRatiosCropRequest = CropRequest.Manual(
sourceUri = uri,
destinationUri = destinationUri,
requestCode = RC_CROP_IMAGE,
excludedAspectRatios = arrayListOf(AspectRatio.ASPECT_FREE)
)
```

If you want to give specific theme as accent color.
```kotlin
val themeCropRequest = CropRequest.Manual(
sourceUri = uri,
destinationUri = destinationUri,
requestCode = RC_CROP_IMAGE,
croppyTheme = CroppyTheme(R.color.blue)
)
```

```kotlin
//Start croppy with your custom request.
Croppy.start(this, cropRequest)
```

# Demo

# Features

### Double tap focus 👆👆
It zooms-in to the touch points on double tap. Restores default state when user double taps on max scale state.

### Pinch Zoom 👌
Zoom in and out with two finger.

### Free Mode 🤟
You can crop your image in free mode. In any size.

### Aspect Ratio Mode 📱
Enhanced aspect ratio mode will help you while cropping. Aspect ratio will be fixed while you play with cropper. So for your social media apps, it will help you to crop in fixed size (instagram, facebook, twitter, 16:9, 1:2, 3:2 and more..)

### Size Displayer 🔟
While you scale your image, size displayer indicates the bitmap size reactively. It will provide a smoother experience to the user.

### Auto Centered 😍
What ever you do while cropping, we center the bitmap with animation. Smoother experience for user.

### Animations 🌟
We use animation everywhere in this cropper. User zoomed-out too much? We zoom back in with animation. User scrolled image out of borders? We scroll it back with animation.

# Setup
```groovy
allprojects {
repositories {
...
maven { url 'https://jitpack.io' }
}
}
```
```groovy
dependencies {
implementation 'com.github.lyrebirdstudio:Croppy:0.2'
}
```

License
--------

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.