1.7.1 • Published 1 year ago

@mythal/boring-avatars v1.7.1

Weekly downloads
-
License
MIT
Repository
github
Last release
1 year ago

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"
  colors={["#92A1C6", "#146A7C", "#F0AB3D", "#C271B4", "#C20D90"]}
/>;

Props

PropType
sizenumber or string, 40px (default)
squareboolean: false (default)
titleboolean: false (default)
namestring
variantoneOf: marble (default), beam, pixel,sunset, ring, bauhaus
colorsarray of colors

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