Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

https://github.com/boringdesigners/boring-avatars

Boring avatars is a tiny JavaScript React library that generates custom, SVG-based avatars from any username and color palette.
https://github.com/boringdesigners/boring-avatars

avatar avatar-component avatar-generator avatar-placeholder avatar-service avatars-constructor beautiful-avatars javascript random-avatars react svg

Last synced: about 2 months ago
JSON representation

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

Host: GitHub
URL: https://github.com/boringdesigners/boring-avatars
Owner: boringdesigners
License: mit
Created: 2020-12-23T13:47:36.000Z (over 3 years ago)
Default Branch: master
Last Pushed: 2024-01-03T04:30:48.000Z (6 months ago)
Last Synced: 2024-01-24T21:59:52.915Z (5 months ago)
Topics: avatar, avatar-component, avatar-generator, avatar-placeholder, avatar-service, avatars-constructor, beautiful-avatars, javascript, random-avatars, react, svg
Language: JavaScript
Homepage: https://boringavatars.com
Size: 2.84 MB
Stars: 5,222
Watchers: 22
Forks: 174
Open Issues: 1
Metadata Files:
- Readme: README.md
- Funding: .github/FUNDING.yml
- License: LICENSE

Lists

awesome-stars - boringdesigners/boring-avatars - Boring avatars is a tiny JavaScript React library that generates custom, SVG-based avatars from any username and color palette. (JavaScript)
awesome - boringdesigners/boring-avatars - Boring avatars is a tiny JavaScript React library that generates custom, SVG-based avatars from any username and color palette. (JavaScript)
awesome-stars - boringdesigners/boring-avatars - Boring avatars is a tiny JavaScript React library that generates custom, SVG-based avatars from any username and color palette. (JavaScript)
awesome-github-star - boring-avatars - based avatars from any username and color palette. | boringdesigners | 5059 | (JavaScript)
awesome-stars - boringdesigners/boring-avatars - Boring avatars is a tiny JavaScript React library that generates custom, SVG-based avatars from any username and color palette. (JavaScript)
awesome - boringdesigners/boring-avatars - Boring avatars is a tiny JavaScript React library that generates custom, SVG-based avatars from any username and color palette. (JavaScript)
awesome-ak - Boring Avatars - A tiny JavaScript React library that generates custom, SVG-based avatars from any username and color palette. (DevTools / Languages)
my-stars - boringdesigners/boring-avatars - Boring avatars is a tiny JavaScript React library that generates custom, SVG-based avatars from any username and color palette. (JavaScript)
awesome-stars - boring-avatars - based avatars from any username and color palette. | boringdesigners | 5492 | (JavaScript)
awesome-repos - boring-avatars
awesome-stars - boring-avatars - based avatars from any username and color palette. | boringdesigners | 5492 | (JavaScript)
awesome-stars - boring-avatars - based avatars from any username and color palette. | boringdesigners | 5489 | (JavaScript)
awesome-stars - boring-avatars - based avatars from any username and color palette. | boringdesigners | 5490 | (JavaScript)

README

        # Boring Avatars

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



![hi](https://badgen.net/npm/v/boring-avatars)

[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)



![boring avatars preview](https://github.com/boringdesigners/boring-avatars/blob/master/public/boring-avatars-preview.png?raw=true)

## Install

```

npm install boring-avatars

```

## Usage

```jsx

import Avatar from 'boring-avatars';

;

```

### 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](https://source.boringavatars.com/marble/120/Maria%20Mitchell?colors=264653,2a9d8f,e9c46a,f4a261,e76f51)

For more information, [check out the README](https://github.com/hihayk/boring-avatars-service/blob/main/README.md)