README

Laravel-пакет для генерации аватаров-заглушек: инициалы имени на фоне детерминированного цвета. Цвет вычисляется хэшем от имени — один и тот же пользователь всегда получает один и тот же цвет фона.

Установка

composer require silent_rider/avatar-placeholder

Пакет использует Laravel package auto-discovery — service provider регистрируется автоматически, ничего добавлять в config/app.php не нужно.

Использование

<x-avatar-placeholder :name="$user->name" class="h-12 w-12 text-lg" />

Компонент принимает любые HTML/Tailwind-классы через class — они применятся к внешнему <div>.

Опционально можно переопределить количество букв инициалов прямо в месте использования:

<x-avatar-placeholder :name="$user->name" :letters-count="1" />

Конфигурация

Настройки пакета лежат в vendor/silent_rider/avatar-placeholder/config/avatar-placeholder.php и подключаются автоматически через mergeConfigFrom — публиковать файл в приложение не обязательно.

Переопределить значения можно через .env:

AVATAR_PLACEHOLDER_LETTERS_COUNT=2

Доступные настройки:

letters_count — количество букв в инициалах (по умолчанию 2)
colors — палитра фоновых цветов (массив HEX-значений)

⚠️ Требование: Tailwind CSS

Компонент выводит Tailwind-классы (flex, items-center, rounded-full, select-none и т.д.) и не подключает CSS сам — предполагается, что Tailwind уже настроен в вашем проекте.

Если вы используете JIT-сборку Tailwind, добавьте путь к пакету в content вашего tailwind.config.js, иначе классы не попадут в скомпилированный CSS и аватар отобразится без стилей:

content: [
    './resources/**/*.blade.php',
    './vendor/silent_rider/avatar-placeholder/resources/**/*.blade.php',
]

Требования

PHP >= 8.1
Laravel 10.x / 11.x / 12.x
Tailwind CSS (настроен в проекте)

Лицензия

MIT

silent_rider / avatar-placeholder

Maintainers

Package info

Statistics

Security