🌜
🌞
boring-avatars

boring-avatars

v1.7.0

Boring avatars is a tiny JavaScript React library that generates custom, SVG-based, round avatars from any username and color palette.

npm install boring-avatars

README

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

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

Release Notes

1.7.0
By Josep Martins • Published on June 15, 2022

Adding an optional title prop to allow disable/enable native browser tooltips.

1.6.3
By Josep Martins • Published on February 20, 2022

Add GENERATE_SOURCEMAP=false to .env.production file

1.6.2
By Josep Martins • Published on February 20, 2022

Add index.map.js to the build

1.6.1
By Josep Martins • Published on December 24, 2021
  • Use HEX colors on all variant's mask.
  • Remove yarn.lock
  • Adjust playground's color palette*

*The playground it's just a placeholder and not the one we use in production. For any change or suggestion: https://github.com/boringdesigners/boring-avatars-playground

1.6.0
By Josep Martins • Published on December 23, 2021

General

License
MIT
Typescript Types
Built-in
Tree-shakeable
No

Popularity

GitHub Stargazers
4,133
Community Interest
2,940
Number of Forks
139

Maintenance

Commits
10/219/22015
Last Commit
Open Issues
1
Closed Issues
34
Open Pull Requests
0
Closed Pull Requests
14

Versions

Versions Released
10/219/2202
Latest Version Released
Jun 15, 2022
Current Tags
latest1.7.0

Contributors

josepmartins
josepmartins
Commits: 93
hihayk
hihayk
Commits: 80
roderik
roderik
Commits: 1
bozdoz
bozdoz
Commits: 1