@dicebear/avatars-jdenticon-sprites

1.0.3 • Public • Published 10 days ago

license

Jdenticon wrapper for DiceBear Avatars.

Usage

HTTP-API (recommended)

Our free HTTP-API is the easiest way to use this sprite collection. Just use the following URL as image source.

https://avatars.dicebear.com/v2/jdenticon/:seed.svg

The value of :seed can be anything you like - but don't use any sensitive or personal data here! The GET parameter option can be used to pass options.

Examples

preview	url
	https://avatars.dicebear.com/v2/jdenticon/example.svg
	https://avatars.dicebear.com/v2/jdenticon/example.svg?options[padding]=0.05&options[background]=%23f0f0f0

NPM

Install the Avatars and this sprite collection with the following command.

npm install --save @dicebear/avatars @dicebear/avatars-jdenticon-sprites jdenticon

Now you are ready to create your first Avatar.

import Avatars from '@dicebear/avatars';
import sprites from '@dicebear/avatars-jdenticon-sprites';
 
let options = {};
let avatars = new Avatars(sprites(options));
let svg = avatars.create('custom-seed');

Options

name	type	default	description
hues	array of numbers between 0 and 360	`null`	Icon hue
padding	number	`0`	Distance to the edge of the image HTTP-API limitation Maximum value: `0.2`
colorLightness	array of two numbers between 0 and 100	`null`	Colored shapes - Lightness
grayscaleLightness	array of two numbers between 0 and 100	`null`	Grayscale shapes - Lightness
colorSaturation	number between 0 and 100	`null`	Colored shapes - Saturation
grayscaleSaturation	number between 0 and 100	`null`	Grayscale shapes - Saturation
background	string	`null`	Any valid color identifier HTTP-API limitation Only hex (3-digit, 6-digit and 8-digit) values are allowed. Use url encoded hash: `%23`.

Further information

You can find the DiceBear Avatars documentation at avatars.dicebear.com

Keywords

install

npm i @dicebear/avatars-jdenticon-sprites

weekly downloads

version

1.0.3

license

MIT

homepage

github.com

repository

github

last publish

10 days ago

collaborators

Test with RunKit

Report a vulnerability