<div class="demo"></div>
<script>
$('.demo').croppie({
url: 'demo/demo-1.jpg',
});
</script>
NPM:
npm install croppie
Bower:
bower install croppie
Download:
Then add the following elements to your page:
<link rel="stylesheet" href="croppie.css" />
<script src="croppie.js"></script>
You can initialize Croppie with the following code:
var c = new Croppie(document.getElementById('item'), opts);
// call a method
c.method(args);
Or you can use jquery
$('#item').croppie(opts);
// call a method via jquery
$('#item').croppie(method, args);
The outer container of the cropper
Default{
width: 300,
height: 300
}
A class of your choosing to add to the container to add custom styles to your croppie
Default''
Enable exif orientation reading. Tells Croppie to read exif orientation from the image data and orient the image correctly before rendering to the page.
Requires exif.js
Defaultfalse
Enable or disable support for specifying a custom orientation when binding images (See bind
method)
false
Enable zooming functionality. If set to false - scrolling and pinching would not zoom.
Defaulttrue
Restricts zoom so image cannot be smaller than viewport
Defaulttrue
Enable or disable the ability to use the mouse wheel to zoom in and out on a croppie instance
Defaulttrue
Hide or Show the zoom slider
Defaulttrue
The inner container of the coppie. The visible part of the image
Default{
width: 100,
height: 100,
type: 'square'
}
'square' 'circle'
Get the crop points, and the zoom of the image.
Bind an image the croppie. Returns a promise to be resolved when the image has been loaded and the croppie has been initialized.
Parametersurl
URL to imagepoints
Array of points that translate into [topLeftX, topLeftY, bottomRightX, bottomRightY]
orientation
Custom orientation, applied after exif orientation (if enabled). Only works with enableOrientation
option enabled (see 'Options').
1
unchanged2
flipped horizontally3
rotated 180 degrees4
flipped vertically5
flipped horizontally, then rotated left by 90 degrees6
rotated clockwise by 90 degrees7
flipped horizontally, then rotated right by 90 degrees8
rotated counter-clockwise by 90 degreesDestroy a croppie instance and remove it from the DOM
Get the resulting crop of the image.
Parameterstype
The type of result to return defaults to 'canvas'
'canvas'
returns a the cropped image encoded in base64
'html'
returns html of the image positioned within an div of hidden overflow
size
The size of the cropped image defaults to 'viewport'
'viewport'
the size of the resulting image will be the same width and height as the viewport
'original'
the size of the resulting image will be at the original scale of the image
{width, height}
an object defining the width and height. If only one dimension is specified, the other will be calculated using the viewport aspect ratio.
format
Indicating the image format.
'png'
'jpeg'|'png'|'webp'
quality
Number between 0 and 1 indicating image quality.
1
circle
force the result to be cropped into a circle
true
false
Rotate the image by a specified degree amount. Only works with enableOrientation
option enabled (see 'Options').
degrees
Valid Values:90, 180, 270, -90, -180, -270
Set the zoom of a Croppie instance. The value passed in is still restricted to the min/max set by Croppie.
value
a floating point to scale the image within the croppie. Must be between a min and max value set by croppie.
Triggered when a drag or zoom occurs
var basic = $('#demo-basic').croppie({
viewport: {
width: 150,
height: 200
}
});
basic.croppie('bind', {
url: 'demo/cat.jpg',
points: [77,469,280,739]
});
//on button click
basic.croppie('result', 'html').then(function(html) {
// html is div (overflow hidden)
// with img positioned inside.
});
var el = document.getElementById('vanilla-demo');
var vanilla = new Croppie(el, {
viewport: { width: 100, height: 100 },
boundary: { width: 300, height: 300 },
showZoomer: false,
enableOrientation: true
});
vanilla.bind({
url: 'demo/demo-2.jpg',
orientation: 4
});
//on button click
vanilla.result('blob').then(function(blob) {
// do something with cropped blob
});
$uploadCrop = $('#upload-demo').croppie({
enableExif: true,
viewport: {
width: 300,
height: 300,
type: 'circle'
},
boundary: {
width: 400,
height: 400
}
});
Croppie is supported in the following browsers:
IE9 may be supported, but it isn't tested. If you're able to test it and let us know, please do so on Github.
Croppie was built by Foliotek for use in Foliotek Presentation.
Please submit any issues or questions on Github.
Check out some of our other open source tools: AjaxQ | LTI Tester