A HTML5 upload component without UI
CoffeeScript HTML JavaScript
Clone or download
Fetching latest commit…
Cannot retrieve the latest commit at this time.

README.md

Simple Uploader

Latest Version Build Status Coveralls David David Gitter

A HTML5 upload component which provides full control of UI styles.

Installation

Install via npm:

npm install --save simple-uploader

Install via bower:

bower install --save simple-uploader

Usage

<script type="text/javascript" src="[script path]/jquery.js"></script>
<script type="text/javascript" src="[script path]/simple-module.js"></script>
<script type="text/javascript" src="[script path]/simple-uploader.js"></script>

<input type="file" id="upload-file" />
var uploader = simple.uploader({
  url: '/upload/url'
});

$('#upload-file').on('change', function(e) {
  uploader.upload(this.files);
});

Options

url

String, required, specify the upload API url on server.

params

Hash, specify extra params which will be sent to server with file data.

fileKey

String, specify the name that server will use to get file data.

connectionCount

Number, 3 by default, specify max number of upload connection that can exist simultaneously.

Methods

upload ([File Object]/[File Element]/[File Array])

Use this method to start uploading, accept file object or input:file element or file object arrays as the only param.

cancel ([File Object]/fileId)

Cancel uploading a specific file and remove it from the upload queue.

destroy

Cancel all uploadings and destroy the component instance.

readImageFile ([File Object], callback)

Get base64 data of an image file, which is useful to preview image before uplloading.

Events

beforeupload (e, file)

Triggered before uploading, return false to cancel uploading.

uploadprogress (e, file, loaded, total)

Triggered multiple times during uploading process.

uploadsuccess (e, file, result)

Triggered after uploading complete and response status is 200.

uploaderror (e, file, xhr, status)

Triggered after uploading complete and response status is not 200.

uploadcomplete (e, file, responseText)

Triggered after uploading complete.

uploadcancel (e, file)

Triggered when a uploading is canceled by cancel() method

Development

Clone repository from github:

git clone https://github.com/mycolorway/simple-uploader.git

Install npm dependencies:

npm install

Run default gulp task to build project, which will compile source files, run test and watch file changes for you:

gulp

Now, you are ready to go.

Publish

If you want to publish new version to npm and bower, please make sure all tests have passed before you publish new version, and you need do these preparations:

  • Check the version number in bower.json and package.json.

  • Add new release information in CHANGELOG.md. The format of markdown contents will matter, because build scripts will get version and release content from this file by regular expression. You can follow the format of the older release information.

  • Put your personal API tokens in /.token, which is required by the build scripts to request Github API for creating new release.

  • Commit changes and push.

Now you can run gulp publish task, which will request Github API to create new release.

If everything goes fine, you can see your release at https://github.com/mycolorway/simple-uploader/releases. At the End you can publish new version to npm with the command:

npm publish

Please be careful with the last step, because you cannot delete or republish a release on npm.