Cropper

   

> A simple jQuery image cropping plugin. As of v4.0.0, the core code of Cropper is replaced with Cropper.js.

- Demo
- Cropper.js - JavaScript image cropper (recommended)
- jquery-cropper - A jQuery plugin wrapper for Cropper.js (recommended for jQuery users to use this instead of Cropper)

Main

``text
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)
`

Getting started

$3

`shell
npm install cropper jquery
`

Include files:

`html



`

$3

Initialize with $.fn.cropper method.

`html




`

`css
/ Limit image width to avoid overflow the container /
img {
max-width: 100%; / This rule is very important, please do not ignore this! /
}
`

`js
var $image = $('#image');

$image.cropper({
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);
}
});

// Get the Cropper.js instance after initialized
var cropper = $image.data('cropper');
`

Options

See the available options of Cropper.js.

`js
$('img').cropper(options);
`

Methods

See the available methods of Cropper.js.

`js
$('img').once('ready', function () {
$(this).cropper('method', argument1, , argument2, ..., argumentN);
});
`

Events

See the available events of Cropper.js.

`js
$('img').on('event', handler);
`

No conflict

If you have to use other plugin with the same namespace, just call the $.fn.cropper.noConflict method to revert to it.

`html



``

Browser support

It is the same as the browser support of Cropper.js. As a jQuery plugin, you also need to see the jQuery Browser Support.

Contributing

Please read through our contributing guidelines.

Versioning

Maintained under the Semantic Versioning guidelines.

License

MIT © Chen Fengyuan