1.2.4 • Published 2 years ago

react-nice-avatar2 v1.2.4

Weekly downloads
-
License
MIT
Repository
github
Last release
2 years ago

react-nice-avatar

Version npm download Build Status Netlify Status

Online editor / preview

Assets

Installation

npm install react-nice-avatar

or

yarn add react-nice-avatar

Usage

  1. Import the component.
    import Avatar, { genConfig } from 'react-nice-avatar'
  2. Generate a random configuration, save it so that you can always rendering a same avatar with the configuration.

    const config = genConfig(AvatarConfig?) 

    tip: AvatarConfig is an Object, plz check the Options below for what attributes can be passed in

  3. Render the component with specific width / height and configuration.

    <Avatar style={{ width: '8rem', height: '8rem' }} {...config} />

    or

    <Avatar className="w-32 h-32" {...config} />

Options

The options can be passed into genConfig or as React props

keytypedefaultaccepttips
idstringOnly for React Props
classNamestringOnly for React Props
styleobjectOnly for React Props
shapestringcirclecircle, rounded, squareOnly for React Props
sexstringman, woman
faceColorstring
earSizestringsmall, big
hairColorstring
hairStylestringnormal, thick, mohawk, womanLong, womanShort
hairColorRandombooleanfalsethick,mohawk default only be black
hatColorstring
hatStylestringnone, beanie, turbanUsually is none
eyeStylestringcircle, oval, smile
glassesStylestringnone, round, squareUsually is none
noseStylestringshort, long, round
mouthStylestringlaugh, smile, peace
shirtStylestringhoody, short, polo
shirtColorstring
bgColorstring
isGradientbooleanfalse

Development

  1. Clone the repo:
    $ git clone git@github.com:chilllab/react-nice-avatar.git
    $ cd react-nice-avatar
  2. Install dependencies:
    $ yarn
    Or
    $ npm install
  3. Start the server for the demo:
    $ make dev
  4. Open the browser to reivew the demo:
    $ open http://localhost:8080
  5. Edit the files inside src.

Test

  1. Lint test:

    $ make lint-test
  2. code test:

    $ make test

License

Released under MIT by @dapilab.