Skip to content
Javascript library for generating identicons. Running in the browser and on Node.js.
JavaScript HTML TypeScript CSS
Branch: master
Clone or download

Latest commit

Latest commit 67b3585 Jul 13, 2019

Files

Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
bin Added CLI tool. Jul 13, 2019
build Moved module merging logics from gulpfile. Jul 13, 2019
dist Bumped version Jul 13, 2019
src Documentation. Jul 13, 2019
test Moved Node entry point to src folder. Jul 13, 2019
types Documentation. Jul 13, 2019
.gitignore
.travis.yml Added Node 8 and 6.4 to .travis.yml. Jul 24, 2018
LICENSE Update LICENSE Mar 12, 2018
README.md Bumped version Jul 13, 2019
bower.json Updated bower.json. Jul 13, 2019
gulpfile.js Moved module merging logics from gulpfile. Jul 13, 2019
package.json Bumped version Jul 13, 2019

README.md

Jdenticon

JavaScript library for generating highly recognizable identicons using HTML5 canvas or SVG.

Sample identicons

Build Status Downloads npm bundle size License MIT

Live demo

https://jdenticon.com

Getting started

Using Jdenticon is simple. Follow the steps below to integrate Jdenticon into your website.

1. Add identicon placeholders

Jdenticon is able to render both raster and vector identicons. Raster icons are rendered slightly faster than vector icons, but vector icons scale better on high resolution screens. Add a canvas to render a raster icon, or an inline svg element to render a vector icon.

<!-- Vector icon -->
<svg width="80" height="80" data-jdenticon-value="icon value"></svg>

<!-- OR -->

<!-- Raster icon -->
<canvas width="80" height="80" data-jdenticon-value="icon value"></canvas>

2. Add reference to Jdenticon

Include the Jdenticon library somewhere on your page. You can either host it yourself or use it right off jsDelivr.

<!-- Using jsDelivr -->
<script type="text/javascript" src="https://cdn.jsdelivr.net/npm/jdenticon@2.2.0"></script>

<!-- OR -->

<!-- Hosting it yourself -->
<script type="text/javascript" src="-path-to-/jdenticon.min.js"></script>

That's it!

Other resources

API documentation

For more usage examples and API documentation, please see:

https://jdenticon.com

Other platforms

There are ports or bindings for Jdenticon available for the following platforms:

Hosted Jdenticon

Same icons but generated server-side. Service provided by Aaroh Mankad.

http://identicon-api.herokuapp.com/

License

Jdenticon is available under the MIT license.

You can’t perform that action at this time.