@unique-violation/identicon.js v1.0.0

identicon.js

GitHub-style identicons in JS with no server-side processing.

This little library will produce the same shape and (roughly) the same color as GitHub when given the same hash value. Note that GitHub uses an internal database identifier for the hash, so you can't simply md5 the username and get the same result. The hard work is done by Robert Eisele's PNGlib. The creative visual design is borrowed from Jason Long of Git and GitHub fame.

Demo

View Demo

Options

• hash - A unicode string that will be used to generate the image.
• size - The size in pixels of the height and width of the generated (square) image.
• margin - The decimal fraction of the size to use for margin. For example, use 0.10 for a 10% margin.
• background - The background color expressed as an rgba value array to use for the image background. For example, use 255,0,0,255 for red.

Usage

// set options
var hash = "myUnicodeUsername!"; // Any unicode string
var size = 420; // 420px square
var margin = 0.08; // 8% margin (0.08 * 420 = 33.6 so 33.6px margins)
var background = [255, 255, 255, 255]; // rgba white

// base64 encoded PNG
var data = new Identicon(hash, size, margin, background).toString();

// write to a data URI
document.write('<img width=420 height=420 src="data:image/png;base64,' + data + '">');

Requires PNGLib

Copyright 2013, Stewart Lord Released under the BSD license