Package Exports
- react-nice-avatar
This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (react-nice-avatar) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.
Readme
react-nice-avatar

Installation
npm install react-nice-avatar
or
yarn add react-nice-avatar
Usage
- Import the component
import Avatar, { genConfig } from 'react-nice-avatar'
- Generate random config, the config can be saved into your database to use later
const myConfig = genConfig(optObj?)
- Render the component with config and width / height
<Avatar style={{ width: '8rem', height: '8rem' }} {...config} />
or using className to set the width / height
<Avatar className="w-32 h-32" {...config} />
Options
The options can be passed into genConfig or on React props
key | type | default | accept |
---|---|---|---|
className | string | ||
style | object | ||
shape | string | circle | circle, rounded, square |
sex | string | man, woman | |
faceColor | string | ||
earSize | string | small, big | |
hairColor | string | ||
hairStyle | string | normal, thick, mohawk, womanLong, womanShort | |
eyeStyle | string | circle, oval, smile | |
noseStyle | string | short, long, round | |
mouthStyle | string | laugh, smile, peace | |
shirtStyle | string | hoody, short, polo | |
shirtColor | string | ||
bgColor | string |
License
MIT