Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
@nimiq/identicons
Advanced tools
Readme
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 import
ed
into module scripts or used with build systems such as Webpack and Rollup:
npm install --save @nimiq/identicons
or yarn add @nimiq/identicons
import Identicons from '@nimiq/identicons'
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/identicons
or yarn add @nimiq/identicons
const Identicons = require('@nimiq/identicons').default
(the .default
is important!)If you are using a version of NodeJS with
import
enabled, or are using an ES6 loader such asesm
orbabel-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.
FAQs
Nimiq Identicons
The npm package @nimiq/identicons receives a total of 159 weekly downloads. As such, @nimiq/identicons popularity was classified as not popular.
We found that @nimiq/identicons demonstrated a not healthy version release cadence and project activity because the last version was released a year ago. It has 8 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.