Initials

Usage

HTTP-API (recommended)

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

https://avatars.dicebear.com/api/initials/:seed.svg

See the HTTP API documentation for more information.

Examples

preview	url
	https://avatars.dicebear.com/api/initials/John%20Doe.svg
	https://avatars.dicebear.com/api/initials/John%20Doe.svg?fontSize=80
	https://avatars.dicebear.com/api/initials/John%20Doe.svg?backgroundColorLevel=900

NPM

Install the Avatars and this avatar style with the following command.

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

Now you are ready to create your first Avatar.

import Avatars from '@dicebear/avatars';

import sprites from '@dicebear/avatars-initials-sprites';

let options = {};

let avatars = new Avatars(sprites, options);

let svg = avatars.create('custom-seed');

Options

name	alias	type	default	description
radius	r	number	0	Avatar border radius
dataUri		bool	false	Return avatar as data uri instead of XML Not supported by the HTTP API
width	w	number	null	Fixed width
height	h	number	null	Fixed height
margin	m	number	0	Avatar margin in percent HTTP-API limitation Max value 25
background	b	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.
backgroundColors		array of strings	null	Possible values: amber, blue, blueGrey, brown, cyan, deepOrange, deepPurple, green, grey, indigo, lightBlue, lightGreen, lime, orange, pink, purple, red, teal, yellow
backgroundColorLevel		number	600	Possible values: 50, 100, 200, 300, 400, 500, 600, 700, 800, 900
fontSize		number	50	Number between 1 and 100
chars		number	2	Number between 0 and 2
bold		bool	false