JavaScript image cropper.
dist/
├── cropper.css
├── cropper.min.css (compressed)
├── cropper.js (UMD)
├── cropper.min.js (UMD, compressed)
├── cropper.common.js (CommonJS, default)
└── cropper.esm.js (ES Module)
npm install cropperjs
Include files:
<link href="/path/to/cropper.css" rel="stylesheet">
<script src="/path/to/cropper.js"></script>
The cdnjs provides CDN support for Cropper.js's CSS and JavaScript. You can find the links here.
new Cropper(element[, options])
element
HTMLImageElement or HTMLCanvasElementoptions (optional)
Object<!-- Wrap the image or canvas element with a block element (container) -->
<div>
<img id="image" src="picture.jpg">
</div>
/* Limit image width to avoid overflow the container */
img {
max-width: 100%; /* This rule is very important, please do not ignore this! */
}
var image = document.getElementById('image');
var cropper = new Cropper(image, {
aspectRatio: 16 / 9,
crop: function(event) {
console.log(event.detail.x);
console.log(event.detail.y);
console.log(event.detail.width);
console.log(event.detail.height);
console.log(event.detail.rotate);
console.log(event.detail.scaleX);
console.log(event.detail.scaleY);
}
});
How to crop a new area after zoom in or zoom out?
Just double click your mouse to enter crop mode.
How to move the image after crop an area?
Just double click your mouse to enter move mode.
How to fix aspect ratio in free ratio mode?
Just hold the
shiftkey when you resize the crop box.
How to crop a square area in free ratio mode?
Just hold the
shiftkey when you crop on the image.
The size of the cropper inherits from the size of the image's parent element (wrapper), so be sure to wrap the image with a visible block element.
If you are using cropper in a modal, you should initialize the cropper after the modal shown completely. Otherwise, you will not get a correct cropper.
The outputted cropped data bases on the original image size, so you can use them to crop the image directly.
If you try to start cropper on a cross-origin image, please make sure that your browser supports HTML5 CORS settings attributes, and your image server supports the Access-Control-Allow-Origin option (see the HTTP access control (CORS)).
Known iOS resource limits: As iOS devices limit memory, the browser may crash when you are cropping a large image (iPhone camera resolution). To avoid this, you may resize the image first (preferably below 1024 pixels) before start a cropper.
Known image size increase: When export the cropped image on browser-side with the HTMLCanvasElement.toDataURL method, the size of the exported image may be greater than the original image's. This is because the type of the exported image is not the same as the original image's. So just pass the type the original image's as the first parameter to toDataURL to fix this. For example, if the original type is JPEG, then use cropper.getCroppedCanvas().toDataURL('image/jpeg') to export image.
You may set cropper options with new Cropper(image, options).
If you want to change the global default options, You may use Cropper.setDefaults(options).
Number00: no restrictions1: restrict the crop box to not exceed the size of the canvas.2: restrict the minimum canvas size to fit within the container. If the proportions of the the canvas and the container differ, the minimum canvas will be surrounded by extra space in one of the dimensions.3: restrict the minimum canvas size to fill fit the container. If the proportions of the canvas and the container are different, the container will not be able to fit the whole canvas in one of the dimensions.Define the view mode of the cropper. If you set viewMode to 0, the crop box can extend outside the canvas, while a value of 1, 2 or 3 will restrict the crop box to the size of the canvas. A viewMode of 2 or 3 will additionally restrict the canvas to the container. Note that if the proportions of the canvas and the container are the same, there is no difference between 2 and 3.
String'crop''crop': create a new crop box'move': move the canvas'none': do nothingDefine the dragging mode of the cropper.
NumberNaNSet the aspect ratio of the crop box. By default, the crop box is free ratio.
ObjectnullThe previous cropped data if you had stored, will be passed to setData method automatically when initialized. Only available when the autoCrop option is set to true.
Element, Array (elements), NodeList or String (selector)''Add extra elements (containers) for previewing.
Notes:
aspectRatio option, be sure to set the same aspect ratio to the preview container.overflow: hidden style to the preview container.BooleantrueRe-render the cropper when resize the window.
BooleantrueRestore the cropped area after resize the window.
BooleantrueCheck if the current image is a cross-origin image.
If it is, when clone the image, a crossOrigin attribute will be added to the cloned image element and a timestamp will be added to the src attribute to reload the source image to avoid browser cache error.
By adding crossOrigin attribute to image will stop adding timestamp to image url and stop reload of image, but the request (XMLHttpRequest) to read the image data for orientation checking will require a timestamp now.
If the value of the image's crossOrigin attribute is "use-credentials", then the withCredentials attribute will set to true when read the image data by XMLHttpRequest.
BooleantrueCheck the current image's Exif Orientation information.
More exactly, read the Orientation value for rotating or flipping the image, and then override the Orientation value with 1 (the default value) to avoid some issues (1, 2) on iOS devices.
Requires to set both the rotatable and scalable options to true at the same time.
Note: Don't trust this all the time as some JPG images have incorrect (not standard) Orientation values.
Requires Typed Arrays support (IE 10+).
BooleantrueShow the black modal above the image and under the crop box.
BooleantrueShow the dashed lines above the crop box.
BooleantrueShow the center indicator above the crop box.
BooleantrueShow the white modal above the crop box (highlight the crop box).
BooleantrueShow the grid background of the container.
BooleantrueEnable to crop the image automatically when initialized.
Number0.8 (80% of the image)A number between 0 and 1. Define the automatic cropping area size (percentage).
BooleantrueEnable to move the image.
BooleantrueEnable to rotate the image.
BooleantrueEnable to scale the image.
BooleantrueEnable to zoom the image.
BooleantrueEnable to zoom the image by dragging touch.
BooleantrueEnable to zoom the image by wheeling mouse.
Number0.1Define zoom ratio when zoom the image by wheeling mouse.
BooleantrueEnable to move the crop box by dragging.
BooleantrueEnable to resize the crop box by dragging.
BooleantrueEnable to toggle drag mode between "crop" and "move" when click twice on the cropper.
Number200The minimum width of the container.
Number100The minimum height of the container.
Number0The minimum width of the canvas (image wrapper).
Number0The minimum height of the canvas (image wrapper).
Number0The minimum width of the crop box.
Note: This size is relative to the page, not the image.
Number0The minimum height of the crop box.
Note: This size is relative to the page, not the image.
FunctionnullA shortcut of the "ready" event.
FunctionnullA shortcut of the "cropstart" event.
FunctionnullA shortcut of the "cropmove" event.
FunctionnullA shortcut of the "cropend" event.
FunctionnullA shortcut of the "crop" event.
FunctionnullA shortcut of the "zoom" event.
As there is an asynchronous process when load the image, you should call most of the methods after ready, except "setAspectRatio", "replace" and "destroy".
If a method doesn't need to return any value, it will return the cropper instance (
this) for chain composition.
new Cropper(image, {
ready: function () {
// this.cropper[method](argument1, , argument2, ..., argumentN);
this.cropper.move(1, -1);
// Allows chain composition
this.cropper.move(1, -1).rotate(45).scale(1, -1);
}
});
Show the crop box manually.
new Cropper(image, {
autoCrop: false,
ready: function () {
// Do something here
// ...
// And then
this.cropper.crop();
}
});
Reset the image and crop box to their initial states.
Clear the crop box.
url:
StringhasSameSize (optional):
BooleanfalseReplace the image's src and rebuild the cropper.
Enable (unfreeze) the cropper.
Disable (freeze) the cropper.
Destroy the cropper and remove the instance from the image.
offsetX:
NumberoffsetY (optional):
NumberoffsetX.Move the canvas (image wrapper) with relative offsets.
cropper.move(1);
cropper.move(1, 0);
cropper.move(0, -1);
x:
Numberleft value of the canvasy (optional):
Numbertop value of the canvasx.Move the canvas (image wrapper) to an absolute point.
NumberZoom the canvas (image wrapper) with a relative ratio.
cropper.zoom(0.1);
cropper.zoom(-0.1);
ratio:
Numberpivot (optional):
Object{ x: Number, y: Number }Zoom the canvas (image wrapper) to an absolute ratio.
cropper.zoomTo(1); // 1:1 (canvasData.width === canvasData.naturalWidth)
const containerData = cropper.getContainerData();
// Zoom to 50% from the center of the container.
cropper.zoomTo(.5, {
x: containerData.width / 2,
y: containerData.height / 2,
});
NumberRotate the image with a relative degree.
Requires CSS3 2D Transforms support (IE 9+).
cropper.rotate(90);
cropper.rotate(-90);
NumberRotate the image to an absolute degree.
scaleX:
Number11 it does nothing.scaleY (optional):
NumberscaleX.Scale the image.
Requires CSS3 2D Transforms support (IE 9+).
cropper.scale(-1); // Flip both horizontal and vertical
cropper.scale(-1, 1); // Flip horizontal
cropper.scale(1, -1); // Flip vertical
Number11 it does nothing.Scale the abscissa of the image.
Number11 it does nothing.Scale the ordinate of the image.
rounded (optional):
Booleanfalsetrue to get rounded values.(return value):
Objectx: the offset left of the cropped areay: the offset top of the cropped areawidth: the width of the cropped areaheight: the height of the cropped arearotate: the rotated degrees of the imagescaleX: the scaling factor to apply on the abscissa of the imagescaleY: the scaling factor to apply on the ordinate of the imageOutput the final cropped area position and size data (base on the natural size of the original image).
You can send the data to server-side to crop the image directly:
- Rotate the image with the
rotateproperty.- Scale the image with the
scaleXandscaleYproperties.- Crop the image with the
x,y,widthandheightproperties.
ObjectgetData method.Change the cropped area position and size with new data (base on the original image).
Note: This method only available when the value of the
viewModeoption is greater than or equal to1.
Objectwidth: the current width of the containerheight: the current height of the containerOutput the container size data.
Objectleft: the offset left of the imagetop: the offset top of the imagewidth: the width of the imageheight: the height of the imagenaturalWidth: the natural width of the imagenaturalHeight: the natural height of the imageaspectRatio: the aspect ratio of the imagerotate: the rotated degrees of the image if rotatedscaleX: the scaling factor to apply on the abscissa of the image if scaledscaleY: the scaling factor to apply on the ordinate of the image if scaledOutput the image position, size and other related data.
Objectleft: the offset left of the canvastop: the offset top of the canvaswidth: the width of the canvasheight: the height of the canvasnaturalWidth: the natural width of the canvas (read only)naturalHeight: the natural height of the canvas (read only)Output the canvas (image wrapper) position and size data.
var imageData = cropper.getImageData();
var canvasData = cropper.getCanvasData();
if (imageData.rotate % 180 === 0) {
console.log(canvasData.naturalWidth === imageData.naturalWidth); // true
}
Objectleft: the new offset left of the canvastop: the new offset top of the canvaswidth: the new width of the canvasheight: the new height of the canvasChange the canvas (image wrapper) position and size with new data.
Objectleft: the offset left of the crop boxtop: the offset top of the crop boxwidth: the width of the crop boxheight: the height of the crop boxOutput the crop box position and size data.
Objectleft: the new offset left of the crop boxtop: the new offset top of the crop boxwidth: the new width of the crop boxheight: the new height of the crop boxChange the crop box position and size with new data.
options (optional):
Objectwidth: the destination width of the output canvas.height: the destination height of the output canvas.minWidth: the minimum destination width of the output canvas, the default value is 0.minHeight: the minimum destination height of the output canvas, the default value is 0.maxWidth: the maximum destination width of the output canvas, the default value is Infinity.maxHeight: the maximum destination height of the output canvas, the default value is Infinity.fillColor: a color to fill any alpha values in the output canvas, the default value is transparent.imageSmoothingEnabled: set to change if images are smoothed (true, default) or not (false).imageSmoothingQuality: set the quality of image smoothing, one of "low" (default), "medium", or "high".(return value):
HTMLCanvasElementNotes:
fillColor option first, if not, the transparent part in the JPEG image will become black by default.Browser support:
Get a canvas drawn the cropped image. If it is not cropped, then returns a canvas drawn the whole image.
After then, you can display the canvas as an image directly, or use HTMLCanvasElement.toDataURL to get a Data URL, or use HTMLCanvasElement.toBlob to get a blob and upload it to server with FormData if the browser supports these APIs.
Avoid to get a blank output image, you might need to set the maxWidth and maxHeight properties to limited numbers, because of the size limits of a canvas element.
cropper.getCroppedCanvas();
cropper.getCroppedCanvas({
width: 160,
height: 90,
minWidth: 256,
minHeight: 256,
maxWidth: 4096,
maxHeight: 4096,
fillColor: '#fff',
imageSmoothingEnabled: false,
imageSmoothingQuality: 'high',
});
// Upload cropped image to server if the browser supports `HTMLCanvasElement.toBlob`
cropper.getCroppedCanvas().toBlob(function (blob) {
var formData = new FormData();
formData.append('croppedImage', blob);
// Use `jQuery.ajax` method
$.ajax('/path/to/upload', {
method: "POST",
data: formData,
processData: false,
contentType: false,
success: function () {
console.log('Upload success');
},
error: function () {
console.log('Upload error');
}
});
});
NumberChange the aspect ratio of the crop box.
String'none''none', 'crop', 'move'Change the drag mode.
Tips: You can toggle the "crop" and "move" mode by double click on the cropper.
This event fires when the target image has been loaded and the cropper instance is ready for operating.
var cropper;
image.addEventListener('ready', function () {
console.log(this.cropper === cropper);
// -> true
});
cropper = new Cropper(image);
event.detail.originalEvent:
Eventmousedown, touchstart and pointerdownevent.detail.action:
String'crop': create a new crop box'move': move the canvas (image wrapper)'zoom': zoom in / out the canvas (image wrapper) by touch.'e': resize the east side of the crop box'w': resize the west side of the crop box's': resize the south side of the crop box'n': resize the north side of the crop box'se': resize the southeast side of the crop box'sw': resize the southwest side of the crop box'ne': resize the northeast side of the crop box'nw': resize the northwest side of the crop box'all': move the crop box (all directions)This event fires when the canvas (image wrapper) or the crop box starts to change.
image.addEventListener('cropstart', function (event) {
console.log(event.detail.originalEvent);
console.log(event.detail.action);
});
event.detail.originalEvent:
Eventmousemove, touchmove and pointermove.event.detail.action: the same as "cropstart".
This event fires when the canvas (image wrapper) or the crop box is changing.
event.detail.originalEvent:
Eventmouseup, touchend, touchcancel, pointerup and pointercancel.event.detail.action: the same as "cropstart".
This event fires when the canvas (image wrapper) or the crop box stops to change.
About these properties, see the
getDatamethod.
This event fires when the canvas (image wrapper) or the crop box changed.
Notes:
autoCrop option is set to true, a crop event will be triggered before the ready event.data option is set, another crop event will be triggered before ready event.event.detail.originalEvent:
Eventwheel, touchmove.event.detail.oldRatio:
Numberevent.detail.ratio:
NumbercanvasData.width / canvasData.naturalWidth)This event fires when a cropper instance starts to zoom in or zoom out its canvas (image wrapper).
image.addEventListener('zoom', function (event) {
// Zoom in
if (event.detail.ratio > event.detail.oldRatio) {
event.preventDefault(); // Prevent zoom in
}
// Zoom out
// ...
});
If you have to use other cropper with the same namespace, just call the Cropper.noConflict static method to revert to it.
<script src="other-cropper.js"></script>
<script src="cropper.js"></script>
<script>
Cropper.noConflict();
// Code that uses other `Cropper` can follow here.
</script>
Please read through our contributing guidelines.
Maintained under the Semantic Versioning guidelines.
2.0.0 (2025-03-01)
"scale" option for the event.detail.action of actionstart/move/ (c778cb6)FAQs
JavaScript image cropper.
We found that cropperjs2 demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Research
/Security News
A malicious Chrome extension posing as an Ethereum wallet steals seed phrases by encoding them into Sui transactions, enabling full wallet takeover.
Security News
Socket is heading to London! Stop by our booth or schedule a meeting to see what we've been working on.
Security News
OWASP’s 2025 Top 10 introduces Software Supply Chain Failures as a new category, reflecting rising concern over dependency and build system risks.