Skip to main content

Miniavs

Sean Moore Lionel Quinn Lydia Ellis Bryan Phelps Ronald Frank Annette Klein Brent Hill Stanley Newman Grace Singleton

Implementation of Miniavs - Free Avatar Creator by Webpixels. Licensed under CC BY 4.0.

note

While our code is MIT licensed, the design is licensed under CC BY 4.0. See license overview for more information.

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

See the HTTP API documentation for more information.

NPM#

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

npm install --save @dicebear/avatars @dicebear/miniavs

Now you are ready to create your first Avatar.

import { createAvatar } from '@dicebear/avatars';
import * as style from '@dicebear/miniavs';
let svg = createAvatar(style, {
seed: 'custom-seed',
// ... and other options
});

Options#

Base options#

seed

Seed

Alias: s

Default: undefined

Type: string

dataUri

Data URI

Default: false

Type: boolean

flip

Flip

Default: false

Type: boolean

rotate

Rotate

Default: 0

Type: integer

Minimum: 0

Maximum: 360

scale

Scale

Default: 100

Type: integer

Minimum: 0

Maximum: 200

radius

Radius

Alias: r

Default: 0

Type: integer

Minimum: 0

Maximum: 50

size

Size

Default: undefined

Type: integer

Minimum: 1

backgroundColor

Background Color

Alias: b

Default: undefined

Type:

translateX

Translate X%

Default: 0

Type: integer

Minimum: -100

Maximum: 100

translateY

Translate Y%

Default: 0

Type: integer

Minimum: -100

Maximum: 100

Style options#

head

Head

Default: normal, wide, thin

Type: array

Items:

Type: string

Enum: normal, wide, thin

body

Body

Default: tShirt, golf

Type: array

Items:

Type: string

Enum: tShirt, golf

hair

Hair

Default: balndess, slaughter, ponyTail, long, curly, stylish, elvis, classic02, classic01

Type: array

Items:

Type: string

Enum: balndess, slaughter, ponyTail, long, curly, stylish, elvis, classic02, classic01

mouth

Mouth

Default: default, missingTooth

Type: array

Items:

Type: string

Enum: default, missingTooth

eyes

Eyes

Default: normal, confident, happy

Type: array

Items:

Type: string

Enum: normal, confident, happy

glasses

Glasses

Default: normal

Type: array

Items:

Type: string

Enum: normal

glassesProbability

Glasses Probability

Default: 20

Type: integer

Minimum: 0

Maximum: 100

mustache

Mustache

Default: pencilThinBeard, pencilThin, horshoe, freddy

Type: array

Items:

Type: string

Enum: pencilThinBeard, pencilThin, horshoe, freddy

mustacheProbability

Mustache Probability

Default: 20

Type: integer

Minimum: 0

Maximum: 100

blushes

Blushes

Default: default

Type: array

Items:

Type: string

Enum: default

blushesProbability

Blushes Probability

Default: 50

Type: integer

Minimum: 0

Maximum: 100

skinColor

Skin Color

Default: yellow, white, dark

Type: array

Items:

Type: string

Enum: yellow, white, dark

or

Type: string

Pattern: ^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$

hairColor

Hair Color

Default: brown, black, red

Type: array

Items:

Type: string

Enum: brown, black, red

or

Type: string

Pattern: ^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$

bodyColor

Body Color

Default: orange, blue, pink

Type: array

Items:

Type: string

Enum: orange, blue, pink

or

Type: string

Pattern: ^#([a-fA-F0-9]{3}|[a-fA-F0-9]{4}|[a-fA-F0-9]{6}|[a-fA-F0-9]{8})$