Image Crop Add-on

Component for cropping images. Wrapper for React component react-image-crop.

Features

The component allows to crop images and configure the following properties for a customized crop:

crop dimensions (unit, x and y coordinates, width, and height)
aspect ratio (for example, 1 for a square or 16/9 for landscape)
circular crop (selection are has circular shape)
keep selection (selection can't be disabled if the user clicks outside the selection area)
disabled (cannot resize or draw a new crop)
locked (cannot create or resize a crop, but can still drag the existing crop around)
min width (minimum crop width)
min height (minimum crop height)
max width (maximum crop width)
max height (maximum crop height)
rule of thirds (to show rule of thirds lines in the cropped area)

The cropped image result can be obtain as a URI using getCroppedImageDataUri method or as a Base64 encoded byte array by using getCroppedImageBase64 method.

Online demo

Online demo here

Download release

Available in Vaadin Directory

Maven install

Add the following dependencies in your pom.xml file:

<dependency>
   <groupId>com.flowingcode.vaadin.addons</groupId>
   <artifactId>image-crop-addon</artifactId>
   <version>X.Y.Z</version>
</dependency>

For SNAPSHOT versions see here.

Building and running demo

git clone repository
mvn clean install jetty:run

To see the demo, navigate to http://localhost:8080/

Release notes

See here

Issue tracking

The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.

Contributions

Contributions are welcome, but there are no guarantees that they are accepted as such.

As first step, please refer to our Development Conventions page to find information about Conventional Commits & Code Style requirements.

Then, follow these steps for creating a contribution:

Fork this project.
Create an issue to this project about the contribution (bug or feature) if there is no such issue about it already. Try to keep the scope minimal.
Develop and test the fix or functionality carefully. Only include minimum amount of code needed to fix the issue.
For commit message, use Conventional Commits to describe your change.
Send a pull request for the original project.
Comment on the original issue that you have implemented a fix for it.

License & Author

This add-on is distributed under Apache License 2.0. For license terms, see LICENSE.txt.

Image Crop Add-on is written by Flowing Code S.A.

Developer Guide

Getting started

Basic use

Image image = new Image("images/empty-plant.png", "image to crop");  
ImageCrop imageCrop = new ImageCrop(image);
add(imageCrop);

Get cropped image

Image croppedImage = new Image(imageCrop.getCroppedImageDataUri(), "cropped image")

Special configuration when using Spring

By default, Vaadin Flow only includes com/vaadin/flow/component to be always scanned for UI components and views. For this reason, the add-on might need to be allowed in order to display correctly.

To do so, just add com.flowingcode to the vaadin.allowed-packages property in src/main/resources/application.properties, like:

vaadin.allowed-packages = com.vaadin,org.vaadin,dev.hilla,com.flowingcode

More information on Spring scanning configuration here.

FlowingCode / ImageCrop

readme