Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add hover description for zoom in zoom out #8

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add hover description for zoom in zoom out #8

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
ad6c298
Add titles for hover to zoom buttons
Mark-Hetherington Apr 23, 2013
aa00788
Add custom buttons option
Mark-Hetherington Apr 23, 2013
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
152 changes: 78 additions & 74 deletions README.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,74 +1,78 @@
Description
===========
Easy to use jQuery plugin for zoom & pan image cropping.

Demo
====
Visit: http://www.tmatthew.net/jwindowcrop

Usage
=====
// minimum
$('img.crop_me').jWindowCrop();

// typical
$('img.crop_me').jWindowCrop({
targetWidth:300,
targetHeight:300,
onChange: function(result) {
console.log($(this).attr('id'));
console.log('x: '+result.cropX);
}
});

Options
=======
<table>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Required</th>
<th>Description</th>
</tr>
<tr>
<td>targetWidth</td><td>integer</td><td>320</td><td>no</td>
<td>Width in pixels of the cropping window</td>
</tr>
<tr>
<td>targetHeight</td><td>integer</td><td>180</td><td>no</td>
<td>Height in pixels of the cropping window</td>
</tr>
<tr>
<td>onChange</td><td>function</td><td>function(){}</td><td>no</td>
<td>Callback function that gets called whenever the values change. cropX, cropY, cropW, cropH, mustStretch (boolean) values are passed to this function in a hash. Use the this keyword in the function for a reference to the element that was updated.</td>
</tr>
<tr>
<td>zoomSteps</td><td>integer</td><td>10</td><td>no</td>
<td>Number of incremental zoom steps. With the default of 10, you have to click the zoom-in button 9 times to reach 100%.</td>
</tr>
<tr>
<td>loadingText</td><td>string</td><td>"Loading..."</td><td>no</td>
<td>Text (can be HTML) to display within frame until image is loaded.</td>
</tr>
<tr>
<td>smartControls</td><td>boolean</td><td>true</td><td>no</td>
<td>If true, controls will hide on mouseleave and appear on mouseenter.</td>
</tr>
<tr>
<td>showControlsOnStart</td><td>boolean</td><td>true</td><td>no</td>
<td>If true, controls will be hidden on start. Note: Do not set both this and smartControls to false.</td>
</tr>
</table>

Advanced
========
The structure for this plugin comes from http://starter.pixelgraphics.us/. An object is created for each dom element jWindowCrop is initialized on. A reverse reference to that object can be accessed like so:

var jwc = $('img#beach').getjWindowCrop();

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

Questions
=========
Email tyler at tmatthew dot net
Description
===========
Easy to use jQuery plugin for zoom & pan image cropping.

Demo
====
Visit: http://www.tmatthew.net/jwindowcrop

Usage
=====
// minimum
$('img.crop_me').jWindowCrop();

// typical
$('img.crop_me').jWindowCrop({
targetWidth:300,
targetHeight:300,
onChange: function(result) {
console.log($(this).attr('id'));
console.log('x: '+result.cropX);
}
});

Options
=======
<table>
<tr>
<th>Option</th>
<th>Type</th>
<th>Default</th>
<th>Required</th>
<th>Description</th>
</tr>
<tr>
<td>targetWidth</td><td>integer</td><td>320</td><td>no</td>
<td>Width in pixels of the cropping window</td>
</tr>
<tr>
<td>targetHeight</td><td>integer</td><td>180</td><td>no</td>
<td>Height in pixels of the cropping window</td>
</tr>
<tr>
<td>onChange</td><td>function</td><td>function(){}</td><td>no</td>
<td>Callback function that gets called whenever the values change. cropX, cropY, cropW, cropH, mustStretch (boolean) values are passed to this function in a hash. Use the this keyword in the function for a reference to the element that was updated.</td>
</tr>
<tr>
<td>zoomSteps</td><td>integer</td><td>10</td><td>no</td>
<td>Number of incremental zoom steps. With the default of 10, you have to click the zoom-in button 9 times to reach 100%.</td>
</tr>
<tr>
<td>loadingText</td><td>string</td><td>"Loading..."</td><td>no</td>
<td>Text (can be HTML) to display within frame until image is loaded.</td>
</tr>
<tr>
<td>smartControls</td><td>boolean</td><td>true</td><td>no</td>
<td>If true, controls will hide on mouseleave and appear on mouseenter.</td>
</tr>
<tr>
<td>showControlsOnStart</td><td>boolean</td><td>true</td><td>no</td>
<td>If true, controls will be hidden on start. Note: Do not set both this and smartControls to false.</td>
</tr>
<tr>
<td>customButtons</td><td>array</td><td>[]</td><td>no</td>
<td>Buttons can be added to the toolbar here. e.g: [{class:'jwc_replace',name:'Replace Image', handler:triggerUpload, content:'Replace Image'}]</td>
</tr>
</table>

Advanced
========
The structure for this plugin comes from http://starter.pixelgraphics.us/. An object is created for each dom element jWindowCrop is initialized on. A reverse reference to that object can be accessed like so:

var jwc = $('img#beach').getjWindowCrop();

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

Questions
=========
Email tyler at tmatthew dot net
Loading