Giter Club home page Giter Club logo

react-nice-avatar's Introduction

react-nice-avatar

Version npm download

imagewall

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'
  1. Generate random config, the config can be saved into your database to use later
const config = genConfig(AvatarConfig?)
  1. 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

key type default accept tips
id string Only for React Props
className string Only for React Props
style object Only for React Props
shape string circle circle, rounded, square Only for React Props
sex string man, woman
faceColor string
earSize string small, big
hairColor string
hairStyle string normal, thick, mohawk, womanLong, womanShort
eyeStyle string circle, oval, smile
glassesStyle string none, round, square Usually is none
noseStyle string short, long, round
mouthStyle string laugh, smile, peace
shirtStyle string hoody, short, polo
shirtColor string
bgColor string

Development

  1. $ git clone [email protected]:chilllab/react-nice-avatar.git: Clone the codebase
  2. $ yarn or $ npm install: Install dependencies
  3. $ make dev: Star the server for the demo
  4. $ open http://localhost:5555: Open the browser to reivew the demo
  5. Edit the files inside /src

License

MIT

react-nice-avatar's People

Contributors

wwayne avatar

Watchers

 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.