Exciting release!Introducing "safe npm". Learn more
Socket
Log inDemoInstall

react-avatar-generator

Package Overview
Dependencies
4
Maintainers
1
Versions
5
Issues
File Explorer

Advanced tools

react-avatar-generator

React component which allows your users to generate random kaleidoscope avatars.

    1.0.3latest
    GitHub

Version published
Maintainers
1
Weekly downloads
437
increased by59.49%

Weekly downloads

Readme

Source

React Avatar Generator

This was inspired by an old website called LayerVault. You can see an example of how that used to look like here.

Getting Started

  • yarn add react-avatar-generator or npm i react-avatar-generator
  • import AvatarGenerator from 'react-avatar-generator';

Example Usage

<AvatarGenerator colors={['#333', '#222', '#ccc']} backgroundColor="#000" />

This creates something like this:

With a little playing around with this component I found it quite easy to make something similar to what LayerVault originally had.

Props

proptypedefaultoptions
widthnumber200
heightnumber200
mirrorsnumber3
zoomnumber0.2
rotationnumber0.3
fadenumber1
opaictynumber0.3
amountnumber16
spacingnumber20
wavelengthnumber2
sizingnumber4
shapestring'circle'can be circle, triangle or square
backgroundColorstring'#fff'
backgroundOpacitynumber0.3
colorsarray[]

Methods

proptypedescription
randomizefunctionRandomizes the kaleidoscope to have a new random pattern
isValidHexfunctionPassing in a string will return true of false if that string is a valid hex, a helpful function to have when working with colors
getImageDatafunctionCalling this function returns the raw image/png data you can then use to save into a .png file.

Using Methods

class CustomAvatarGenerator extends React.Component { constructor(props) { super(props); this.avatarGenerator = null; } randomize() { this.avatarGenerator.randomize(); } render() { return ( <div> <button onClick={this.randomize}>Randomize</buttom> <AvatarGenerator ref={(el) => { this.avatarGenerator = el; } colors={['#333', '#222', '#ccc']} backgroundColor="#000" /> </div> ); } }

FAQs

Last updated on 10 Jan 2019

Did you know?

Socket installs a Github app to automatically flag issues on every pull request and report the health of your dependencies. Find out what is inside your node modules and prevent malicious activity before you update the dependencies.

Install Socket
Socket
support@socket.devSocket SOC 2 Logo

Product

  • Package Issues
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc