Skip to main content

Big Smile

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

Implementation of Custom Avatar by Ashley Seo. 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/big-smile/: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/big-smile

Now you are ready to create your first Avatar.

import { createAvatar } from '@dicebear/avatars';
import * as style from '@dicebear/big-smile';
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#

face

Face

Default: base

Type: array

Items:

Type: string

Enum: base

mouth

Mouth

Default: openedSmile, unimpressed, gapSmile, openSad, teethSmile, awkwardSmile, braces, kawaii

Type: array

Items:

Type: string

Enum: openedSmile, unimpressed, gapSmile, openSad, teethSmile, awkwardSmile, braces, kawaii

eyes

Eyes

Default: cheery, normal, confused, starstruck, winking, sleepy, sad, angry

Type: array

Items:

Type: string

Enum: cheery, normal, confused, starstruck, winking, sleepy, sad, angry

hair

Hair

Default: shortHair, mohawk, wavyBob, bowlCutHair, curlyBob, straightHair, braids, shavedHead, bunHair, froBun, bangs, halfShavedHead, curlyShortHair

Type: array

Items:

Type: string

Enum: shortHair, mohawk, wavyBob, bowlCutHair, curlyBob, straightHair, braids, shavedHead, bunHair, froBun, bangs, halfShavedHead, curlyShortHair

accessories

Accessories

Default: catEars, glasses, sailormoonCrown, clownNose, sleepMask, sunglasses, faceMask, mustache

Type: array

Items:

Type: string

Enum: catEars, glasses, sailormoonCrown, clownNose, sleepMask, sunglasses, faceMask, mustache

accessoriesProbability

Accessories Probability

Default: 50

Type: integer

Minimum: 0

Maximum: 100

skinColor

Skin Color

Default: variant01, variant02, variant03, variant04, variant05, variant06, variant07, variant08

Type: array

Items:

Type: string

Enum: variant01, variant02, variant03, variant04, variant05, variant06, variant07, variant08

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: variant01, variant02, variant03, variant04, variant05, variant06, variant07, variant08

Type: array

Items:

Type: string

Enum: variant01, variant02, variant03, variant04, variant05, variant06, variant07, variant08

or

Type: string

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