asbiin/laravel-adorable

Generate an Adorable Avatar for Laravel

Fund package maintenance!
asbiin

Installs: 67 392

Dependents: 0

Suggesters: 0

Security: 0

Stars: 3

Watchers: 2

Forks: 0

1.3.0 2024-03-13 19:55 UTC

This package is auto-updated.

Last update: 2024-03-13 19:57:30 UTC


README

LaravelAdorable is an library to generate nice avatars on Laravel.

Latest Version Downloads Workflow Status Quality Gate Coverage Status

avatar1

Installation

You may use Composer to install this package into your Laravel project:

composer require asbiin/laravel-adorable

You don't need to add this package to your service providers.

Support

This package supports Laravel 8 and newer, and has been tested with php 7.4 and newer versions.

Configuration

You can publish the LaravelAdorable configuration in a file named config/adorable.php. Just run this artisan command:

php artisan vendor:publish --tag="laraveladorable-config"

This package depends on intervention/image. It requires one of the following image libraries:

  • GD Library (>=2.0)
  • or: Imagick PHP extension (>=6.5.7)

You can configure the image library to use in the driver setting of the config/adorable.php file.

Usage

Use LaravelAdorable facade to generate avatar:

use Illuminate\Support\Str;
use LaravelAdorable\Facades\LaravelAdorable;

…

  $size = 200;
  $hash = Str::uuid()->toString();
  $dataUrl = LaravelAdorable::get($size, $hash);
  // $dataUrl: "data:image/png;base64,..."

This generates a base64 data-url content, like data:image/png;base64,….

You can display a data-url in html with:

  <img src="{{ $dataUrl }}" alt="avatar" />

License

Author: Alexis Saettler

Copyright © 2022.

Licensed under the MIT License. View license.

Inspiration

This work is mainly inspired by itsthatguy/avatars-api-middleware (MIT License).

Images resources are Copyright (c) 2014 Adorable IO LLC.