CropSelectJs

A simple image cropping selection jQuery plugin.

View working example >

Example

By Zara 4 image compression service

Installation

  • Bower: bower install crop-select-js --save
  • NPM: npm install crop-select-js
  • Zip: Download

You will need to include both crop-select-js.min.js and crop-select-js.min.css into your web page.

Basic Example

Html code

<div id='crop-select'></div>

Javascript code

$('#crop-select').CropSelectJs({   imageSrc: 'path/to/image.jpg' });

Functions

To call a function on a CropSelectJs element, follow the pattern below. Replace the text 'function' with the name of the function you wish to call.

$('#crop-select').CropSelectJs('function')

The functions available are listed below:

Function Description
enableAnimatedBorder Make the selection border animated
disableAnimatedBorder Make the selection border static (not animated)
getSelectionBoxX Get the X coordinate of the selection box
setSelectionBoxX Set the X coordinate of the selection box
getSelectionBoxY Get the Y coordinate of the selection box
setSelectionBoxY Set the Y coordinate of the selection box
getSelectionBoxWidth Get the width of the selection box
setSelectionBoxWidth Set the width of the selection box
getSelectionBoxHeight Get the height of the selection box
setSelectionBoxHeight Set the height of the selection box
setSelectionAspectRatio Set the aspect ratio of the selection box
clearSelectionAspectRatio Clear the aspect ratio of the selection box (allows free resizing)
getImageSrc Get the src to the current image being displayed
getImageWidth Get the width of the current image being displayed
getImageHeight Get the height of the current image being display
getImageAspectRatio Get the aspect ratio of the current image being displayed
setImageSrc Set the src of the image to be displayed
selectEverything Select the entire image
selectCentredSquare Select a square centred in the middle of the image
selectCentredFittedAspectRatio Select an area matching the aspect ratio centred in the middle of the image

Events

Event Trigger Name Description
selectionResize crop-select-js.selection.resize Triggered when the crop selection is resized
selectionMove crop-select-js.selection.move Triggered when the crop selection is moves

Event 'selectionResize'

This event is triggered when the crop selection is resized.

You can attach a callback by either providing a callback function when initialising, or by attaching an event listener.

To attach the event listener when initialising, do:

$('#element').CropSelectJs({    // Set the image   imageSrc: 'path/to/image.jpg',    // Set the selection resize event handler   selectionResize: function(payload) {     // Do something...   }  });

Alternatively you can attach an event listener (which can be after initialisation) by:

$('#element').on('crop-select-js.selection.resize', function(payload) {   // Do something... });

Payload Object

The payload that is given on this event will have the structure:

{   width,              // The width of the selection on screen   height,             // The height of the selection on screen   widthScaledToImage, // The width of the selection scaled to the image   heightScaledToImage // The height of the selection scaled to the image } 

Event 'selectionMove'

This event is triggered when the crop selection is moved.

You can attach a callback by either providing a callback function when initialising, or by attaching an event listener.

To attach the event listener when initialising, do:

$('#element').CropSelectJs({    // Set the image   imageSrc: 'path/to/image.jpg',    // Set the selection move event handler   selectionMove: function(payload) {     // Do something...   }  });

Alternatively you can attach an event listener (which can be after initialisation) by:

$('#element').on('crop-select-js.selection.move', function(payload) {   // Do something... });

Payload Object

The payload that is given on this event will have the structure:

{   x,              // The x coordinate of the selection on screen   y,              // The y coordinate of the selection on screen   xScaledToImage, // The x coordinate of the selection scaled to the image   yScaledToImage  // The y coordinate of the selection scaled to the image } 

License

CropSelectJs is released under the GNU GPL 3.0 license. View license