Skip to content

Latest commit

 

History

History
executable file
·
123 lines (97 loc) · 6.75 KB

readme.md

File metadata and controls

executable file
·
123 lines (97 loc) · 6.75 KB
Raw

Uploader

###this is the last fine uploader version under MIT license, if you don't mind using a GPL licensed version, you can checkout the current Widen/fine-uploader version

Authors

Actively developed by Ray Nicholus.
Created by Andrew Valums.

Features

  • Multiple file select, progress-bar in FF, Chrome, and Safari
  • Drag-and-drop file select in FF, Chrome, and Safari (OS X)
  • Uploads are cancelable
  • No external dependencies at all if using FineUploader or FineUploaderBasic. If using the optional jQuery wrapper, jQuery is of course required.
  • FineUploaderBasic only requires the associated Fine Uploader javascript file. All Fine Uploader css and image files can be omitted.
  • Doesn't use Flash
  • Fully working with HTTPS
  • Tested in IE7+, Firefox, Safari (OS X), Chrome, IOS6, and various versions of Android. IE10 is now also supported!
  • Ability to upload files as soon as they are selected, or "queue" them for uploading at user's request later
  • Display specific error messages from server on upload failure (hover over failed upload item)
  • Ability to auto-retry failed uploads
  • Option to allow users to manually retry a failed upload
  • Create your own file validator and/or use some default validators include with Fine Uploader
  • Receive callback at various stages of the upload process
  • Send any parameters server-side along with each file.
  • Upload directories via drag and drop (Chrome 21+).
  • Include parameters in the query string OR the request body.
  • Submit files to be uploaded via the API.
  • Split up a file into multiple requests (file chunking/partitioning).
  • Resume failed/stopped uploads from previous sessions
  • Delete uploaded files
  • CORS support
  • Upload any Blob objects via the API.
  • Any many more!

Introduction

This project attempts to achieve a user-friendly file-uploading experience over the web. It's built as a Javascript plugin for developers looking to incorporate file-uploading into their website.

This plugin uses an XMLHttpRequest (AJAX) for uploading multiple files with a progress-bar in FF3.6+, Safari4+, Chrome and falls back to hidden-iframe-based upload in other browsers (namely IE), providing good user experience everywhere.

It does not use Flash, jQuery, or any other external libraries. There is an optional jQuery plug-in that can be used to integrate Fine Uploader into your project, but it is NOT required. The same features are available with or without the jQuery plug-in.

Fine Uploader Has Two Modes...

You can use Fine Uploader in FineUploader mode, or in FineUploaderBasic mode.

FineUploaderBasic mode

FineUploaderBasic mode is defined in the qq.FineUploaderBasic module in the code. This is the base module for Fine Uploader, and provides all functions that do not involve UI components. Choose this mode if you need very tight control over your uploader's UI. If you choose this option, it is expected that you will provide all of your own UI, but Fine Uploader will do the rest.

FineUploader mode

FineUploader mode is defined in the qq.FineUploader module in the code. It inherits everything from FineUploaderBasic, plus it provides a customizable UI, including drag & drop, progress bars, status messages, a file list with color-coded status indicators, and other UI niceties. Most developers will likely opt to use FineUploader.

jQuery plug-in

Fine Uploader also provides an optional jQuery plug-in. This simply wraps the native uploader code. You can use either of the modes described above when using the jQuery plug-in via the uploaderType option. More on the plug-in in the jQuery plug-in section.

Choose Your Path...

Once you have decided how you will use Fine Uploader, click on the appropriate link below to get started.

jQuery plug-in for FineUploader mode users

Start here.

jQuery plug-in for FineUploaderBasic mode users

Your journey begins here.

FineUploader mode users

Look no further, your plan of action is described here.

FineUploaderBasic mode users

I didn't forget about you! Read on, starting here.

Important Fine Uploader Links

Troubleshooting

If you can't get the uploader to work, please try the following steps before asking for help.

If the upload doesn't complete, saying "failed":

  • Set the debug option of the FineUploader to true.
  • Open the page where you have a FineUploader.
  • Open developer console in your browser.
  • Try to upload the file. You should see a server response.

It should be {"success":true} for completed requests. If it's not, then you have a problem with your server-side script.

If you are having other issues, please read the FAQ section before posting a question or bug.

Issue Tracker

Have a bug or feature request? Please create an issue here on GitHub that conforms with necolas's guidelines.

License

This plugin is open sourced under MIT license.

Contributors

We would love developers to contribute any improvements and bugfixes they produce. Note that any pull requests MUST be against an "IP" branch! See How do I contribute to other's code in GitHub?.

Thanks to everybody who contributed, either by sending bug reports or donating. The project wouldn't be possible without all this generous help. Thank you!

Additional Reading