Skip to content

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

License

Notifications You must be signed in to change notification settings

ustincameron/boring-avatars

 
 

Repository files navigation

Boring Avatars

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

boring avatars preview

hi License: MIT

Install

npm install boring-avatars

Usage

import Avatar from "boring-avatars";

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

Props

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

Service

You can embed your boring avatars using the boring avatars source.

To choose a random avatar from a specific user and a color palette, the format follows:

https://source.boringavatars.com/marble/120/Maria%20Mitchell?colors=264653,2a9d8f,e9c46a,f4a261,e76f51

Avatar for Maria Mitchell

For more information, check out the README

About

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

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages

  • JavaScript 98.1%
  • HTML 1.6%
  • CSS 0.3%