Skip to content

nkoepke/Identicon

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

13 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Identicon

Identicon

JavaScript variant of GitHub Identicons

GitHub latest commit made-with-javascript

Identicon class

class Identicon (options [optional] object)

Options (Constructor)

  • color string [optional]

  • backgroundColor string [optional]

  • seed string [optional] (String of any length to set a specific color for color. For example the seed "Test" will always set the color to green.)

You don't have to set the colors in the constructor. You can always change them by setting the attributes after the initialization of the object.

Attributes

  • grid

    • Internal representation of the icon as a two dimensional array.
  • color

    • Color of the icon as a css color. Default green.
  • backgroundColor

    • Color of the icon as a css color. Default transparent.

Methods

  • render()

    • Icon as SVG string.
  • randomize()

    • Sets new random pattern to grid. Returns the render() Method.

Example

const Identicon = require('./src/identicon.js');
let image = new Identicon({color: "purple", backgroundColor: "white"});
console.log(image.render());

For web browser usage, use as commonJS module or remove module.exports = Identicon; from the JS file and use it like a regular class. Then use

let image = new Identicon();
console.log(image.render());

// Set new color and new random image
image.color = "#e61c1c";
icon.randomize();
console.log(image.render());