Krop

Additional

Language
Kotlin
Version
0.64 (Mar 16, 2021)
Created
Oct 2, 2017
Updated
Mar 16, 2021
Owner
avito.tech (avito-tech)
Contributors
Anton Danshin (ntoskrnl)
Dmitriy Voronin (dsvoronin)
Nikolay Nesterov (nesterov-n)
Igor Solkin (solkin)
lsh-silpion
Alexander Bakker (alexbakker)
Eugene Krivobokov (eugene-krivobokov)
vlad103
Alexandr Kutashov (Kutashov)
9
Activity
Badge
Generate
Download
Source code
APK file

Show card

Krop

The library is a small widget for image cropping in Instagram-like style.

Gradle

Step 1. Add this in your root build.gradle

    allprojects {
        repositories {
            maven { url 'https://jitpack.io' }
        }
    }

Step 2. Add the dependency

    dependencies {
        compile 'com.github.avito-tech:krop:VERSION'
    }

If you like to stay on the bleeding edge, or use certain commit as your dependency, you can use the short commit hash or anyBranch-SNAPSHOT as the version

Demo

Please see the demo app for library usage example.

Usage:

Add KropView to your layout:

<com.avito.android.krop.KropView
    android:id="@+id/krop_view"
    android:layout_width="match_parent"
    android:layout_height="match_parent"
    app:krop_aspectX="1"
    app:krop_aspectY="1"
    app:krop_offset="24dp"
    app:krop_overlayColor="#aaffffff"/>

To set bitmap you need to crop, just use method:

kropView.setBitmap(bitmap)

Obtaining result

To get cropped bitmap, use getCroppedBitmap:

val bitmap = kropView.getCroppedBitmap()

or get service object BitmapTransformation and crop bitmap manually when you need it:

val changes = kropView.getResultTransformation()
val result = bitmap.transformWith(changes)

Listeners

You may listen for image update event (move, scale, rotation), by defining TransformationListener:

    interface TransformationListener {

        fun onUpdate(transformation: KropTransformation)

    }

Basic View Configuration

  • Set an initial crop area's aspect ratio:

in XML layout:

app:krop_aspectX="4"
app:krop_aspectY="3"

or in code:

kropView.applyAspectRatio(aspectX = 4, aspectY = 3)
  • Set overlay color:

in XML layout:

app:krop_overlayColor="#aaffffff

or in code:

kropView.applyOverlayColor(color = 0xaaffffff)
  • Set minimum crop region offset (px):

in XML layout:

app:krop_offset="24dp"

or in code:

kropView.applyOffset(offset = 120)
  • Set overlay style:

in XML layout:

app:krop_shape="rect"

or in code:

kropView.applyOverlayShape(1)

All standart shapes are listed in OverlayShape class.

You can also create your own overlay, by inheriting OverlayView, and referencing it.

in XML layout:

app:krop_overlay="@id/custom_overlay"

or in code:

kropView.applyOverlay(CustomOverlay())

License

The MIT License (MIT)

Copyright (c) 2017 Avito Technology

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.