@ayetu/ayetu-avatar v2.2.0

Usage

Install the DiceBear package and this avatar style with the following command:

npm install @dicebear/core @ayetu/ayetu-avatar --save

Now you can create your first avatar.

import { createAvatar } from '@dicebear/core';
import * as style from '@ayetu/ayetu-avatar';

let svg = createAvatar(style, {
    seed: accountName,
    backgroundType: ['gradientLinear', 'solid'],
    // other options
});

Options

All options from DiceBear and additionally the following:

backgroundType

It is a default attribute from DiceBear and should be included if you want to include color to the avatars type: array options: ['gradientLinear', 'solid']

backgroundColor

type: array default: ['f1a12a', 'e8da16', 'f0c146', '4369e8', '98d4eb', '423fec', '42d3f3', 'e72ac7', 'edb7c0', 'c9388f', '79cd6c', '32a985', 'afe39c', 'd9644a', 'a78ddd', '8448e5']

eyes

type: array allowed: horns, eyebrows6, eyebrows5, eyebrows4, round, sad, relaxed, dizzy, winkWavy, surprise, dead1, babySad, coldSweat, wink, questioning, dots, squinty, happy, eyepatch, alien, redLaser2, glassesShade2, glassesXl, underwater, winter, sportGlasses, glassesShadeRect, squinting, kOYN, pinkGlasses2, pinkGlasses, euro, dollarSign, anim1, btc1, happy1, redLaser, baby, btc2, bigEyes, eyebrows1, eyebrows2, eyebrows3, dead2, triangle, three3, three4, three5, smallerCartoon, three1, threeGlasses2, three2, blind, happyNoBrows, small, angry, stars, closed, largePupils default: ['horns', 'eyebrows6', 'eyebrows5', 'eyebrows4', 'round', 'sad', 'relaxed', 'dizzy', 'winkWavy', 'surprise', 'dead1', 'babySad', 'coldSweat', 'wink', 'questioning', 'dots', 'squinty', 'happy', 'eyepatch', 'alien', 'redLaser2', 'glassesShade2', 'glassesXl', 'underwater', 'winter', 'sportGlasses', 'glassesShadeRect', 'squinting', 'kOYN', 'pinkGlasses2', 'pinkGlasses', 'euro', 'dollarSign', 'anim1', 'btc1', 'happy1', 'redLaser', 'baby', 'btc2', 'bigEyes', 'eyebrows1', 'eyebrows2', 'eyebrows3', 'dead2', 'triangle', 'three3', 'three4', 'three5', 'smallerCartoon', 'three1', 'threeGlasses2', 'three2', 'blind', 'happyNoBrows', 'small', 'angry', 'stars', 'closed', 'largePupils']

misc

type: array allowed: freckles1, bindi, halo, bandage, freckles2, freckles3, freckles4, mustache1, mustache2 default: ['freckles1', 'bindi', 'halo', 'bandage', 'freckles2', 'freckles3', 'freckles4', 'mustache1', 'mustache2']

misc2

type: array allowed: frame2, frame1, borderKenya, borderNigeria, borderSouthafrica default: ['frame2', 'frame1', 'borderKenya', 'borderNigeria', 'borderSouthafrica']

misc2Probability

type: integer minimum: 0 maximum: 100 default: 15

miscProbability

type: integer minimum: 0 maximum: 100 default: 15

mouth

type: array allowed: fangs, tongueUp, sad1, zipper, wavy2, wavy, pursed, teeth, bigO, smallO, wideSmile2, wideSmile, tongue4, largeChin, oval, smileLg, meh2, confounded, happy, sad2, yen, pound, mildySad, tongue1, toxicMask, meh, tongue2, smile1, blush1, subtleSmile, clown, smallSmile, angry, down, mask, mask2 default: ['fangs', 'tongueUp', 'sad1', 'zipper', 'wavy2', 'wavy', 'pursed', 'teeth', 'bigO', 'smallO', 'wideSmile2', 'wideSmile', 'tongue4', 'largeChin', 'oval', 'smileLg', 'meh2', 'confounded', 'happy', 'sad2', 'yen', 'pound', 'mildySad', 'tongue1', 'toxicMask', 'meh', 'tongue2', 'smile1', 'blush1', 'subtleSmile', 'clown', 'smallSmile', 'angry', 'down', 'mask', 'mask2']

Build this package

npm run build

Test this package

npm run test