Shapes

Shapes by DiceBear, licensed under CC0 1.0 .

LICENSE

While our code is MIT licensed, the design of this avatar style is licensed under CC0 1.0. See details for more information.

Open in Playground

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 integer

Minimum 0

Maximum 360

scale

Type integer

Minimum 0

Maximum 200

radius

Type integer

Minimum 0

Maximum 50

size

Type integer

Minimum 1

backgroundColor

Type array

Item 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 integer

Minimum -100

Maximum 100

translateY

Type integer

Minimum -100

Maximum 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.

shape1

Type array

shape1Color

Type array

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

shape1OffsetX

Type array

Max Items 2

Specify an array of two numbers for this option. The PRNG will generate a number between the two values, which will be used as offset.

shape1OffsetY

Type array

Max Items 2

Specify an array of two numbers for this option. The PRNG will generate a number between the two values, which will be used as offset.

shape1Rotation

Type array

Max Items 2

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.

shape2

Type array

shape2Color

Type array

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

shape2OffsetX

Type array

Max Items 2

Specify an array of two numbers for this option. The PRNG will generate a number between the two values, which will be used as offset.

shape2OffsetY

Type array

Max Items 2

Specify an array of two numbers for this option. The PRNG will generate a number between the two values, which will be used as offset.

shape2Rotation

Type array

Max Items 2

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.

shape3

Type array

shape3Color

Type array

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

shape3OffsetX

Type array

Max Items 2

Specify an array of two numbers for this option. The PRNG will generate a number between the two values, which will be used as offset.

shape3OffsetY

Type array

Max Items 2

Specify an array of two numbers for this option. The PRNG will generate a number between the two values, which will be used as offset.

shape3Rotation

Type array

Max Items 2

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.

Details

Naming
Collection Import	import { shapes } from '@dicebear/collection';
Package Import	import * as style from '@dicebear/shapes';
CLI	dicebear shapes
HTTP-API	https://api.dicebear.com/9.x/shapes/svg
JSON Schema	https://api.dicebear.com/9.x/shapes/schema.json

Source
Title	Shapes
Creator	DiceBear
Website	https://www.dicebear.com
License	CC0 1.0
Source	https://www.dicebear.com