/robotavars

Dynically generated robot avatars for your website

Primary LanguageJavaScriptMIT LicenseMIT

Robotavars

Example Robot Avatar

Dynically generated robot avatars for your website

Installation

run yarn add robotavars or npm install --save robotavars

Usage

import { Robotavar } from 'robotavars'

<Robotavar mouth="smile" head="default" antenna="snoo" clothes="Hoodie" fabricColor="Blue02" size={300} />

or

<Robotavar mouth="softSmile" head="longNeck" antenna="bender" clothes="GraphicShirt" fabricColor="White" graphic="Pizza" size={150} />

Functions

To get a list of all head types, import { headTypes } from 'robotavars', which returns an array of strings of all head types.

To get a list of all antenna types, import { antennaTypes } from 'robotavars', which returns an array of strings of all antenna types.

To get a list of all mouth types, import { mouthTypes } from 'robotavars', which returns an array of strings of all mouth types.

Options

Heads

Types: ['default', 'longNeck', 'sharp', 'round', 'knight']

Antenna

Types: ['default', 'snoo', 'shrek', 'bender', 'rabbitEars', 'satellite', 'calculon']

Mouths

Types: ['default', 'softSmile', 'smile', 'concerned']

Size

Provide the desired size of the svg in pixels as a prop. Ex: <Robotavar size={175} ... />

Clothing

All clothing options come from the amazing Avataaars project. Note that values for the following props values must be capitalized, as that is how Avataaars requires them.

To specify the clothing type the robot will wear, pass the 'clothes' prop

Clothing color can be configured with the 'fabricColor' prop

Graphic tee graphics are specified with the 'graphics' prop