Component for cropping images. Wrapper for React component react-image-crop.
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.
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.
- git clone repository
- mvn clean install jetty:run
To see the demo, navigate to http://localhost:8080/
See here
The issues for this add-on are tracked on its github.com page. All bug reports and feature requests are appreciated.
Contributions are welcome. There are two primary ways you can contribute: by reporting issues or by submitting code changes through pull requests. To ensure a smooth and effective process for everyone, please follow the guidelines below for the type of contribution you are making.
Creating an issue is a highly valuable contribution. If you've found a bug or have an idea for a new feature, this is the place to start.
- Before creating an issue, please check the existing issues to see if your topic is already being discussed.
- If not, create a new issue, choosing the right option: "Bug Report" or "Feature Request". Try to keep the scope minimal but as detailed as possible.
A Note on Bug Reports
Please complete all the requested fields to the best of your ability. Each piece of information, like the environment versions and a clear description, helps us understand the context of the issue.
While all details are important, the minimal, reproducible example is the most critical part of your report. It's essential because it removes ambiguity and allows our team to observe the problem firsthand, exactly as you are experiencing it.
As a 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.
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.
- 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")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.