Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Javascript Picker for Avatars.io API
JavaScript
branch: master
Failed to load latest commit information.
dist updated library
lib updated library
src updated library
test updated library
vendor removed jQuery as a dependency
.gitignore added gitignore
Gruntfile.js updated library
Readme.md updated library
grunt.js update
package.json updated library

Readme.md

Avatars.io uploader for browsers

Use this library to upload images to avatars.io and get URLs to them. No server-side configuration required.

Getting Started

First, go to avatars.io and obtain your public authorization token for use on client side.

Include avatars.io.min.js in your web page(2.6kb) and configure it:

<script src="avatars.io.min.js"></script>
<script>
var client = new AvatarsIO('Your public token'); // obtain at http://avatars.io/

$(function(){
    var uploader = client.create('#avatar'); // selector for input[type="file"] field, here #avatar, for example
    uploader.setAllowedExtensions(['png', 'jpg']); // optional, defaults to png, gif, jpg, jpeg
    uploader.on('complete', function(url){
        alert(url); // for example, http://avatars.io/ua3aS5a
    });
});
</script>

Next, set up file field with #avatar id (for example):

<div> <!-- surround it with some container element -->
    <input type="file" id="avatar">
</div>

Events

Library emits such events as: init, start, complete. You can add listeners to these using on method:

uploader.on('init', function(){
    // instance of uploader initialized
});

uploader.on('start', function(){
    // fires when new avatar starts uploading
});

uploader.on('complete', function(url){
    // fires when avatar finished uploading
});

License

© Chute Corporation.

Something went wrong with that request. Please try again.