| 1 | # jQuery File Upload Plugin |
|---|
| 2 | |
|---|
| 3 | ## Demo |
|---|
| 4 | [Demo File Upload](http://aquantum-demo.appspot.com/file-upload) |
|---|
| 5 | |
|---|
| 6 | ## Setup instructions |
|---|
| 7 | [How to setup the plugin on your website](https://github.com/blueimp/jQuery-File-Upload/wiki/Setup) |
|---|
| 8 | |
|---|
| 9 | ## Features |
|---|
| 10 | * **Multiple file upload:** |
|---|
| 11 | Allows to select multiple files at once and upload them simultaneously. |
|---|
| 12 | * **Drag & Drop support:** |
|---|
| 13 | Allows to upload files by dragging them from your desktop or filemanager and dropping them on your browser window. |
|---|
| 14 | * **Upload progress bar:** |
|---|
| 15 | Shows a progress bar indicating the upload progress for individual files and for all uploads combined. |
|---|
| 16 | * **Cancelable uploads:** |
|---|
| 17 | Individual file uploads can be canceled to stop the upload progress. |
|---|
| 18 | * **Resumable uploads:** |
|---|
| 19 | Aborted uploads can be resumed with browsers supporting the Blob API. |
|---|
| 20 | * **Chunked uploads:** |
|---|
| 21 | Large files can be uploaded in smaller chunks with browsers supporting the Blob API. |
|---|
| 22 | * **Preview images:** |
|---|
| 23 | A preview of image files can be displayed before uploading with browsers supporting the required HTML5 APIs. |
|---|
| 24 | * **No browser plugins (e.g. Adobe Flash) required:** |
|---|
| 25 | The implementation is based on open standards like HTML5 and JavaScript and requires no additional browser plugins. |
|---|
| 26 | * **Graceful fallback for legacy browsers:** |
|---|
| 27 | Uploads files via XMLHttpRequests if supported and uses iframes as fallback for legacy browsers. |
|---|
| 28 | * **HTML file upload form fallback:** |
|---|
| 29 | Shows a standard HTML file upload form if JavaScript is disabled. |
|---|
| 30 | * **Cross-site file uploads:** |
|---|
| 31 | Supports uploading files to a different domain with Cross-site XMLHttpRequests. |
|---|
| 32 | * **Multiple plugin instances:** |
|---|
| 33 | Allows to use multiple plugin instances on the same webpage. |
|---|
| 34 | * **Customizable and extensible:** |
|---|
| 35 | Provides an API to set individual options and define callBack methods for various upload events. |
|---|
| 36 | * **Multipart and file contents stream uploads:** |
|---|
| 37 | Files can be uploaded as standard "multipart/form-data" or file contents stream (HTTP PUT file upload). |
|---|
| 38 | * **Compatible with any server-side application platform:** |
|---|
| 39 | Works with Google App Engine (Python, Java), Ruby on Rails, PHP and any other platform that supports HTTP file uploads. |
|---|
| 40 | |
|---|
| 41 | ## Requirements |
|---|
| 42 | * [jQuery](http://jquery.com/) v. 1.6+ |
|---|
| 43 | * [jQuery UI](http://jqueryui.com/) v. 1.8+ (required: Widget, optional: Progressbar, Button) |
|---|
| 44 | * jQuery Iframe Transport plugin (included) |
|---|
| 45 | * [jQuery Templates plugin](http://api.jquery.com/category/plugins/templates/) v. 1.0+ (optional) |
|---|
| 46 | |
|---|
| 47 | The jQuery UI widget factory is a requirement for the basic File Upload plugin, but very lightweight without any other dependencies. |
|---|
| 48 | The UI version of the File Upload plugin also requires the jQuery UI Progressbar and Button components as well as the jQuery Templates plugin. These dependencies are marked as optional, as the basic File Upload plugin can be used without them and the UI version of the plugin can be extended to override these dependencies with alternative solutions. |
|---|
| 49 | |
|---|
| 50 | ## Browser Support (tested versions) |
|---|
| 51 | * Google Chrome - 7.0+ |
|---|
| 52 | * Apple Safari - 4.0+ |
|---|
| 53 | * Mozilla Firefox - 3.0+ |
|---|
| 54 | * Opera - 10.0+ |
|---|
| 55 | * Microsoft Internet Explorer 6.0+ |
|---|
| 56 | |
|---|
| 57 | Drag & Drop is only supported on Google Chrome, Firefox 4.0+ and Safari 5.0+. |
|---|
| 58 | Microsoft Internet Explorer has no support for multiple file selection or upload progress. |
|---|
| 59 | [Extended browser support information](https://github.com/blueimp/jQuery-File-Upload/wiki/Browser-support). |
|---|
| 60 | |
|---|
| 61 | ## License |
|---|
| 62 | Released under the [MIT license](http://creativecommons.org/licenses/MIT/). |
|---|
| 63 | |
|---|
| 64 | ## Source Code & Download |
|---|
| 65 | * Browse and checkout the [source code](https://github.com/blueimp/jQuery-File-Upload). |
|---|
| 66 | * [Download](https://github.com/blueimp/jQuery-File-Upload/archives/master) the project to add the plugin to your website. |
|---|
| 67 | |
|---|
| 68 | ## Documentation & Support |
|---|
| 69 | * Documentation can be found on the [Project Wiki](https://github.com/blueimp/jQuery-File-Upload/wiki). |
|---|
| 70 | * Support requests and bug reports can be posted to the [Issue Tracker](https://github.com/blueimp/jQuery-File-Upload/issues). |
|---|
