Skip to content

Latest commit

 

History

History
41 lines (30 loc) · 1.4 KB

README.md

File metadata and controls

41 lines (30 loc) · 1.4 KB
Raw

Boring Avatars

Boring avatars is a tiny JavaScript React library that generates custom, SVG-based avatars from any username and color palette.

hi License: MIT

boring avatars preview

Install

npm install boring-avatars

Usage

import Avatar from 'boring-avatars';

<Avatar
  size={40}
  name="Maria Mitchell"
  variant="marble"
  colors={['#92A1C6', '#146A7C', '#F0AB3D', '#C271B4', '#C20D90']}
/>;

Props

Prop Type
size number or string, 40px (default)
square boolean: false (default)
title boolean: false (default)
name string
variant oneOf: marble (default), beam, pixel,sunset, ring, bauhaus
colors array of colors