Skip to content

Boring avatars is an open source 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

boringdesigners/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.

hi

Install

npm install boring-avatars

Usage

import Avatar from 'boring-avatars';

<Avatar name="Maria Mitchell" />;

Props

Prop Type Default
size number or string 40px
square boolean false
title boolean false
name string Clara Barton
variant oneOf: marble, beam, pixel,sunset, ring, bauhaus marble
colors array ['#92A1C6', '#146A7C', '#F0AB3D', '#C271B4', '#C20D90']

Name

The name prop is used to generate the avatar. It can be the username, email or any random string.

<Avatar name="Maria Mitchell"/>

Variant

The variant prop is used to change the theme of the avatar. The available variants are: marble, beam, pixel, sunset, ring and bauhaus.

<Avatar name="Alice Paul" variant="beam"/>

Size

The size prop is used to change the size of the avatar.

<Avatar name="Ada Lovelace" size={88}/>

Colors

The colors prop is used to change the color palette of the avatar.

<Avatar name="Grace Hopper" colors={["#fb6900", "#f63700", "#004853", "#007e80", "#00b9bd"]}/>

Square

The square prop is used to make the avatar square.

<Avatar name="Helen Keller" square/>

API service

Important

Please note that the old service will be paused by the end of this month - July 31st 2024. We recommend transitioning to our new API service to ensure uninterrupted access and support.

Get access to the Boring avatars API service here →.