https://github.com/robinn1/svg-avatar
Create a unique avatar for each user based on their name.
https://github.com/robinn1/svg-avatar
avatar avatar-generator svg
Last synced: about 1 month ago
JSON representation
Create a unique avatar for each user based on their name.
- Host: GitHub
- URL: https://github.com/robinn1/svg-avatar
- Owner: RobiNN1
- License: mit
- Created: 2022-10-29T21:29:08.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-11-28T11:50:01.000Z (6 months ago)
- Last Synced: 2025-03-29T12:04:30.499Z (2 months ago)
- Topics: avatar, avatar-generator, svg
- Language: PHP
- Homepage:
- Size: 60.5 KB
- Stars: 2
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
SVG avatar generator
Create a unique avatar for each user based on their name.
## Installation
```
composer require robinn/svg-avatar
```
## Usage
```php
use RobiNN\SVGAvatar\SVGAvatar;
$avatar = new SVGAvatar();
echo $avatar->name('RobiNN');
```
> If you do not set a name, the user icon will be displayed.
> This can be useful for guests.
## Methods
```php
// Custom size, default is 48px.
$avatar->size(64);
// Display as a circle.
$avatar->circle();
// Border radius.
$avatar->radius(10);
// CSS class.
$avatar->class('avatar');
// Custom colors. By default, background colors are generated from name.
$avatar->setColors(['#f44336', '#e91e63', '#9c27b0', '#673ab7', '#3f51b5', '#2196f3',]);
// You can set the text color if needed. The default is 'auto' which sets '#fff' or '#000'.
$avatar->setColors([...], '#000');
// Color brightness, between 0-100, default is 50. Doesn't work with setColors().
$avatar->brightness(80);
// Color uniqueness, between 1-10, 3 is default. Doesn't work with setColors().
$avatar->uniqueness(7);
// Output as base64
$avatar->toBase64();
```
## Requirements
- PHP >= 8.2
- mbstring extension