yuki-ultra-boring-avatars
TypeScript icon, indicating that this package has built-in type declarations

1.0.1 • Public • Published

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

Sponsors

Clerk – Authentication & User Management for React

Clerk 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

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

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

Dependencies (0)

    Dev Dependencies (59)

    Package Sidebar

    Install

    npm i yuki-ultra-boring-avatars

    Weekly Downloads

    3

    Version

    1.0.1

    License

    MIT

    Unpacked Size

    23.2 kB

    Total Files

    5

    Last publish

    Collaborators

    • robwalshyuki