@dicebear/avatars-human-sprites

This Sprite Collection combines the Sprite Collections male and female and selects the gender randomly.

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/human/:seed.svg

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

Examples

preview	url
	https://avatars.dicebear.com/v2/human/example.svg
	https://avatars.dicebear.com/v2/human/example.svg?options[mood][]=happy
	https://avatars.dicebear.com/v2/human/example.svg?options[mood][]=sad

NPM

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

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

Now you are ready to create your first Avatar.

import Avatars from '@dicebear/avatars';
import sprites from '@dicebear/avatars-human-sprites';

let options = {};
let avatars = new Avatars(sprites, options);
let svg = avatars.create('custom-seed');

Options

name	type	default	description
radius	number	0	Avatar border radius
base64	bool	false	Return avatar as base64 data uri instead of XML Not supported by the HTTP API
width	number	null	Fixed width
height	number	null	Fixed height
margin	number	0	Avatar margin in percent HTTP-API limitation Max value 25
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.
userAgent	string	window.navigator.userAgent	User-Agent for legacy browser fallback Automatically detected by the HTTP API
mood	array of strings	['happy', 'sad', 'surprised']	Possible values: sad, happy, surprised

Further information

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