angular-ui/ui-uploader

Name: ui-uploader

Owner: AngularUI

Description: Customizable file uploader

Created: 2015-05-29 00:24:09.0

Updated: 2018-05-16 11:45:16.0

Pushed: 2017-08-29 11:47:34.0

Homepage: https://rawgit.com/angular-ui/ui-uploader/master/demo/index.html

Size: 6037

Language: JavaScript

GitHub Committers

UserMost Recent Commit# Commits

Other Committers

UserEmailMost Recent Commit# Commits

README

ui-uploader Build Status npm version Bower version Join the chat at https://gitter.im/angular-ui/ui-uploader

ui-uploader is a single/multiple and high customizable file uploader and the most important is very easy to implement.

You can use with html5, jquery or every library or framework:

The main objective of ui-uploader is to have a user control, clean, simple, customizable, and above all very easy to implement.

Try the demo.

Compatibility

Because this project uses FormData, it does not work on IE9 or earlier.

Requirements
Usage

You can get it from Bower

r install angular-ui-uploader

Load the script files in your application:

ipt type="text/javascript" src="bower_components/angular/angular.js"></script>
ipt type="text/javascript" src="bower_components/angular-ui-uploader/dist/uploader.js"></script>

Add the specific module to your dependencies:

lar.module('myApp', ['ui.uploader', ...])

Now you can use the ui-uploader methods.

ploader.addFiles(files);
ploader.remove(file);
ploader.removeAll();

Configure ui-uploader callbacks and start!

ploader.startUpload({
            url: 'http://my_domain.com',
            concurrency: 2,
            onProgress: function(file) {
                // file contains a File object
                console.log(file);
            },
            onUploadSuccess: function(file) {
                // file contains a File object
                console.log(file);
            },
            onCompleted: function(file, responseText, status) {
                // file contains a File object
                console.log(file);
                // responseText contains the server response as text
                console.log(responseText);
                // status contains the status of the response
                console.log(status);
            },
            onCompletedAll: function(files) {
                // files is an array of File objects
                console.log(files);
            }
        });

Perform CORS AJAX requests by setting the options.withCredentials flag to true!

ploader.startUpload({
            url: 'http://my_domain.com/path/to/api-endpoint',
            options: {
                withCredentials: true
            },
            onProgress: function(file) {
                // do stuff
            },
            onUploadSuccess: function(file) {
                // do stuff
            },
            onCompleted: function(file, responseText, status) {
                // do stuff
            },
            onCompletedAll: function(files) {
                // do stuff
            }
        });

Configure custom request headers by options.headers field

ploader.startUpload({
            url: 'http://my_domain.com',
            concurrency: 2,
            headers: {
                'Accept': 'application/json'
            },
            onCompletedAll: function(files) {
                // files is an array of File objects
                console.log(files);
            }
        });
Development

We use Karma and jshint to ensure the quality of the code. The easiest way to run these checks is to use grunt:

install -g gulp-cli
install && bower install

The karma task will try to open Firefox and Chrome as browser in which to run the tests. Make sure this is available or change the configuration in karma.conf.js

Gulp watch

gulp watch will automatically test your code and build a release whenever source files change.

How to release

Use gulp to bump version, build and create a tag. Then push to GitHub:

 release [--patch|--minor|--major]
push --tags origin master # push everything to GitHub

Travis will take care of testing and publishing to npm's registry (bower will pick up the change automatically). Finally create a release on GitHub from the tag created by Travis.


This work is supported by the National Institutes of Health's National Center for Advancing Translational Sciences, Grant Number U24TR002306. This work is solely the responsibility of the creators and does not necessarily represent the official views of the National Institutes of Health.