0.3.0 • Published 6 years ago

react-initicon v0.3.0

Weekly downloads
87
License
MIT
Repository
github
Last release
6 years ago

React Initicon

Initial Icons for React

RE A C T

IN IT IC ON

Initicon Demo

Usage

<Initicon
  size={100}
  text="Test Account"
  seed={23}
  single={false}
/>

Browser

<script src="https://rawgit.com/ccm-innovation/react-initicon/master/initicon.min.js"></script>

Installation

$ npm install --save react-initicon

Node.js

var Initicon = require('react-initicon');

React Native

var Initicon = require('react-initicon/native');

Props

KeyTypeDescription
textStringThe text to use to make initials
sizeNumberThe pixel height / width of the icon
seedNumberNumber uses to seed the random hue generator
colorStringOverride the background color with any valid CSS color value
singleBooleanWhether to only use a single initial or now
saturationStringSpecify the hsl saturation value
brightnessStringSpecify the hsl lightness (brightness) value

Contributing

Modify the files in the src folder. Before committing, update the build by running npm run build. This will babelify the code and then compress into initicon.min.js for a browser version.