Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sowrensen/svg-avatar-generator
Offline SVG avatar generator for Laravel
https://github.com/sowrensen/svg-avatar-generator
avatar avatar-generator laravel package svg
Last synced: about 6 hours ago
JSON representation
Offline SVG avatar generator for Laravel
- Host: GitHub
- URL: https://github.com/sowrensen/svg-avatar-generator
- Owner: sowrensen
- License: mit
- Created: 2022-12-14T15:53:41.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-05-06T07:24:15.000Z (6 months ago)
- Last Synced: 2024-06-10T11:21:36.295Z (5 months ago)
- Topics: avatar, avatar-generator, laravel, package, svg
- Language: PHP
- Homepage:
- Size: 97.7 KB
- Stars: 3
- Watchers: 1
- Forks: 1
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGELOG-1.x.md
- License: LICENSE.md
Awesome Lists containing this project
README
# Offline SVG Avatar Generator for Laravel
[](https://packagist.org/packages/sowrensen/svg-avatar-generator)
[](https://github.com/sowrensen/svg-avatar-generator/actions?query=workflow%3ATests+branch%3Amain)
[](https://packagist.org/packages/sowrensen/svg-avatar-generator)
> If you find this package useful, please consider to ⭐ it. That would be lit!
Generating SVG avatars on the fly is nothing new. There are tons of free/paid services and packages available to do that. So, why
another package for same task?
Well, this one has some subtle but nifty advantages over available packages, here's a few of them:
- [x] Supports custom font. 🧣
- [x] Supports gradient background. 🦜
- [x] Supports random gradients based on defined presets in config. 🦚
- [x] Multiple shapes: rectangular, rounded-rectangular, or circular. 💎
- [x] Ability to customize initials and extractor. ✍🏼
- [x] No external api call is required, it's totally offline. 🛰️
- [x] Unlike some other available options, doesn't require heavy-weight image processing libraries like **Intervention**.
🧺
- [x] Doesn't have any binary dependency, so nothing needs to be installed on server. 🗃️
## Requirements
| Laravel | PHP | SVGAvatarGenerator |
|----------|----------|:------------------:|
| 11.x | >=8.2 | 2.x |
| 9.x-10.x | >=8.1 | 1.x |
## Installation
Install the package via composer:
```bash
composer require sowrensen/svg-avatar-generator
```
For older versions:
```bash
composer require sowrensen/svg-avatar-generator:^1.0
```
> [!CAUTION]
> **Breaking change**: Named color support, e.g. red, green in `foreground` and `gradient_colors` is dropped since version 2.0.
> If you're using such names in config or in code, you should change them to hexadecimal code or keep using
> version 1.x releases.
Optionally, you can publish the config file with:
```bash
php artisan vendor:publish --tag="svg-avatar-generator-config"
```
> [!IMPORTANT]
> You should republish the config file after updating.
## Usage
### As model accessor
The usage of this package is stupidly simple. Use the `svg-avatar.php` config file to set your preferred decoration.
Then use the Facade to generate an avatar on the fly. The recommended way to achieve that is defining an accessor in
your model:
```php
use Illuminate\Database\Eloquent\Model;
use \Illuminate\Database\Eloquent\Casts\Attribute;
class User extends Model
{
//...
public function profilePhoto(): Attribute
{
return Attribute::get(function ($value, $attributes) {
// If profile photo is set, return the original
if (! is_null($attributes['profile_photo'])) {
return $attributes['profile_photo'];
}
// Else, generate one
return \Svg::for($attributes['name'])->toUrl();
});
}
}
```
> [!TIP]
> If your accessor is different from the original attribute, you might want to put it in `$appends` array so
> that it loads automatically with your model.
### Override default config
If you want you can generate an avatar totally different from your configured style. It has all helpful methods to make
that possible:
```php
use Sowren\SvgAvatarGenerator\Facades\Svg;
use Sowren\SvgAvatarGenerator\Enums\FontWeight;
Svg::for('John Doe')
->asCircle() // or, asRectangle() along with optional setCornerRadius($radius) method
->setSize(64)
->setCustomFontUrl('https://api.fontshare.com/v2/css?f[]=kola@400&display=swap')
->setFontFamily('Kola')
->setFontSize(40)
->setFontWeight(FontWeight::SEMIBOLD)
->setForeground('#FFFFFF')
->setGradientColors( // set of 3 different gradients
['#4158D0', '#C850C0', '#FFCC70'],
['#00DBDE', '#FC00FF'],
['#FF9A8B', '#FF6A88', '#FF99AC']
)
->setGradientStops(0, .5, 1)
->setGradientRotation(120)
->render();
```
### Customize initials
You can define the second initial using studly case. For example,
| Provided string | Produced initial |
|-----------------|:----------------:|
| John Doe | JD |
| JohnDoe | JD |
| Johndoe | JO |
| JohndoE | JE |
### Customize Extractor
The default initial extractor class produces results shown above. However, if you want something different, you can create your own Extractor class. To do so create a new class that implements `Sowren\SvgAvatarGenerator\Extractors\Extractor` interface. An ideal place to put this class would be under `App\Extractors` namespace in your app directory.
```php
App\Extractors\CustomExtractor::class,
```
## Sample Output
## Testing
Run following command to execute test cases:
```bash
composer test
```
## Changelog
Please see respective `CHANGELOG-x.x` file for more information on what has changed recently.
## License
The MIT License (MIT). Please see [License File](LICENSE.md) for more information.