Skip to content
On this page
Sponsor

Avataaars

This implementation is a remix of Avataaars by Pablo Stanley. Licensed under Free for personal and commercial use.

LICENSE

While our code is MIT licensed, the design is licensed under Free for personal and commercial use. See details for more information.

Usage

Options

seed

Type string

The seed determines the initial value for the built-in PRNG. With the PRNG you can create the same avatar over and over again based.

flip

Type boolean

rotate

Type integerMinimum 0Maximum 360

scale

Type integerMinimum 0Maximum 200

radius

Type integerMinimum 0Maximum 50

size

Type integerMinimum 1

backgroundColor

Type arrayItem Pattern ^(transparent|[a-fA-F0-9]{6})$

backgroundType

Type array

backgroundRotation

Type array

Specify an array of two numbers for this option. The PRNG will generate a number between the two values, which will be used as the rotation degree. The rotation is only visible if backgroundType is set to ['gradientLinear'].

translateX

Type integerMinimum -100Maximum 100

translateY

Type integerMinimum -100Maximum 100

clip

Type boolean

randomizeIds

Type boolean

This option randomize the IDs in the generated SVG / XML. This can be useful for example if the avatars are included directly in the HTML and you want to avoid ID collisions.

accessories

Type array

accessoriesColor

Type arrayItem Pattern ^(transparent|[a-fA-F0-9]{6})$

accessoriesProbability

Type integerMinimum 0Maximum 100

clothesColor

Type arrayItem Pattern ^(transparent|[a-fA-F0-9]{6})$

clothing

Type array

clothingGraphic

Type array

eyebrows

Type array

eyes

Type array

facialHair

Type array

facialHairColor

Type arrayItem Pattern ^(transparent|[a-fA-F0-9]{6})$

facialHairProbability

Type integerMinimum 0Maximum 100

hairColor

Type arrayItem Pattern ^(transparent|[a-fA-F0-9]{6})$

hatColor

Type arrayItem Pattern ^(transparent|[a-fA-F0-9]{6})$

mouth

Type array

nose

Type array

skinColor

Type arrayItem Pattern ^(transparent|[a-fA-F0-9]{6})$

style

Type array

top

Type array

topProbability

Type integerMinimum 0Maximum 100

Details

Naming
Collection Import
import { avataaars } from '@dicebear/collection';
Package Import
import * as style from '@dicebear/avataaars';
CLI
dicebear avataaars
HTTP-APIhttps://api.dicebear.com/5.x/avataaars/svg
Source
TitleAvataaars
CreatorPablo Stanley
Websitehttps://twitter.com/pablostanley
LicenseFree for personal and commercial use
Sourcehttps://avataaars.com/