Skip to content

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

License

Notifications You must be signed in to change notification settings

jakeisnt/boring-avatars

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Boring Avatars

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

boring avatars preview

hi License: MIT

Install

yarn add boring-avatars

or

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
name string
variant oneOf: marble, beam, pixel,sunset, ring, bauhaus
colors array of colors

Source

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

PNG conversion

Unfortunately, HTML5 Canvas tools only support a subset of SVG, so any tools that use a canvas-based approach to convert SVG to other image formats via HTML5 won't be able to capture photos like these avatars. The best way to download an image of one of these avatars without significant effort invested in image rendering is to just take a screenshot.

About

Boring avatars is a tiny JavaScript React library that generates custom, SVG-based, round 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%