1.1.1 • Published 10 months ago
moodie v1.1.1
Moodie Avatars
Moodie is a delightful, lightweight JavaScript library for React that generates SVG-based, expressive avatars from any username and color palette. Inspired by the amazing boring-avatars project, Moodie aims to take a step further by introducing an array of expressive, fun, and playful avatar faces.
Features
- Generates unique, vibrant avatars based on any input string
- Offers an assortment of expressions to bring your avatars to life
- Extremely lightweight with no external dependencies
- Fully customizable color palette
Usage
import { Moodie } from 'moodie';
<Moodie
size={40}
name="Ada Lovelace"
expression={{
eye: 'happy',
mouth: 'smile',
}}
colors={["#92A1C6", "#146A7C", "#F0AB3D", "#C271B4", "#C20D90"]}
/>;Props
| Prop | Type | Description |
|---|---|---|
| size | number | string | Size of the avatar, default: 40px |
| name | string | String based on which avatar is generated |
| expression | ExpressionProps | Defines the expression of the avatar |
| colors | array | Array of colors for the avatar palette |
ExpressionProps is an object that can have two keys: eye and mouth. The possible values for these keys are:
eye:normal,happy,sleepy,mischiefmouth:smile,open,surprise,unhappy
Acknowledgments
Moodie was inspired by a project originally made by Hayk An and Josep Martins.
License
Moodie is open source software licensed as MIT.
Support
If you like Moodie, star the repo or contribute to support the project!