Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with
or
.
Download ZIP
Newer
Older
100644 87 lines (73 sloc) 7.377 kB
efef2ec @blueimp Updated list of supported browsers.
authored
1 # jQuery File Upload Plugin
2
3 ## Demo
e1e854b @blueimp Updated demo links.
authored
4 [Demo File Upload](http://blueimp.github.com/jQuery-File-Upload/)
efef2ec @blueimp Updated list of supported browsers.
authored
5
ca06ba1 @blueimp Updated README and added support URL.
authored
6 ## Setup
1eeced6 @blueimp Replace jQuery Templates with a new JavaScript Templates engine:
authored
7 * [How to setup the plugin on your website](https://github.com/blueimp/jQuery-File-Upload/wiki/Setup)
8 * [How to use only the basic plugin (minimal setup guide).](https://github.com/blueimp/jQuery-File-Upload/wiki/Basic-plugin)
2b84208 @blueimp Added a link to the setup instructions.
authored
9
ca06ba1 @blueimp Updated README and added support URL.
authored
10 ## Support
11 * **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).
12 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).
13 * **Bugs** in the File Upload plugin can be reported using the [issues tracker](https://github.com/blueimp/jQuery-File-Upload/issues).
9dde2e8 @blueimp Added bug report instructions.
authored
14 Please try to reproduce the problem with the [Demo](http://blueimp.github.com/jQuery-File-Upload/) or with an unmodified setup. Problems with customizations should be posted to the [support forum](https://groups.google.com/d/forum/jquery-fileupload), especially for server-side problems.
15 Provide as much details about your test setup as possible (server information, browser and operating system versions).
ca06ba1 @blueimp Updated README and added support URL.
authored
16 Please also provide a [JSFiddle](http://jsfiddle.net/) to allow to reproduce the problem, if possible.
17 * **Feature requests** can also be posted to the [issues tracker](https://github.com/blueimp/jQuery-File-Upload/issues) if the implementation would benefit a broader use case or the plugin could be considered incomplete without that feature. Else, please post your ideas to the [support forum](https://groups.google.com/d/forum/jquery-fileupload).
18
efef2ec @blueimp Updated list of supported browsers.
authored
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:**
dc5b688 @blueimp New features for the jQuery File Upload Plugin:
authored
25 Shows a progress bar indicating the upload progress for individual files and for all uploads combined.
efef2ec @blueimp Updated list of supported browsers.
authored
26 * **Cancelable uploads:**
27 Individual file uploads can be canceled to stop the upload progress.
dc5b688 @blueimp New features for the jQuery File Upload Plugin:
authored
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.
68fe2e4 @blueimp Updated features listing and package information.
authored
32 * **Client-side image resizing:**
33 Images can be automatically resized on client-side with browsers supporting the required JS APIs.
dc5b688 @blueimp New features for the jQuery File Upload Plugin:
authored
34 * **Preview images:**
e39278b @blueimp Added automatic image resizing functionality.
authored
35 A preview of image files can be displayed before uploading with browsers supporting the required JS APIs.
efef2ec @blueimp Updated list of supported browsers.
authored
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:**
668886f @blueimp Updated features listing.
authored
41 Allows progressive enhancement by using a standard HTML file upload form as widget element.
efef2ec @blueimp Updated list of supported browsers.
authored
42 * **Cross-site file uploads:**
668886f @blueimp Updated features listing.
authored
43 Supports uploading files to a different domain with cross-site XMLHttpRequests or iframe redirects.
efef2ec @blueimp Updated list of supported browsers.
authored
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:**
68fe2e4 @blueimp Updated features listing and package information.
authored
51 Works with any server-side platform (PHP, Python, Ruby on Rails, Java, Node.js, Go etc.) that supports standard HTML form file uploads.
efef2ec @blueimp Updated list of supported browsers.
authored
52
53 ## Requirements
b0b003c @blueimp Complete rewrite based on jQuery UI Widget, with extensive use of jQu…
authored
54 * [jQuery](http://jquery.com/) v. 1.6+
12ca7c4 @blueimp Replaced Image Processing plugin with a more generic File Processing …
authored
55 * [jQuery UI widget factory](http://wiki.jqueryui.com/w/page/12138135/Widget%20factory) v. 1.8+
1eeced6 @blueimp Replace jQuery Templates with a new JavaScript Templates engine:
authored
56 * [jQuery Iframe Transport plugin](https://github.com/blueimp/jQuery-File-Upload/blob/master/jquery.iframe-transport.js) (included)
12ca7c4 @blueimp Replaced Image Processing plugin with a more generic File Processing …
authored
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.1.6+ (optional)
59 * [JavaScript Canvas to Blob function](https://github.com/blueimp/JavaScript-Canvas-to-Blob) v. 2.0.0+ (optional)
c7023fc @blueimp Updated README.
authored
60 * [Bootstrap CSS Toolkit](https://github.com/twitter/bootstrap/) v. 2.0+ (optional)
47c34fe @blueimp Updated requirements section.
authored
61
fb319d2 @blueimp Update requirements section.
authored
62 The jQuery UI widget factory is a requirement for the basic File Upload plugin, but very lightweight without any other dependencies.
63 The jQuery Iframe Transport is required for [browsers without XHR file upload support](https://github.com/blueimp/jQuery-File-Upload/wiki/Browser-support).
64 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.
1eeced6 @blueimp Replace jQuery Templates with a new JavaScript Templates engine:
authored
65
c7023fc @blueimp Updated README.
authored
66 The User Interface is built with Twitter's [Bootstrap](https://github.com/twitter/bootstrap/) Toolkit. This enables a CSS based, responsive layout and fancy transition effects on modern browsers. The demo also includes the [Bootstrap Image Gallery Plugin](https://github.com/blueimp/Bootstrap-Image-Gallery). Both of these components are optional and not required.
67
fb319d2 @blueimp Update requirements section.
authored
68 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.
1eeced6 @blueimp Replace jQuery Templates with a new JavaScript Templates engine:
authored
69
fb319d2 @blueimp Update requirements section.
authored
70 [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.
efef2ec @blueimp Updated list of supported browsers.
authored
71
ca06ba1 @blueimp Updated README and added support URL.
authored
72 ## Browsers
73 The File Upload plugin is regularly tested with the latest browser versions and supports the following minimal versions:
74
d2eca8e @blueimp Updated browser support section.
authored
75 * Google Chrome - 7.0+
76 * Apple Safari - 4.0+
77 * Mozilla Firefox - 3.0+
78 * Opera - 10.0+
79 * Microsoft Internet Explorer 6.0+
efef2ec @blueimp Updated list of supported browsers.
authored
80
08f482c @blueimp Added Opera 12 to the list of browsers supporting Drag&Drop.
authored
81 Drag & Drop is only supported on Google Chrome, Firefox 4.0+, Safari 5.0+ and Opera 12.0+.
d2eca8e @blueimp Updated browser support section.
authored
82 Microsoft Internet Explorer has no support for multiple file selection or upload progress.
83 [Extended browser support information](https://github.com/blueimp/jQuery-File-Upload/wiki/Browser-support).
efef2ec @blueimp Updated list of supported browsers.
authored
84
85 ## License
ae2a8b8 @blueimp Updated license link and added package information.
authored
86 Released under the [MIT license](http://www.opensource.org/licenses/MIT).
Something went wrong with that request. Please try again.