finity-labs/fin-avatar

Privacy-focused SVG avatar generator for Filament.
1,271 3
Install
composer require finity-labs/fin-avatar
Latest Version:v1.1.0
PHP:^8.2
Maintainer: Finity Labs

FinAvatar for Filament

finity-labs-fin-avatar

FILAMENT 4.x FILAMENT 5.x Latest Version on Packagist Tests Code Style Total Downloads License

A privacy-focused, high-performance avatar provider for Filament V4 and V5. It generates SVGs locally using a dedicated route, ensuring zero external requests (GDPR compliant) and utilizing browser caching for instant loads.

Features

  • Zero External APIs: No data sent to ui-avatars.com or Gravatar.

  • Smart Initials: Automatically strips "Mr.", "Dr.", "PhD" etc.

  • Theme Aware: Uses your Filament Panel's primary color automatically.

  • High Performance: SVGs are cached by the browser for 1 year.

Installation

You can install the package via composer:

composer require finity-labs/fin-avatar

Running the install command will configure the selected panels automatically:

php artisan finity-labs:install

Usage

Add in AdminPanelProvider.php:

use FinityLabs\FinAvatar\Providers\UiAvatarsProvider;

public function panel(Panel $panel): Panel
{
    return $panel
        // ...
        ->defaultAvatarProvider(UiAvatarsProvider::class);
}

Configuration (Optional)

Publish the config file to customize ignored prefixes (like "Mr", "Dr"), default background color and text color:

php artisan vendor:publish --tag=fin-avatar-config

:bulb: Note: Leave default_bg null to use theme color as background.

Credits

License

The MIT License (MIT). Please see License File for more information.