js/jqueryfileupload/README.md

   1 # jQuery File Upload Plugin
   2
   3 ## Demo
   4 [Demo File Upload](http://blueimp.github.com/jQuery-File-Upload/)
   5
   6 ## Download
   7 * [Master branch (Bootstrap UI)](https://github.com/blueimp/jQuery-File-Upload/archive/master.zip)
   8 * [jQuery UI branch](https://github.com/blueimp/jQuery-File-Upload/archive/jquery-ui.zip)
   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 * **Support requests** and **general discussions** about the File Upload plugin can be posted to the official [support forum](https://groups.google.com/d/forum/jquery-fileupload).
  16 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).
  17 * **Bugs** and **Feature requests** can be reported using the [issues tracker](https://github.com/blueimp/jQuery-File-Upload/issues). Please read the [issue guidelines](https://github.com/blueimp/jQuery-File-Upload/blob/master/CONTRIBUTING.md) before posting.
  18
  19 ## Features
  20 * **Multiple file upload:**
  21   Allows to select multiple files at once and upload them simultaneously.
  22 * **Drag & Drop support:**
  23   Allows to upload files by dragging them from your desktop or filemanager and dropping them on your browser window.
  24 * **Upload progress bar:**
  25   Shows a progress bar indicating the upload progress for individual files and for all uploads combined.
  26 * **Cancelable uploads:**
  27   Individual file uploads can be canceled to stop the upload progress.
  28 * **Resumable uploads:**
  29   Aborted uploads can be resumed with browsers supporting the Blob API.
  30 * **Chunked uploads:**
  31   Large files can be uploaded in smaller chunks with browsers supporting the Blob API.
  32 * **Client-side image resizing:**
  33   Images can be automatically resized on client-side with browsers supporting the required JS APIs.
  34 * **Preview images:**
  35   A preview of image files can be displayed before uploading with browsers supporting the required JS APIs.
  36 * **No browser plugins (e.g. Adobe Flash) required:**
  37   The implementation is based on open standards like HTML5 and JavaScript and requires no additional browser plugins.
  38 * **Graceful fallback for legacy browsers:**
  39   Uploads files via XMLHttpRequests if supported and uses iframes as fallback for legacy browsers.
  40 * **HTML file upload form fallback:**
  41   Allows progressive enhancement by using a standard HTML file upload form as widget element.
  42 * **Cross-site file uploads:**
  43   Supports uploading files to a different domain with cross-site XMLHttpRequests or iframe redirects.
  44 * **Multiple plugin instances:**
  45   Allows to use multiple plugin instances on the same webpage.
  46 * **Customizable and extensible:**
  47   Provides an API to set individual options and define callBack methods for various upload events.
  48 * **Multipart and file contents stream uploads:**
  49   Files can be uploaded as standard "multipart/form-data" or file contents stream (HTTP PUT file upload).
  50 * **Compatible with any server-side application platform:**
  51   Works with any server-side platform (PHP, Python, Ruby on Rails, Java, Node.js, Go etc.) that supports standard HTML form file uploads.
  52
  53 ## Requirements
  54 * [jQuery](http://jquery.com/) v. 1.6+
  55 * [jQuery UI](http://jqueryui.com/) v. 1.9+
  56 * [jQuery Iframe Transport plugin](https://github.com/blueimp/jQuery-File-Upload/blob/master/jquery.iframe-transport.js) (included)
  57 * [JavaScript Templates engine](https://github.com/blueimp/JavaScript-Templates) v. 2.1.0+ (optional)
  58 * [JavaScript Load Image function](https://github.com/blueimp/JavaScript-Load-Image) v. 1.2.1+ (optional)
  59 * [JavaScript Canvas to Blob function](https://github.com/blueimp/JavaScript-Canvas-to-Blob) v. 2.0.3+ (optional)
  60
  61 The jQuery Iframe Transport is required for [browsers without XHR file upload support](https://github.com/blueimp/jQuery-File-Upload/wiki/Browser-support).
  62 The UI version of the File Upload plugin also requires the JavaScript Templates engine as well as the JavaScript Load Image and JavaScript Canvas to Blob functions (for the image previews and resizing functionality). 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.
  63
  64 The User Interface is built with [jQuery UI](http://jqueryui.com/). The demo also includes the [jQuery Image Gallery Plugin](https://github.com/blueimp/jQuery-Image-Gallery).
  65
  66 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 Cross-domain AJAX requests (GET and POST only) in Microsoft Internet Explorer >= 8. However, the XDomainRequest object doesn't support file uploads and the plugin is only used by the [Demo](http://blueimp.github.com/jQuery-File-Upload/) for Cross-domain requests to delete uploaded files from the demo file upload service.
  67
  68 [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.
  69
  70 ## Browsers
  71
  72 ### Desktop browsers
  73 The File Upload plugin is regularly tested with the latest browser versions and supports the following minimal versions:
  74
  75 * Google Chrome
  76 * Apple Safari 4.0+
  77 * Mozilla Firefox 3.0+
  78 * Opera 11.0+
  79 * Microsoft Internet Explorer 6.0+
  80
  81 ### Mobile browsers
  82 The File Upload plugin has been tested with and supports the following mobile browsers:
  83
  84 * Apple Safari on iOS 6.0+
  85 * Google Chrome on iOS 6.0+
  86 * Default Browser on Android 2.3+
  87 * Opera Mobile 12.0+
  88
  89 ### Supported features
  90 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).
  91
  92 ## License
  93 Released under the [MIT license](http://www.opensource.org/licenses/MIT).