Details

Download
Version 1.2.1
Last updated 6th October 2009
Requirements
Demo View demo page
Links
License BSD License
Changelog
1.2.1
  • Added support for latest versions of Prototype & script.aculo.us (1.6.1.0 & 1.8.2 respectively). Changes provided by Tom Hirashima.
  • No-longer package prototype & script.aculo.us with the release
  • Changed tests to use google ajax libraries api to load prototype & script.aculo.us
  • Added option to not auto include the cropper CSS file
  • #00008 - Fixed bug: Dynamic include of cropper CSS expected cropper.js and failed when using cropper.uncompressed.js
  • #00028 - Fixed bug: Doesn't work with latest script.aculo.us - Fix by Tom Hirashima
  • #00030 - Fixed bug: Doesn't work in Firefox 3.5 (CSS include issue)
  • #00007 - Fixed bug: onEndCrop isn't called when moving with keys
  • #00011 - Fixed bug: The image that is to be cropped does not show in IE6.0 -- included CSS fix
  • Tidied up source code & fixed issues that jslint found so it will compress better
1.2.0
  • Added id to the preview image element using 'imgCrop_[originalImageID]'
  • #00001 - Fixed bug: Doesn't account for scroll offsets
  • #00009 - Fixed bug: Placing the cropper inside differently positioned elements causes incorrect co-ordinates and display
  • #00013 - Fixed bug: I-bar cursor appears on drag plane
  • #00014 - Fixed bug: If ID for image tag is not found in document script throws error
  • Fixed bug with drag start co-ordinates if wrapper element has moved in browser (e.g. dragged to a new position)
  • Fixed bug with drag start co-ordinates if image contained in a wrapper with scrolling - this may be buggy if image has other ancestors with scrolling applied (except the body)
  • #00015 - Fixed bug: When cropper removed and then reapplied onEndCrop callback gets called multiple times, solution suggestion from Bill Smith
  • Various speed increases & code cleanup which meant improved performance in Mac - which allowed removal of different overlay methods for IE and all other browsers, which led to a fix for:
  • #00010 - Fixed bug: Select area doesn't adhere to image size when image resized using img attributes
  • #00006 - Removed default behaviour of automatically setting a ratio when both min width & height passed, the ratioDimensions must be passed in
  • #00005 - Added ability to set maximum crop dimensions, if both min & max set as the same value then we'll get a fixed cropper size on the axes as appropriate and the resize handles will not be displayed as appropriate
  • Switched keydown for keypress for moving select area with cursor keys (makes for nicer action) - doesn't appear to work in Safari
1.1.3
  • Fixed wrong cursor on western handle in CSS
  • #00008 & #00003 - Added feature: Allow to set dimensions & position for cropper on load
  • #00002 - Fixed bug: Pressing 'remove cropper' twice removes image in IE
1.1.2
  • Fixed bugs with ratios when GCD is low (patch submitted by Andy Skelton)
1.1.1
  • Fixed bug with rendering issues fix in IE 5.5
  • Fixed bug with endCrop callback issues once cropper had been removed & reset in IE
1.1.0
  • Fixed bug with IE constantly trying to reload select area background image
  • Applied more robust fix to Safari & IE rendering issues
  • Added method to reset parameters - useful for when dynamically changing img the cropper is attached to
  • Added method to remove cropper from image
1.0.0
  • Initial verison

About

The JavaScript image cropper UI allows the user to crop an image using an interface with the same features and styling as found in commercial image editing software, and is is based on the Prototype JavaScript framework and script.aculo.us.

Initially I performed quite a lot of searching for some ready made solutions to meet my requirements, but found none that had the complete feature set that I required or any complete versions based on Prototype.

So after a week and a half of work, I present the JavaScript image cropper UI, built on Prototype & script.aculo.us.

Features

Screen shot of cropper in action

  • Un-obtrusive
  • Based on Prototype and script.aculo.us
  • Image editing package styling & functionality, the crop area functions and looks like those found in popular image editing software
  • Dynamic inclusion of required styles
  • Drag to draw areas
  • Shift drag to draw/resize areas as squares
  • Selection area can be moved
  • Selection area can be resized using resize handles
  • Allows dimension ratio limited crop areas
  • Allows minimum dimension crop areas
  • Allows maximum dimensions crop areas, if both min & max set as the same value then we'll get a fixed cropper size on the axes as appropriate and the resize handles will not be displayed as appropriate
  • Allows dynamic preview of resultant crop (if minimum width & height are provided), this is implemented as a subclass so can be removed if not required
  • Movement of selection area by arrow keys (shift + arrow key will move selection area by 10 pixels)
  • All operations stay within bounds of image
  • All functionality & display compatible with most popular browsers supported by Prototype, tested in:
    • PC: IE 6 & 5.5, Firefox 1.5, Opera 8.5 (see known issues) & 9.0b
    • MAC: Camino 1.0, Firefox 1.5, Safari 2.0

Usage

Extract to a directory of your choosing e.g. 'scripts/cropper/' and include the script and the required Prototype & script.aculo.us scripts:

Display code as plain text
HTML:
  1. <script type="text/javascript" src="scripts/cropper/lib/prototype.js" language="javascript"></script>
  2. <script type="text/javascript" src="scripts/cropper/lib/scriptaculous.js?load=effects,builder,dragdrop" language="javascript"></script>
  3. <script type="text/javascript" src="scripts/cropper/cropper.js" language="javascript"></script>

Options

ratioDim obj
The pixel dimensions to apply as a restrictive ratio, with properties x & y.
minWidth int
The minimum width for the select area in pixels.
minHeight int
The mimimum height for the select area in pixels.
maxWidth int
The maximum width for the select areas in pixels (if both minWidth & maxWidth set to same the width of the cropper will be fixed)
maxHeight int
The maximum height for the select areas in pixels (if both minHeight & maxHeight set to same the height of the cropper will be fixed)
displayOnInit int
Whether to display the select area on initialisation, only used when providing minimum width & height or ratio.
onEndCrop func
The callback function to provide the crop details to on end of a crop.
captureKeys boolean
Whether to capture the keys for moving the select area, as these can cause some problems at the moment.
onloadCoords obj
A coordinates object with properties x1, y1, x2 & y2; for the coordinates of the select area to display onload

The callback function

The callback function is a function that allows you to capture the crop co-ordinates when the user finished a crop movement, it is passed two arguments:

  • coords, obj, coordinates object with properties x1, y1, x2 & y2; for the coordinates of the select area.
  • dimensions, obj, dimensions object with properities width & height; for the dimensions of the select area.

An example function which outputs the crop values to form fields:

Display code as plain text
JavaScript:
  1. function onEndCrop( coords, dimensions ) {
  2.     $( 'x1' ).value = coords.x1;
  3.     $( 'y1' ).value = coords.y1;
  4.     $( 'x2' ).value = coords.x2;
  5.     $( 'y2' ).value = coords.y2;
  6.     $( 'width' ).value = dimensions.width;
  7.     $( 'height' ).value = dimensions.height;
  8. }

Basic interface

This basic example will attach the cropper UI to the test image and return crop results to the provided callback function.

Display code as plain text
HTML:
  1. <img src="test.jpg" alt="Test image" id="testImage" width="500" height="333" />
  2.  
  3.     <script type="text/javascript" language="javascript">
  4.     Event.observe( window, 'load', function() {
  5.         new Cropper.Img(
  6.             'testImage',
  7.             { onEndCrop: onEndCrop }
  8.         );
  9.     } );
  10. </script>

Minimum dimensions

You can apply minimum dimensions to a single axis or both, this example applies minimum dimensions to both axis.

Display code as plain text
HTML:
  1. <img src="test.jpg" alt="Test image" id="testImage" width="500" height="333" />
  2.  
  3. <script type="text/javascript" language="javascript">
  4.     Event.observe( window, 'load', function() {
  5.         new Cropper.Img(
  6.             'testImage',
  7.             {
  8.                 minWidth: 220,
  9.                 minHeight: 120,
  10.                 onEndCrop: onEndCrop
  11.             }
  12.         );
  13.     } );
  14. </script>

Select area ratio

You can apply a ratio to the selection area, this example applies a 4:3 ratio to the select area.

Display code as plain text
HTML:
  1. <img src="test.jpg" alt="Test image" id="testImage" width="500" height="333" />
  2.  
  3. <script type="text/javascript" language="javascript">
  4.     Event.observe( window, 'load', function() {
  5.         new Cropper.Img(
  6.             'testImage',
  7.             {
  8.                 ratioDim: {
  9.                     x: 220,
  10.                     y: 165
  11.                 },
  12.                 displayOnInit: true,
  13.                 onEndCrop: onEndCrop
  14.             }
  15.         );
  16.     } );
  17. </script>

With crop preview

You can display a dynamically produced preview of the resulting crop by using the ImgWithPreview subclass, a preview can only be displayed when we have a fixed size (set via minWidth & minHeight options). Note that the displayOnInit option is not required as this is the default behaviour when displaying a crop preview.

Display code as plain text
HTML:
  1. <img src="test.jpg" alt="Test image" id="testImage" width="500" height="333" />
  2. <div id="previewWrap"></div>
  3.  
  4. <script type="text/javascript" language="javascript">
  5.     Event.observe( window, 'load', function() {
  6.         new Cropper.ImgWithPreview(
  7.             'testImage',
  8.             {
  9.                 previewWrap: 'previewWrap',
  10.                 minWidth: 120,
  11.                 minHeight: 120,
  12.                 ratioDim: { x: 200, y: 120 },
  13.                 onEndCrop: onEndCrop
  14.             }
  15.         );
  16.     } );
  17. </script>

Known Issues

  • Safari animated gifs, only one of each will animate, this seems to be a known Safari issue.
  • After drawing an area and then clicking to start a new drag in IE 5.5 the rendered height appears as the last height until the user drags, this appears to be the related to another IE error (which has been fixed) where IE does not always redraw the select area properly.
  • Lack of CSS opacity support in Opera before version 9 mean we disable those style rules, if Opera 8 support is important you & you want the overlay to work then you can use the Opera rules in the CSS to apply a black PNG with 50% alpha transparency to replicate the effect.
  • Styling & borders on image, any CSS styling applied directly to the image itself (floats, borders, padding, margin, etc.) will cause problems with the cropper. The use of a wrapper element to apply these styles to is recommended.
  • overflow: auto or overflow: scroll on parent will cause cropper to burst out of parent in IE and Opera when applied (maybe Mac browsers too) I'm not sure why yet.

SEO Agency advanced JavaScript experience can enhance your site functionality. Adding the JavaScript Image Cropper is a good way to improve the user experience.

Next Steps

Download

Demo

View the demo pages for the JavaScript Image Cropper UI, using Prototype & script.aculo.us

Feature Requests & Bug Reports

Please check the existing list of feature requests & bugs and the discussion list before posting requests or reporting bugs.

Leave a Tip

If you find this code useful you can leave a donation towards the continued development & support.

Discussion

Note: Please only use the comments for general comments and the discussion list to discuss this code project (e.g. implementation queries, change suggestions etc.).

Comments

There have been 667 comments so far, join the discussion.

Pages: « 34 … 31 30 29 28 27 [26] 25 24 23 22 21 … 1 » Show All

520. Dave - 15th Sep 2008 - 8:36 pm

Graham:
It’s on my list of things to do for elusive version 2.0

519. Graham - 15th Sep 2008 - 8:34 pm

Thanks for getting back to me Dave :-)
Shame we can’t combine the scripts.

518. Dave - 13th Sep 2008 - 6:54 pm

Jimmy:
Thanks for moving that question to the Google Group, sorry that the spam filter picked it up to be moderated and I didn’t notice while I was away.

517. Dave - 13th Sep 2008 - 6:51 pm

Guenter:
I’ve just got back from holiday so I haven’t had chance to try Google chrome though, if you’re still having issues get in touch via the contact section and we’ll try and work it out.

Graham:
You won’t be able to combine the dynamic image version with the preview version as the preview version doesn’t get removed properly when you remove the cropper.

John:
Thanks for the donation, always appreciated.

516. John Ellmore - 9th Sep 2008 - 2:12 am

This is absolutely excellent, and it works perfectly. I used it in a custom CMS I built for a non-profit, and they were extremely happy at the usability of it.

Made a donation, thanks again!

515. Graham - 8th Sep 2008 - 3:39 pm

Hi, great script.
Is there a way to combine dynamic image version with preview version?

Thanks.

514. Noel - 7th Sep 2008 - 2:35 am

I left a remark a day or so ago, but I don’t see it here. Anyway, I think this is great. I’ve used it in a aspx page using VB. I’m not schooled coder. I learn as i go. When I was in school, there wasn’t a www, just vw’s. I hope you continue to build on this. I hope to chuck a buck or two towards it after i pay my property taxes.

513. Jimmy - 3rd Sep 2008 - 1:44 pm

Hi Guenter

I’ve posted your comments to Google Groups, which is where discussion is now taking place.

http://groups.google.com/group/javascript-image-cropper-ui

512. Guenter - 3rd Sep 2008 - 1:19 pm

I just noticed, that cropper seems to work on Google Crome. So it must be my implementation, which works fine on IE, FF and others I tested.

In my implementation, I’m grabbing a frame out of a flv video using ffmepg. The grabbed image is inserted into the website using js and right after that the cropper function is activated. This is why I can’t use the event.observe function, as the element is not available at page initialisation.

However on Google Crome the Cropper doesn’t show up and I have no idea what might be the problem. I must admit though, that I’m not much into js.

Maybe someone could check this out:

www.digitalproduction.com/grab

play the video, stop at some point and press the calculate button.

Thanks,
Guenter

511. Guenter - 3rd Sep 2008 - 10:30 am

You probably allready noticed: the cropper doesn’t work in the new google browser.

510. cws - 31st Aug 2008 - 4:25 am

thanks a lot, it is powerful and easy to use! Thank you very much!

509. Scott - 29th Aug 2008 - 10:55 pm

Your control is an awesome hack! Nicely done. I’m using it to create an online video editor that creates ringtones, video thumbnails, avatars and more. Why? My daughter wanted a video ringtone from a YouTube video :-)

508. Sarah Davis - 16th Aug 2008 - 9:46 pm

David, you are right, I only used to dispose the object from DOM without the remove fucntion.

Now its working perfectly. Many thanks for this amazing code.

s.

507. Dave - 16th Aug 2008 - 9:18 pm

Sarah: Are you removing the cropper with the remove method before adding a new one? If you are can you ask this question on the google group , then we can discuss it in more detail with code samples etc.

506. Sarah Davis - 16th Aug 2008 - 2:31 pm

Hi David, I have the same problem as Christopher (comment 444) if you load the image using AJAX more than once the actual event doesn’t get removed from the first time load and keep calling the onEndCrop while keep bringing the old cords values, any idea how to manually remove the call on DOM object removal perhaps?

Thanks,

Sarah

505. Sanjay - 15th Aug 2008 - 3:19 pm

Great code. I’m using it with some .NET server-side code for the complete image cropping solution. Again, nice job…

504. Dave - 1st Aug 2008 - 4:07 pm

Vadluri:
Please read the FAQ’s which are linked to in the information box at the top of the post.

503. Vadluri Sreenu - 1st Aug 2008 - 3:47 pm

hi,its working fine,but i have a problem here.
when ever i saw the preview of the cropped area, i want to save that cropped image in my server.
what can i do?
please help me
thanks in advanced

502. Dave - 22nd Jul 2008 - 1:02 pm

shivakumari:

I’m afraid that is really outside what the cropper UI is and explaining it here would take quite a while. I suggest you start by looking at the FAQ for how to save the cropped image, moving from there to saving it in a DB should be a matter of doing a little bit of research.

501. TheIceman - 22nd Jul 2008 - 12:59 pm

@shivakumari,

1. IM not going to spend 5 months writing an essay explaining how to do this
2. Spend a few years at university/TAFE studying javascript and a web programming language
3. search google for a script already done
4. search here for a script that is almost doing what you want it to.
5. dont ask too much from a free script.
6. pay someone else to do it for you

Pages:« 34 … 31 30 29 28 27 [26] 25 24 23 22 21 … 1 » Show All

Leave a comment

No HTML please, only textile. For code please use [lang]...[/lang] tags (e.g. [html]...[/html] for HTML)