react-avatar-editor, react-cropper, react-easy-crop, and react-image-crop are React libraries designed to enable image cropping functionality in web applications. They allow users to select, scale, rotate, and crop portions of an image, typically for profile pictures, thumbnails, or content editing. Each library offers a different balance of features, API design, and underlying dependencies — ranging from lightweight canvas-based solutions to wrappers around mature JavaScript cropping libraries.
When building a React app that requires users to crop images — whether for avatars, product thumbnails, or photo editing — choosing the right library can significantly affect your UX, performance, and maintenance overhead. All four packages (react-avatar-editor, react-cropper, react-easy-crop, react-image-crop) solve the core problem of letting users define a crop region, but they differ in architecture, feature set, and how they fit into a React application. Let’s break them down.
react-avatar-editor uses an HTML <canvas> element under the hood to render and manipulate the image. This allows for smooth zooming and panning, and the final output is generated directly from the canvas context.
// react-avatar-editor
import AvatarEditor from 'react-avatar-editor';
function CropAvatar() {
const editorRef = useRef();
const handleSave = () => {
const canvas = editorRef.current.getImageScaledToCanvas();
const dataUrl = canvas.toDataURL(); // final cropped image
};
return (
<div>
<AvatarEditor
ref={editorRef}
image="/path/to/image.jpg"
width={250}
height={250}
border={50}
color={[255, 255, 255, 0.6]} // RGBA
scale={1.2}
rotate={0}
/>
<button onClick={handleSave}>Save</button>
</div>
);
}
react-cropper is a React wrapper around Cropper.js, a mature but DOM-centric library. It manipulates <img> and <div> elements directly, which can feel “foreign” in a React app and sometimes leads to reconciliation issues or performance bottlenecks.
// react-cropper
import Cropper from 'react-cropper';
import 'cropperjs/dist/cropper.css';
function ImageCropper() {
const cropperRef = useRef();
const getCroppedData = () => {
const imageElement = cropperRef?.current;
const cropper = imageElement?.cropper;
return cropper.getCroppedCanvas().toDataURL();
};
return (
<Cropper
ref={cropperRef}
src="/path/to/image.jpg"
style={{ height: 400, width: '100%' }}
aspectRatio={1}
guides={false}
/>
);
}
react-easy-crop is a pure React component that renders the image normally and overlays a crop area using CSS transforms. It does not produce the final image — instead, it returns crop coordinates and zoom level, leaving actual image processing to you (typically via a <canvas>).
// react-easy-crop
import Cropper from 'react-easy-crop';
function EasyCrop() {
const [crop, setCrop] = useState({ x: 0, y: 0 });
const [zoom, setZoom] = useState(1);
const onCropComplete = useCallback((croppedArea, croppedAreaPixels) => {
// croppedAreaPixels contains { x, y, width, height }
// You must use these to draw on a canvas yourself
}, []);
return (
<Cropper
image="/path/to/image.jpg"
crop={crop}
zoom={zoom}
aspect={1}
onCropChange={setCrop}
onZoomChange={setZoom}
onCropComplete={onCropComplete}
/>
);
}
react-image-crop also uses a standard <img> tag with an absolutely positioned overlay to show the crop area. Like react-easy-crop, it returns pixel dimensions of the crop box but does not generate the final image.
// react-image-crop
import ReactCrop from 'react-image-crop';
import 'react-image-crop/dist/ReactCrop.css';
function SimpleCrop() {
const [crop, setCrop] = useState({ aspect: 1 });
const onCropComplete = (crop) => {
// crop contains { unit, x, y, width, height }
// Again, you must handle canvas cropping separately
};
return (
<ReactCrop
src="/path/to/image.jpg"
crop={crop}
onChange={setCrop}
onComplete={onCropComplete}
/>
);
}
| Feature | react-avatar-editor | react-cropper | react-easy-crop | react-image-crop |
|---|---|---|---|---|
| Zoom | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No |
| Rotation | ✅ Yes | ✅ Yes | ✅ Yes | ❌ No |
| Aspect Ratio Lock | ✅ Basic (via width/height) | ✅ Flexible | ✅ Yes | ✅ Yes |
| Circular Crop | ✅ Yes (via borderRadius) | ❌ No* | ❌ No | ❌ No |
| Touch Support | ⚠️ Limited | ✅ Yes | ✅ Excellent | ✅ Yes |
| Output Handling | ✅ Built-in (canvas) | ✅ Built-in | ❌ Manual required | ❌ Manual required |
*Note:
react-croppercan simulate circular crops with CSS, but the exported image remains rectangular.
This is a critical distinction. react-avatar-editor and react-cropper generate the final cropped image for you using their internal canvas logic. You call a method and get a data:image/png... string or blob.
In contrast, react-easy-crop and react-image-crop only tell you where to crop. You must write additional code to actually extract that region from the source image. Here’s a typical helper for react-easy-crop:
function createImage(url) {
return new Promise((resolve, reject) => {
const image = new Image();
image.addEventListener('load', () => resolve(image));
image.addEventListener('error', error => reject(error));
image.setAttribute('crossOrigin', 'anonymous');
image.src = url;
});
}
async function getCroppedImg(imageSrc, pixelCrop, rotation = 0) {
const image = await createImage(imageSrC);
const canvas = document.createElement('canvas');
const ctx = canvas.getContext('2d');
// Set canvas size to match crop
canvas.width = pixelCrop.width;
canvas.height = pixelCrop.height;
// Draw cropped region
ctx.drawImage(
image,
pixelCrop.x,
pixelCrop.y,
pixelCrop.width,
pixelCrop.height,
0,
0,
pixelCrop.width,
pixelCrop.height
);
return canvas.toDataURL('image/jpeg');
}
This extra step gives you control (e.g., to apply filters, change format, or upload binary data), but adds complexity.
For mobile apps or responsive sites, touch support is non-negotiable.
react-easy-crop shines here with built-in pinch-to-zoom and drag gestures using modern touch APIs.react-cropper also supports touch but can feel sluggish due to its DOM manipulation approach.react-avatar-editor has limited touch responsiveness — dragging works, but no pinch zoom.react-image-crop supports basic touch dragging but no zoom or rotation gestures.If your app targets mobile users heavily, react-easy-crop is the most polished out of the box.
How well does each library play with React’s state management, hooks, and reactivity?
react-avatar-editor uses a ref-based API, which feels imperative but is stable and predictable.react-cropper often requires useEffect to sync props with the underlying Cropper.js instance, leading to boilerplate.react-easy-crop and react-image-crop embrace controlled components: pass in crop, zoom, etc., as props and respond to changes via callbacks. This fits naturally with React’s data flow.Example of syncing react-cropper with state:
useEffect(() => {
if (cropperRef.current?.cropper) {
cropperRef.current.cropper.setAspectRatio(aspectRatio);
}
}, [aspectRatio]);
This kind of imperative glue code is unnecessary in react-easy-crop.
As of 2024:
react-avatar-editor is actively maintained with recent releases and TypeScript support.react-cropper is stable but largely mirrors updates from Cropper.js; development pace is slow but steady.react-easy-crop is very active, well-documented, and embraces modern React practices.react-image-crop receives occasional updates and remains functional for basic needs.None are officially deprecated, but react-cropper’s reliance on a non-React-native library makes it more fragile in fast-moving codebases.
react-avatar-editor if:react-cropper if:react-easy-crop if:react-image-crop if:There’s no single “best” library — only the best fit for your constraints. If you prioritize developer experience and mobile support, react-easy-crop is hard to beat. If you need turnkey image output with minimal code, react-avatar-editor delivers. For maximum flexibility at the cost of React purity, react-cropper remains a powerhouse. And for dead-simple rectangular selection, react-image-crop gets the job done without fuss.
Choose react-easy-crop if you want a modern, performant, and fully React-native implementation that supports touch gestures, zoom, and rotation with minimal bundle impact. It outputs crop coordinates rather than the final image, requiring you to handle the actual cropping (e.g., via canvas), which gives you full control over the output pipeline—ideal for applications needing precise control over image processing or integration with other libraries.
Choose react-image-crop if you prefer a lightweight, dependency-free component that provides basic rectangular cropping with aspect ratio enforcement and responsive behavior. It’s straightforward to integrate and works well for simple use cases like selecting a thumbnail area, but lacks built-in rotation, zoom, or circular cropping, so it’s not suitable for advanced editing scenarios.
Choose react-avatar-editor if you need a simple, canvas-based solution focused on avatar-style circular or square cropping with built-in zoom and positioning controls. It’s well-suited for user profile picture uploads where output is a cropped data URL or blob, but avoid it if you require advanced features like rotation, aspect ratio locking beyond basic ratios, or non-canvas rendering.
Choose react-cropper if you’re already using or comfortable with the underlying Cropper.js library and need extensive customization, including zoom, rotation, free scaling, and multiple output formats. However, be aware that this package wraps a DOM-heavy library, which can lead to performance issues in complex UIs or when managing many instances, and it may not integrate as smoothly with React’s declarative model.
A React component to crop images/videos with easy interactions
Check out the examples:
If react-easy-crop doesn't cover your needs we recommend taking a look at Pintura
Pintura features cropping, rotating, flipping, filtering, annotating, and lots of additional functionality to cover all your image and video editing needs on both mobile and desktop devices.
yarn add react-easy-crop
or
npm install react-easy-crop --save
The Cropper is styled with
position: absoluteto take the full space of its parent. Thus, you need to wrap it with an element that usesposition: relativeor the Cropper will fill the whole page.
import { useState, useCallback } from 'react'
import Cropper from 'react-easy-crop'
const Demo = () => {
const [crop, setCrop] = useState({ x: 0, y: 0 })
const [zoom, setZoom] = useState(1)
const onCropComplete = (croppedArea, croppedAreaPixels) => {
console.log(croppedArea, croppedAreaPixels)
}
return (
<Cropper
image={yourImage}
crop={crop}
zoom={zoom}
aspect={4 / 3}
onCropChange={setCrop}
onCropComplete={onCropComplete}
onZoomChange={setZoom}
/>
)
}
This component requires some styles to be available in the document. By default, you don't need to do anything, the component will automatically inject the required styles in the document head. If you want to disable this behaviour and manually inject the CSS, you can set the disableAutomaticStylesInjection prop to true and use the file available in the package: react-easy-crop/react-easy-crop.css.
If you are using the Cropper inside a modal, you should ensure that there is no opening animation that is changing the modal dimensions (scaling effect). Fading or sliding animations are fine. See #428, #409, #267 or #400 for more details.
| Prop | Type | Required | Description |
|---|---|---|---|
image | string | The image to be cropped. image or video is required. | |
video | string or Array<{ src: string; type?: string }> | The video to be cropped. image or video is required. | |
crop | { x: number, y: number } | ✓ | Position of the media. { x: 0, y: 0 } will center the media under the cropper. |
zoom | number | Zoom of the media between minZoom and maxZoom. Defaults to 1. | |
rotation | number (in degrees) | Rotation of the media. Defaults to 0. | |
aspect | number | Aspect of the cropper. The value is the ratio between its width and its height. The default value is 4/3 | |
minZoom | number | Minimum zoom of the media. Defaults to 1. | |
maxZoom | number | Maximum zoom of the media. Defaults to 3. | |
zoomWithScroll | boolean | Enable zoom by scrolling. Defaults to true | |
cropShape | 'rect' | 'round' | Shape of the crop area. Defaults to 'rect'. | |
cropSize | { width: number, height: number } | Size of the crop area (in pixels). If you don't provide it, it will be computed automatically using the aspect prop and the media size. You should probably not use this option and should rely on aspect instead. See https://github.com/ValentinH/react-easy-crop/issues/186. | |
showGrid | boolean | Whether to show or not the grid (third-lines). Defaults to true. | |
roundCropAreaPixels | boolean | Whether to round the crop area dimensions to integer pixels. Defaults to false. | |
zoomSpeed | number | Multiplies the value by which the zoom changes. Defaults to 1. | |
objectFit demo | 'contain', 'cover', 'horizontal-cover' or 'vertical-cover' | Specifies how the image is shown in the cropper. contain: the image will be adjusted to be fully visible, horizontal-cover: the image will horizontally fill the cropper, vertical-cover: the image will vertically fill the cropper, cover: we automatically pick between horizontal-cover or vertical-cover to have a fully visible image inside the cropper area. Defaults to "contain". | |
onCropChange | crop => void | ✓ | Called every time the crop is changed. Use it to update your crop state. |
onZoomChange | zoom => void | Called every time the zoom is changed. Use it to update your zoom state. | |
onRotationChange | rotation => void | Called every time the rotation is changed (with mobile or multi-fingers gestures). Use it to update your rotation state. | |
onCropSizeChange | cropSize => void | Called when a change in either the cropSize width or the cropSize height occurs. | |
onCropComplete | Function | Called when the user stops moving the media or stops zooming. It will be passed the corresponding cropped area on the media in percentages and pixels (rounded to the nearest integer) | |
onCropAreaChange | Function | Very similar to onCropComplete but is triggered for every user interaction instead of waiting for the user to stop. | |
transform | string | CSS transform to apply to the image in the editor. Defaults to translate(${crop.x}px, ${crop.y}px) rotate(${rotation}deg) scale(${zoom}) with variables being pulled from props. | |
style | { containerStyle: object, mediaStyle: object, cropAreaStyle: object } | Custom styles to be used with the Cropper. Styles passed via the style prop are merged with the defaults. | |
classes | { containerClassName: string, mediaClassName: string, cropAreaClassName: string } | Custom class names to be used with the Cropper. Classes passed via the classes prop are merged with the defaults. If you have CSS specificity issues, you should probably use the disableAutomaticStylesInjection prop. | |
mediaProps | object | The properties you want to apply to the media tag ( | |
cropperProps | object | The properties you want to apply to the cropper. | |
restrictPosition | boolean | Whether the position of the media should be restricted to the boundaries of the cropper. Useful setting in case of zoom < 1 or if the cropper should preserve all media content while forcing a specific aspect ratio for media throughout the application. Example: https://codesandbox.io/s/1rmqky233q. | |
initialCroppedAreaPercentages | { width: number, height: number, x: number, y: number} | Use this to set the initial crop position/zoom of the cropper (for example, when editing a previously cropped media). The value should be the same as the croppedArea passed to onCropComplete. This is the preferred way of restoring the previously set crop because croppedAreaPixels is rounded, and when used for restoration, may result in a slight drifting crop/zoom | |
initialCroppedAreaPixels | { width: number, height: number, x: number, y: number} | Use this to set the initial crop position/zoom of the cropper (for example, when editing a previously cropped media). The value should be the same as the croppedAreaPixels passed to onCropComplete Example: https://codesandbox.io/s/pmj19vp2yx. | |
onInteractionStart | Function | Called every time a user starts a wheel, touch, mousedown or keydown (for arrow keys only) event. | |
onInteractionEnd | Function | Called every time a user ends a wheel, touch, mousedown or keydown (for arrow keys only) event. | |
onMediaLoaded | Function | Called when media gets loaded. Gets passed an mediaSize object like { width, height, naturalWidth, naturalHeight } | |
onTouchRequest | (e: React.TouchEvent<HTMLDivElement>) => boolean | Can be used to cancel a touch request by returning false. | |
onWheelRequest | (e: WheelEvent) => boolean | Can be used to cancel a zoom with wheel request by returning false. | |
disableAutomaticStylesInjection | boolean | Whether to auto inject styles using a style tag in the document head on component mount. When disabled you need to import the css file into your application manually (style file is available in react-easy-crop/react-easy-crop.css). Example with sass/scss @import "~react-easy-crop/react-easy-crop";. | |
setCropperRef | (ref: React.RefObject<HTMLDivElement>) => void | Called when the component mounts, if present. Used to set the value of the cropper ref object in the parent component. | |
setImageRef | (ref: React.RefObject<HTMLImageElement>) => void | Called when the component mounts, if present. Used to set the value of the image ref object in the parent component. | |
setVideoRef | (ref: React.RefObject<HTMLVideoElement>) => void | Called when the component mounts, if present. Used to set the value of the video ref object in the parent component. | |
setMediaSize | (size: MediaSize) => void | [Advanced Usage] Used to expose the mediaSize value for use with the getInitialCropFromCroppedAreaPixels and getInitialCropFromCroppedAreaPercentages functions. See this CodeSandbox instance for a simple example. | |
setCropSize | (size: Size) => void | [Advanced Usage] Used to expose the cropSize value for use with the getInitialCropFromCroppedAreaPixels and getInitialCropFromCroppedAreaPercentages functions. See this CodeSandbox instance for a simple example. | |
nonce | string | The nonce to add to the style tag when the styles are auto injected. | |
keyboardStep | number | number of pixels the crop area moves with each press of an arrow key when using keyboard navigation. Defaults to 1. |
This callback is the one you should use to save the cropped area of the media. It's passed 2 arguments:
croppedArea: coordinates and dimensions of the cropped area in percentage of the media dimensioncroppedAreaPixels: coordinates and dimensions of the cropped area in pixels.Both arguments have the following shape:
const area = {
x: number, // x/y are the coordinates of the top/left corner of the cropped area
y: number,
width: number, // width of the cropped area
height: number, // height of the cropped area
}
This is the exact same callback as onCropComplete, but is triggered for all user interactions.
It can be used if you are not performing any render action on it.
croppedArea: coordinates and dimensions of the cropped area in percentage of the media dimensioncroppedAreaPixels: coordinates and dimensions of the cropped area in pixels.Both arguments have the following shape:
const area = {
x: number, // x/y are the coordinates of the top/left corner of the cropped area
y: number,
width: number, // width of the cropped area
height: number, // height of the cropped area
}
Called when media gets successfully loaded. This is useful if you want to have a custom zoom/crop strategy based on media size.
Example:
const CONTAINER_HEIGHT = 300
const CroppedImage = ({ image }) => {
const [crop, onCropChange] = React.useState({ x: 0, y: 0 })
const [zoom, onZoomChange] = React.useState(1)
return (
<Cropper
image={image}
crop={crop}
zoom={zoom}
onCropChange={onCropChange}
onZoomChange={onZoomChange}
onMediaLoaded={(mediaSize) => {
// Adapt zoom based on media size to fit max height
onZoomChange(CONTAINER_HEIGHT / mediaSize.naturalHeight)
}}
/>
)
}
[Advanced Usage]
Used to calculate values for crop and zoom based on a desired croppedAreaPercentages
value. See this CodeSandbox instance for a simple example.
[Advanced Usage]
See getInitialCropFromCroppedAreaPercentages.
yarn
yarn start
Now, open http://localhost:3001/index.html and start hacking!
This project is maintained by Valentin Hervieu.
This project was originally part of @ricardo-ch organisation because I (Valentin) was working at Ricardo. After leaving this company, they gracefully accepted to transfer the project to me. ❤️
Thanks goes to these wonderful people (emoji key):
This project follows the all-contributors specification. Contributions of any kind welcome!