Looking to hire Laravel developers? Try LaraJobs
This package is not available.

laravel-avatars maintained by dondodano

Description
Self-hosted initials avatar generator (SVG/PNG) for Laravel, with a ui-avatars.com compatible endpoint.
Author
Dondo Dano
Last update
2026/10/26 13:17 (dev-main)
License
MIT
Links
Homepage - GitHub - Packagist
Downloads
1
Tags
laravel - avatar - initials - ui-avatars

dev-main

Last update
2026/10/26 13:17
License
MIT
Require
  • php ^8.2
  • ext-gd *
  • ext-mbstring *
  • illuminate/http ^11.0|^12.0
  • illuminate/routing ^11.0|^12.0
  • illuminate/support ^11.0|^12.0
v1.0.0

Last update
2026/10/26 13:08
License
MIT
Require
  • php ^8.2
  • ext-gd *
  • ext-mbstring *
  • illuminate/support ^11.0|^12.0
Comments
comments powered by Disqus

dondodano/laravel-avatars

Self-hosted initials avatars for Laravel (SVG or PNG). A drop-in replacement for ui-avatars.com: same query parameters, no external dependency.

Requirements

  • PHP 8.2+ with gd (built with FreeType) and mbstring
  • Laravel 11 or 12

Installation

composer require dondodano/laravel-avatars

The service provider is auto-discovered. Optionally publish the config:

php artisan vendor:publish --tag=avatars-config

Endpoint

GET /api/avatar?name=System+Administrator&background=random&size=128&rounded=true&bold=true&format=png
Parameter Default Notes
name John Doe Initials are taken from the first letter of each word; a single word uses its first length letters
size 64 16–512 px
background random Hex (4CAF50, #4CAF50, abc) or random; random is derived from the name, so it is stable per user
color ffffff Text color
length 2 Number of initials
font-size 0.5 Ratio of size, 0.1–1
rounded false Circular crop
bold false
uppercase true
format svg svg or png

Responses are cookie-free and sent with a one-year immutable Cache-Control. Path, middleware, cache lifetime and defaults are in config/avatars.php.

PHP API

use Dondodano\Avatars\Avatar;

Avatar::make('System Administrator')->size(128)->rounded()->bold()->format('png')->toUrl();
Avatar::make('Jane Doe')->toDataUri();   // embed, no HTTP request
Avatar::make('Jane Doe')->png();         // raw bytes, e.g. Storage::put()

toUrl() is absolute and built from APP_URL/the current request, so set APP_URL correctly if you store the URLs.

Testing

composer install
composer test
composer format:check

License

MIT. Bundled font: DejaVu Sans (free license, see https://dejavu-fonts.github.io/License.html).