/jQuery-crop

Image Cropping jQuery Plugin

Primary LanguageJavaScript

Description

Easy to use jQuery plugin for zoom & pan image cropping. This plugin is a complete rewrite of https://github.com/blackbiron/jWindowCrop

Demo

Visit: http://adriengibrat.github.com/jQuery-crop/

Usage

	// minimum
	$( 'img.crop' ).crop();

	// typical
	$( 'img.crop' )
		.crop( {
			width    : 300
			, height : 300
		} )
		.on ( 'crop', function( event ) {
				console.log( $( this ).attr( 'id' ), 'x: '+ event.cropX );
		} );

Options

Option Type Default Required Description
widthinteger320no Width in pixels of the cropping window
heightinteger180no Height in pixels of the cropping window
zoominteger10no Number of incremental zoom steps. With the default of 10, you have to click the zoom-in button 9 times to reach 100%.
loadingstring/dom"Loading..."no Text (can be HTML or dom) to display within frame until image is loaded.
controlsboolean/textClick to dragno If false, no controls will appears. Otherwise controls and text appears mouse hover (using css).

Event

To get crop results, bind a function on crop event. cropX, cropY, cropW, cropH, stretch (boolean) values are added to the event passed to this function.

Advanced

A reference to the crop object can be accessed like so:

	var crop = $( 'img.crop' ).data( 'crop' );

You then have access to all the properties and methods used for that specific element.