Skip to main content

Micah

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

Implementation of Avatar Illustration System by Micah Lanier. 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/micah/: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/micah

Now you are ready to create your first Avatar.

import { createAvatar } from `@dicebear/avatars`;
import * as style from `@dicebear/micah`;
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

radius

Radius

Alias: r

Default: 0

Type: integer

Minimum: 0

Maximum: 50

width

Width

Alias: w

Default: undefined

Type: integer

Minimum: 1

height

Height

Alias: h

Default: undefined

Type: integer

Minimum: 1

margin

Margin

Alias: m

Default: 0

Type: integer

Minimum: 0

Maximum: 25

backgroundColor

Background Color

Alias: b

Default: transparent

Type: string

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

or

Type: string

Enum: transparent

Style options#

base

Base

Default: standard

Type: array

Items:

Type: string

Enum: standard

baseColor

Base Color

Default: apricot, coast, topaz

Type: array

Items:

Type: string

Enum: apricot, coast, topaz, lavender, sky, salmon, canary, calm, azure, seashell, mellow, black, white

or

Type: string

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

earrings

Earrings

Default: hoop, stud

Type: array

Items:

Type: string

Enum: hoop, stud

earringColor

Earring Color

Default: apricot, coast, topaz, lavender, sky, salmon, canary, calm, azure, seashell, mellow, black, white

Type: array

Items:

Type: string

Enum: apricot, coast, topaz, lavender, sky, salmon, canary, calm, azure, seashell, mellow, black, white

or

Type: string

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

earringsProbability

Earrings Probability

Default: 30

Type: integer

Minimum: 0

Maximum: 100

eyebrows

Eyebrows

Default: down, eyelashesDown, eyelashesUp, up

Type: array

Items:

Type: string

Enum: down, eyelashesDown, eyelashesUp, up

eyebrowColor

Eyebrow Color

Default: black

Type: array

Items:

Type: string

Enum: apricot, coast, topaz, lavender, sky, salmon, canary, calm, azure, seashell, mellow, black, white

or

Type: string

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

ears

Ears

Default: attached

Type: array

Items:

Type: string

Enum: attached

eyes

Eyes

Default: eyes, eyesShadow, round, smiling

Type: array

Items:

Type: string

Enum: eyes, eyesShadow, round, smiling

eyeColor

Eye Color

Default: calm, azure, seashell, mellow, white

Type: array

Items:

Type: string

Enum: apricot, coast, topaz, lavender, sky, salmon, canary, calm, azure, seashell, mellow, black, white

or

Type: string

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

facialHair

Facial Hair

Default: beard, scruff

Type: array

Items:

Type: string

Enum: beard, scruff

facialHairColor

Facial Hair Color

Default: topaz

Type: array

Items:

Type: string

Enum: apricot, coast, topaz, lavender, sky, salmon, canary, calm, azure, seashell, mellow, black, white

or

Type: string

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

facialHairProbability

Facial Hair Probability

Default: 10

Type: integer

Minimum: 0

Maximum: 100

glasses

Glasses

Default: round, square

Type: array

Items:

Type: string

Enum: round, square

glassesColor

Glasses Color

Default: apricot, coast, topaz, lavender, sky, salmon, canary, calm, azure, seashell, mellow, black, white

Type: array

Items:

Type: string

Enum: apricot, coast, topaz, lavender, sky, salmon, canary, calm, azure, seashell, mellow, black, white

or

Type: string

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

glassesProbability

Glasses Probability

Default: 30

Type: integer

Minimum: 0

Maximum: 100

mouth

Mouth

Default: frown, laughing, nervous, pucker, sad, smile, smirk, surprised

Type: array

Items:

Type: string

Enum: frown, laughing, nervous, pucker, sad, smile, smirk, surprised

nose

Nose

Default: curve, pointed, round

Type: array

Items:

Type: string

Enum: curve, pointed, round

shirt

Shirt

Default: collared, crew, open

Type: array

Items:

Type: string

Enum: collared, crew, open

shirtColor

Shirt Color

Default: apricot, coast, topaz, lavender, sky, salmon, canary, calm, azure, seashell, mellow, black, white

Type: array

Items:

Type: string

Enum: apricot, coast, topaz, lavender, sky, salmon, canary, calm, azure, seashell, mellow, black, white

or

Type: string

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

hair

Hair

Default: dannyPhantom, dougFunny, fonze, full, mrClean, mrT, pixie, turban

Type: array

Items:

Type: string

Enum: dannyPhantom, dougFunny, fonze, full, mrClean, mrT, pixie, turban

hairColor

Hair Color

Default: apricot, coast, topaz, lavender, sky, salmon, canary, calm, azure, seashell, mellow, black, white

Type: array

Items:

Type: string

Enum: apricot, coast, topaz, lavender, sky, salmon, canary, calm, azure, seashell, mellow, black, white

or

Type: string

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

hairProbability

Hair Probability

Default: 100

Type: integer

Minimum: 0

Maximum: 100