Details | Last modification | View Log | RSS feed
| Rev | Author | Line No. | Line |
|---|---|---|---|
| 1 | espaco | 1 | # jQuery File Upload Plugin |
| 2 | |||
| 3 | ## Demo |
||
| 4 | [Demo File Upload](https://blueimp.github.io/jQuery-File-Upload/) |
||
| 5 | |||
| 6 | ## Description |
||
| 7 | File Upload widget with multiple file selection, drag&drop support, progress bars, validation and preview images, audio and video for jQuery. |
||
| 8 | Supports cross-domain, chunked and resumable file uploads and client-side image resizing. Works with any server-side platform (PHP, Python, Ruby on Rails, Java, Node.js, Go etc.) that supports standard HTML form file uploads. |
||
| 9 | |||
| 10 | ## Setup |
||
| 11 | * [How to setup the plugin on your website](https://github.com/blueimp/jQuery-File-Upload/wiki/Setup) |
||
| 12 | * [How to use only the basic plugin (minimal setup guide).](https://github.com/blueimp/jQuery-File-Upload/wiki/Basic-plugin) |
||
| 13 | |||
| 14 | ## Support |
||
| 15 | |||
| 16 | * **[Support Forum](https://groups.google.com/d/forum/jquery-fileupload)** |
||
| 17 | **Support requests** and **general discussions** about the File Upload plugin can be posted to the official |
||
| 18 | [Support Forum](https://groups.google.com/d/forum/jquery-fileupload). |
||
| 19 | If your question is not directly related to the File Upload plugin, you might have a better chance to get a reply by posting to [Stack Overflow](http://stackoverflow.com/questions/tagged/blueimp+jquery+file-upload). |
||
| 20 | |||
| 21 | * Bugs and Feature requests |
||
| 22 | **Bugs** and **Feature requests** can be reported using the [issues tracker](https://github.com/blueimp/jQuery-File-Upload/issues). |
||
| 23 | Please read the [issue guidelines](https://github.com/blueimp/jQuery-File-Upload/blob/master/CONTRIBUTING.md) before posting. |
||
| 24 | |||
| 25 | ## Features |
||
| 26 | * **Multiple file upload:** |
||
| 27 | Allows to select multiple files at once and upload them simultaneously. |
||
| 28 | * **Drag & Drop support:** |
||
| 29 | Allows to upload files by dragging them from your desktop or filemanager and dropping them on your browser window. |
||
| 30 | * **Upload progress bar:** |
||
| 31 | Shows a progress bar indicating the upload progress for individual files and for all uploads combined. |
||
| 32 | * **Cancelable uploads:** |
||
| 33 | Individual file uploads can be canceled to stop the upload progress. |
||
| 34 | * **Resumable uploads:** |
||
| 35 | Aborted uploads can be resumed with browsers supporting the Blob API. |
||
| 36 | * **Chunked uploads:** |
||
| 37 | Large files can be uploaded in smaller chunks with browsers supporting the Blob API. |
||
| 38 | * **Client-side image resizing:** |
||
| 39 | Images can be automatically resized on client-side with browsers supporting the required JS APIs. |
||
| 40 | * **Preview images, audio and video:** |
||
| 41 | A preview of image, audio and video files can be displayed before uploading with browsers supporting the required APIs. |
||
| 42 | * **No browser plugins (e.g. Adobe Flash) required:** |
||
| 43 | The implementation is based on open standards like HTML5 and JavaScript and requires no additional browser plugins. |
||
| 44 | * **Graceful fallback for legacy browsers:** |
||
| 45 | Uploads files via XMLHttpRequests if supported and uses iframes as fallback for legacy browsers. |
||
| 46 | * **HTML file upload form fallback:** |
||
| 47 | Allows progressive enhancement by using a standard HTML file upload form as widget element. |
||
| 48 | * **Cross-site file uploads:** |
||
| 49 | Supports uploading files to a different domain with cross-site XMLHttpRequests or iframe redirects. |
||
| 50 | * **Multiple plugin instances:** |
||
| 51 | Allows to use multiple plugin instances on the same webpage. |
||
| 52 | * **Customizable and extensible:** |
||
| 53 | Provides an API to set individual options and define callBack methods for various upload events. |
||
| 54 | * **Multipart and file contents stream uploads:** |
||
| 55 | Files can be uploaded as standard "multipart/form-data" or file contents stream (HTTP PUT file upload). |
||
| 56 | * **Compatible with any server-side application platform:** |
||
| 57 | Works with any server-side platform (PHP, Python, Ruby on Rails, Java, Node.js, Go etc.) that supports standard HTML form file uploads. |
||
| 58 | |||
| 59 | ## Requirements |
||
| 60 | |||
| 61 | ### Mandatory requirements |
||
| 62 | * [jQuery](https://jquery.com/) v. 1.6+ |
||
| 63 | * [jQuery UI widget factory](https://api.jqueryui.com/jQuery.widget/) v. 1.9+ (included) |
||
| 64 | * [jQuery Iframe Transport plugin](https://github.com/blueimp/jQuery-File-Upload/blob/master/js/jquery.iframe-transport.js) (included) |
||
| 65 | |||
| 66 | The jQuery UI widget factory is a requirement for the basic File Upload plugin, but very lightweight without any other dependencies from the jQuery UI suite. |
||
| 67 | |||
| 68 | The jQuery Iframe Transport is required for [browsers without XHR file upload support](https://github.com/blueimp/jQuery-File-Upload/wiki/Browser-support). |
||
| 69 | |||
| 70 | ### Optional requirements |
||
| 71 | * [JavaScript Templates engine](https://github.com/blueimp/JavaScript-Templates) v. 2.5.4+ |
||
| 72 | * [JavaScript Load Image library](https://github.com/blueimp/JavaScript-Load-Image) v. 1.13.0+ |
||
| 73 | * [JavaScript Canvas to Blob polyfill](https://github.com/blueimp/JavaScript-Canvas-to-Blob) v. 2.1.1+ |
||
| 74 | * [blueimp Gallery](https://github.com/blueimp/Gallery) v. 2.15.1+ |
||
| 75 | * [Bootstrap CSS framework](http://getbootstrap.com/) v. 3.2.0+ |
||
| 76 | * [Glyphicons](http://glyphicons.com/) |
||
| 77 | |||
| 78 | The JavaScript Templates engine is used to render the selected and uploaded files for the Basic Plus UI and jQuery UI versions. |
||
| 79 | |||
| 80 | The JavaScript Load Image library and JavaScript Canvas to Blob polyfill are required for the image previews and resizing functionality. |
||
| 81 | |||
| 82 | The blueimp Gallery is used to display the uploaded images in a lightbox. |
||
| 83 | |||
| 84 | The user interface of all versions except the jQuery UI version is built with Twitter's [Bootstrap](http://getbootstrap.com/) framework and icons from [Glyphicons](http://glyphicons.com/). |
||
| 85 | |||
| 86 | ### Cross-domain requirements |
||
| 87 | [Cross-domain File Uploads](https://github.com/blueimp/jQuery-File-Upload/wiki/Cross-domain-uploads) using the [Iframe Transport plugin](https://github.com/blueimp/jQuery-File-Upload/blob/master/js/jquery.iframe-transport.js) require a redirect back to the origin server to retrieve the upload results. The [example implementation](https://github.com/blueimp/jQuery-File-Upload/blob/master/js/main.js) makes use of [result.html](https://github.com/blueimp/jQuery-File-Upload/blob/master/cors/result.html) as a static redirect page for the origin server. |
||
| 88 | |||
| 89 | The repository also includes the [jQuery XDomainRequest Transport plugin](https://github.com/blueimp/jQuery-File-Upload/blob/master/js/cors/jquery.xdr-transport.js), which enables limited cross-domain AJAX requests in Microsoft Internet Explorer 8 and 9 (IE 10 supports cross-domain XHR requests). |
||
| 90 | The XDomainRequest object allows GET and POST requests only and doesn't support file uploads. It is used on the [Demo](https://blueimp.github.io/jQuery-File-Upload/) to delete uploaded files from the cross-domain demo file upload service. |
||
| 91 | |||
| 92 | ## Browsers |
||
| 93 | |||
| 94 | ### Desktop browsers |
||
| 95 | The File Upload plugin is regularly tested with the latest browser versions and supports the following minimal versions: |
||
| 96 | |||
| 97 | * Google Chrome |
||
| 98 | * Apple Safari 4.0+ |
||
| 99 | * Mozilla Firefox 3.0+ |
||
| 100 | * Opera 11.0+ |
||
| 101 | * Microsoft Internet Explorer 6.0+ |
||
| 102 | |||
| 103 | ### Mobile browsers |
||
| 104 | The File Upload plugin has been tested with and supports the following mobile browsers: |
||
| 105 | |||
| 106 | * Apple Safari on iOS 6.0+ |
||
| 107 | * Google Chrome on iOS 6.0+ |
||
| 108 | * Google Chrome on Android 4.0+ |
||
| 109 | * Default Browser on Android 2.3+ |
||
| 110 | * Opera Mobile 12.0+ |
||
| 111 | |||
| 112 | ### Supported features |
||
| 113 | For a detailed overview of the features supported by each browser version please have a look at the [Extended browser support information](https://github.com/blueimp/jQuery-File-Upload/wiki/Browser-support). |
||
| 114 | |||
| 115 | ## License |
||
| 116 | Released under the [MIT license](http://www.opensource.org/licenses/MIT). |
||
| 117 | |||
| 118 | ## Donations |
||
| 119 | jQuery File Upload is free software, but you can donate to support the developer, Sebastian Tschan: |
||
| 120 | |||
| 121 | Flattr: [](https://flattr.com/thing/286433/jQuery-File-Upload-Plugin) |
||
| 122 | |||
| 123 | PayPal: [](https://www.paypal.com/cgi-bin/webscr?cmd=_s-xclick&hosted_button_id=PYWYSYP77KL54) |