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
  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

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 subscription plan to ensure uninterrupted access and support.

Get access to the Boring avatars API service here →.