SVG+JS Identicons designed to run in browsers and NodeJS. The library is heavily optimized for performance.
See the Identicons in action here.
Nimiq Identicons can be used in both browsers and NodeJS:
You can either use the Identicons script already bundled with the image data (default), or with an external SVG file which is loaded separately.
The Identicons script is provided as an ES6 module and needs to be imported
into module scripts or used with build systems such as Webpack and Rollup:
npm install --save @nimiq/identiconsoryarn add @nimiq/identiconsimport Identicons from '@nimiq/identicons'- See how to use it under Usage
To use the other version of the library, which loads the image data separately,
you have to import Identicons from '@nimiq/identicons/dist/identicons.min.js' instead.
Additionally you have to make sure that the identicons.min.svg file included in the
dist directory of this package is made available to website visitors.
Then specify the path where the library can find this SVG file, either by setting
Identicons.svgPath = '/public/path/to/identicons.min.svg' or in the global scope with
window.NIMIQ_IDENTICONS_SVG_PATH = '/public/path/to/identicons.min.svg'.
Note: Besides installing the package yourself, you can also use
a npm-enabled CDN:
import Identicons from https://unpkg.com/@nimiq/identicons@1.4/dist/identicons.bundle.min.js.
For NodeJS a CommonJS module is provided, which can simply be installed and used by doing:
npm install --save @nimiq/identiconsoryarn add @nimiq/identiconsconst Identicons = require('@nimiq/identicons').default(the.defaultis important!)- See how to use it under Usage
If you are using a version of NodeJS with
importenabled, or are using an ES6 loader such asesmorbabel-register, you can just doimport Identicons from '@nimiq/identicons'for step 2.
All methods generating identicons are async and return promises.
Get a raw SVG text string:
const svg = await Identicons.svg(text)Get a SVG data url string (the one starting with data:image/svg+xml;base64,...),
which can be set as img.src:
const dataUrl = await Identicons.toDataUrl(text)Render an identicon SVG into the DOM (only in browsers!):
await Identicons.render(text, element)Get an <img> DOM node (only in browsers!):
const img = await Identicons.image(text)You can generate a placeholder icon with these (sync) methods:
// Placeholder SVG:
const svg = Identicons.placeholder(color = '#bbb', strokeWidth = 1)
// Placeholder data url:
const dataUrl = Identicons.placeholderToDataUrl(color = '#bbb', strokeWidth = 1)
// Render placeholder SVG into `element`:
Identicons.renderPlaceholder(element, color = '#bbb', strokeWidth = 1)For more information on our design decisions read our design blog post or watch the Vlog about the beginning of the Identicons.
This is an open source contribution by Nimiq - the browser-based blockchain.
