46 | Image Hosting & Cross Origin Errors
467 |Croppie uses canvas.drawImage(...) to manipulate images. Thus, images must obey the CORS policy. More info can be found here.
",document.body.appendChild(t),e=38===t.offsetHeight,document.body.removeChild(t)}return e}}(),o=0;Prism.hooks.add("complete",function(t){var r=t.element.parentNode,a=r&&r.getAttribute("data-line");r&&a&&/pre/i.test(r.nodeName)&&(clearTimeout(o),e(".line-highlight",r).forEach(function(e){e.parentNode.removeChild(e)}),n(r,a),o=setTimeout(i,1))}),window.addEventListener&&window.addEventListener("hashchange",i)}}(); 8 | !function(){"undefined"!=typeof self&&self.Prism&&self.document&&Prism.hooks.add("complete",function(e){if(e.code){var t=e.element.parentNode,s=/\s*\bline-numbers\b\s*/;if(t&&/pre/i.test(t.nodeName)&&(s.test(t.className)||s.test(e.element.className))&&!e.element.querySelector(".line-numbers-rows")){s.test(e.element.className)&&(e.element.className=e.element.className.replace(s,"")),s.test(t.className)||(t.className+=" line-numbers");var n,a=e.code.match(/\n(?!$)/g),l=a?a.length+1:1,m=new Array(l+1);m=m.join(""),n=document.createElement("span"),n.className="line-numbers-rows",n.innerHTML=m,t.hasAttribute("data-start")&&(t.style.counterReset="linenumber "+(parseInt(t.getAttribute("data-start"),10)-1)),e.element.appendChild(n)}}})}(); 9 | -------------------------------------------------------------------------------- /deploy.js: -------------------------------------------------------------------------------- 1 | var ghpages = require('gh-pages'), 2 | path = require('path'); 3 | 4 | ghpages.publish(__dirname, function (err) { 5 | if (err) console.error(err); 6 | else console.log('Successfully deployed to gh-pages'); 7 | }); 8 | -------------------------------------------------------------------------------- /index.html: -------------------------------------------------------------------------------- 1 | 2 | 3 | 4 | 5 | 6 |
27 |
33 |
49 |
34 |
48 |
35 |
44 | Croppie
36 |37 | Croppie is a fast, easy to use image cropping plugin with tons of configuration options! 38 |
39 | 43 |
45 |
46 |
47 | The Basics
53 |
66 | <div class="demo"></div>
54 | <script>
55 | $('.demo').croppie({
56 | url: 'demo/demo-1.jpg',
57 | });
58 | </script>
59 | <!-- or even simpler -->
60 | <img class="my-image" src="demo/demo-1.jpg" />
61 | <script>
62 | $('.my-image').croppie();
63 | </script>
64 | Installation
71 |
79 |
83 | NPM:
72 |npm install croppieBower:
74 |bower install croppieDownload:
76 | 77 | 78 |79 |
Then add the following elements to your page:
80 |<link rel="stylesheet" href="croppie.css" />
81 | <script src="croppie.js"></script>Usage
88 |
98 | You can initialize Croppie with the following code:
89 | 90 |var c = new Croppie(document.getElementById('item'), opts);
91 | // call a method
92 | c.method(args);Or you can use jquery
94 |$('#item').croppie(opts);
95 | // call a method via jquery
96 | $('#item').croppie(method, args);Documentation
104 |
105 |
170 |
171 |
283 |
284 |
297 |
298 | Options
106 |-
107 |
-
108 | boundaryobject
109 |
The outer container of the cropper
110 | Default 111 |will default to the size of the container112 |
113 | -
114 | customClassstring
115 |
A class of your choosing to add to the container to add custom styles to your croppie
116 | Default''117 |
118 | -
119 | enableExifboolean
120 |
Enable exif orientation reading. Tells Croppie to read exif orientation from the image data and orient the image correctly before rendering to the page.
121 |Requires exif.js
122 | Defaultfalse123 |
124 | -
125 | enableOrientationboolean
126 |
Enable or disable support for specifying a custom orientation when binding images (See
127 | Default 128 |bindmethod)false129 |
130 | -
131 | enableResizeboolean
132 |
Enable or disable support for resizing the viewport area.
133 | Default 134 |false135 |
136 | -
137 | enableZoomboolean
138 |
Enable zooming functionality. If set to false - scrolling and pinching would not zoom.
139 | Defaulttrue140 |
141 | -
142 | enforceBoundaryboolean* Experimental
143 |
Restricts zoom so image cannot be smaller than viewport
144 | Defaulttrue145 |
146 | -
147 | mouseWheelZoombool/string
148 |
Enable or disable the ability to use the mouse wheel to zoom in and out on a croppie instance. If
149 | Default'ctrl'is passed mouse wheel will only work while control keyboard is pressedtrue150 |
151 | -
152 | showZoomerboolean
153 |
Hide or Show the zoom slider
154 | Defaulttrue155 |
156 | -
157 | viewportobject
158 |
The inner container of the coppie. The visible part of the image
159 | Default 160 |{ 161 | width: 100, 162 | height: 100, 163 | type: 'square' 164 | }165 |
166 | Valid type values:'square' 'circle'167 |
168 |
Methods
172 |-
173 |
-
174 | get()object
175 |
Get the crop points, and the zoom of the image.
176 |
177 | -
178 | bind({ url, points, orientation, zoom })Promise
179 |
Bind an image to the croppie. Returns a promise to be resolved when the image has been loaded and the croppie has been initialized.
180 | Parameters 181 |
182 |-
183 |
urlURL to image
184 | pointsArray of points that translate into[topLeftX, topLeftY, bottomRightX, bottomRightY]
185 | zoomApply zoom after image has been bound
186 | orientationCustom orientation, applied after exif orientation (if enabled). Only works with 187 |enableOrientationoption enabled (see 'Options'). 188 |
189 | Valid options are: 190 |-
191 |
1unchanged
192 | 2flipped horizontally
193 | 3rotated 180 degrees
194 | 4flipped vertically
195 | 5flipped horizontally, then rotated left by 90 degrees
196 | 6rotated clockwise by 90 degrees
197 | 7flipped horizontally, then rotated right by 90 degrees
198 | 8rotated counter-clockwise by 90 degrees
199 |
201 |
203 | -
204 | destroy()
205 |
Destroy a croppie instance and remove it from the DOM
206 |
207 | -
208 | result({ type, size, format, quality, circle })Promise
209 |
Get the resulting crop of the image.
210 | Parameters 211 |
212 |-
213 |
-
214 |
typeThe type of result to return defaults to'canvas'215 |
216 | -
217 |
'base64'returns a the cropped image encoded in base64 218 |
219 | -
220 |
'html'returns html of the image positioned within an div of hidden overflow 221 |
222 | -
223 |
'blob'returns a blob of the cropped image 224 |
225 | -
226 |
'rawcanvas'returns the canvas element allowing you to manipulate prior to getting the resulted image 227 |
228 | -
229 |
sizeThe size of the cropped image defaults to'viewport'230 |
231 | -
232 |
'viewport'the size of the resulting image will be the same width and height as the viewport 233 |
234 | -
235 |
'original'the size of the resulting image will be at the original scale of the image 236 |
237 | -
238 |
{width, height}an object defining the width and height. If only one dimension is specified, the other will be calculated using the viewport aspect ratio. 239 |
240 | -
241 |
formatIndicating the image format. 242 |
243 | -
244 | Default:
'png'245 |
246 | -
247 | Valid values:
'jpeg'|'png'|'webp'248 |
249 | -
250 |
qualityNumber between 0 and 1 indicating image quality. 251 |
252 | -
253 | Default:
1254 |
255 | -
256 |
circleforce the result to be cropped into a circle 257 |
258 | -
259 | Valid Values:
truefalse260 |
261 |
263 | -
214 |
-
264 | rotate(degrees)
265 |
Rotate the image by a specified degree amount. Only works with
266 |enableOrientationoption enabled (see 'Options').-
267 |
-
268 |
degreesValid Values:90, 180, 270, -90, -180, -270269 |
270 |
272 | -
268 |
-
273 | setZoom(value)
274 |
Set the zoom of a Croppie instance. The value passed in is still restricted to the min/max set by Croppie.
275 |-
276 |
-
277 |
valuea floating point to scale the image within the croppie. Must be between a min and max value set by croppie. 278 |
279 |
281 | -
277 |
Events
285 |-
286 |
-
287 | update(croppie)Croppie
288 |
Triggered when a drag or zoom occurs
289 |
294 |290 | $('.my-croppie').on('update.croppie', function(ev, cropData) {}); 291 | // or 292 | document.getElementById('another-croppie').addEventListener('update', function(ev) { var cropData = ev.detail; }); 293 |
295 |
303 |
305 | Demos
304 |
306 |
337 |
307 |
336 |
308 |
335 |
309 | Basic Example
310 |
331 |
311 | var basic = $('#demo-basic').croppie({
312 | viewport: {
313 | width: 150,
314 | height: 200
315 | }
316 | });
317 | basic.croppie('bind', {
318 | url: 'demo/cat.jpg',
319 | points: [77,469,280,739]
320 | });
321 | //on button click
322 | basic.croppie('result', 'html').then(function(html) {
323 | // html is div (overflow hidden)
324 | // with img positioned inside.
325 | });
327 |
328 | x
329 |
330 |
332 |
333 |
334 |
338 |
370 |
339 |
369 |
340 |
368 |
341 |
342 |
343 |
344 | Vanilla Example
345 |
367 |
346 | var el = document.getElementById('vanilla-demo');
347 | var vanilla = new Croppie(el, {
348 | viewport: { width: 100, height: 100 },
349 | boundary: { width: 300, height: 300 },
350 | showZoomer: false,
351 | enableOrientation: true
352 | });
353 | vanilla.bind({
354 | url: 'demo/demo-2.jpg',
355 | orientation: 4
356 | });
357 | //on button click
358 | vanilla.result('blob').then(function(blob) {
359 | // do something with cropped blob
360 | });
362 |
363 |
364 |
365 |
366 |
371 |
402 |
372 |
401 |
373 |
400 |
374 | Resizer Example
375 |
396 |
376 | var el = document.getElementById('resizer-demo');
377 | var resize = new Croppie(el, {
378 | viewport: { width: 100, height: 100 },
379 | boundary: { width: 300, height: 300 },
380 | showZoomer: false,
381 | enableResize: true,
382 | enableOrientation: true,
383 | mouseWheelZoom: 'ctrl'
384 | });
385 | resize.bind({
386 | url: 'demo/demo-2.jpg',
387 | });
388 | //on button click
389 | resize.result('blob').then(function(blob) {
390 | // do something with cropped blob
391 | });
393 |
394 |
395 |
397 |
398 |
399 |
403 |
439 |
458 |
404 |
438 |
405 |
437 |
406 | Upload Example (with exif orientation compatability)
407 |
428 |
408 | $uploadCrop = $('#upload-demo').croppie({
409 | enableExif: true,
410 | viewport: {
411 | width: 200,
412 | height: 200,
413 | type: 'circle'
414 | },
415 | boundary: {
416 | width: 300,
417 | height: 300
418 | }
419 | });
421 |
422 | Upload
423 |
424 |
425 |
426 |
427 |
429 |
436 |
430 | Upload a file to start cropping
431 |
432 |
433 |
434 |
435 | Important Notes
464 |
465 |
466 |
469 |
470 |
471 |
481 |
482 | Visibility and Binding
472 |Croppie is dependent on it's container being visible when the bind method is called. This can be an issue when your croppie component is inside a modal that isn't shown. Let's take the bootstrap modal for example..
473 |
474 | var myCroppie = $('#my-croppie').croppie(opts);
475 | $('#my-modal').on('shown.bs.modal', function(){
476 | myCroppie.croppie('bind', bindOpts);
477 | });
478 | If you are having issues getting the correct crop result, and your croppie instance is shown inside of a modal, try taking your croppie out of the modal and see if your issues persist. If they don't, then make sure that your bind method is called after the modal is done animating.
480 |
487 |
489 | Browser Support
488 |
490 |
502 | Croppie is supported in the following browsers:
491 |-
492 |
- Firefox 10+ 493 |
- Chrome 12+ 494 |
- IE 10+ 495 |
- Edge 496 |
- Safari 4+ 497 |
- Opera 15+ 498 |
- iOS 499 |
- Android 500 |
506 |
508 | Who
507 |
509 |
519 | 510 | Croppie was built by Foliotek for use in Foliotek Presentation. 511 |
512 |513 | Please submit any issues or questions on Github. 514 |
515 |516 | Check out some of our other open source tools: AjaxQ | LTI Tester 517 |
518 |