animal-avatar-generator-module
v1.0.6
Published
Animal avatar generator
Downloads
3
Maintainers
Readme
Generate SVG avatars on client side from a string seed. As long as the same version of the library is used it always returns the same avatar for the corresponding seed.
Live example
Using npm:
$ npm install animal-avatar-generator --save
or using yarn:
$ yarn add animal-avatar-generator
import avatar from 'animal-avatar-generator'
const svg = avatar('your custom seed', { size: 200 })
document.getElementById('avatar').innerHTML = svg
|Name|Type|Description|Default|
|---|---|---|---|
|size
|number
|Avatar size in pixels|150
|
|round
|boolean
|Use round or rectangle shape|true
|
|blackout
|boolean
|Use blackout for right side of an avatar|true
|
|avatarColors
|string[]
|Palette for avatar colors|['#d7b89c', '#b18272','#ec8a90','#a1Ac88','#99c9bd','#50c8c6']
|
|backgroundColors
|string[]
|Palette for background colors|['#fcf7d1', '#ece2e1','#e4e3cd','#c4ddd6','#b5f4bc']
|
Missing a configuration? Raise an issue.