Skip to content

Latest commit

 

History

History
33 lines (23 loc) · 910 Bytes

README.md

File metadata and controls

33 lines (23 loc) · 910 Bytes

y-avatars

a small package for custom svg-based placeholder avatars

NPM JavaScript Style Guide

Install

npm install --save y-avatars

Usage

import React, { Component } from 'react'

import { Avatar } from 'y-avatars'

class Example extends Component {
  render() {
    return <Avatar  variant = 'pixel'//varients[  'pixel','frame','ring','smilly','sunset','marble','triangle','patterns','classic'],
  colors = {['#92A1C6', '#146A7C', '#F0AB3D', '#C271B4', '#C20D90']}//colors to use
  name = {'Example Name'}//name used to generate random avatars
  size = {40}//the size of the avatar
  radius = {100}//radius />
  }
}

License

MIT © uwenayoallain