1.0.1 • Published 6 months ago

yuki-ultra-boring-avatars v1.0.1

Weekly downloads
-
License
MIT
Repository
github
Last release
6 months ago

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](https://opensource.org/licenses/MIT)

boring avatars preview

Sponsors

[Clerk](https://clerk.com?utm_source=sponsorship&utm_medium=github&utm_campaign=boringavatars&utm_content=06_12_2023) provides drop-in authentication for React and has built-in support for Boring Avatars.

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](https://github.com/hihayk/boring-avatars-service/blob/main/README.md)