atereshchuk/blade-boring-avatars

Blade components to auto generate boring avatars based on name

0.0.2 2024-07-14 13:12 UTC

Requires

• php: ^8.1
• ext-json: *
• illuminate/support: ^7.0|^8.0|^9.0|^10.0|^11.0

Requires (Dev)

• nunomaduro/collision: ^7.0
• orchestra/testbench: ^5.0|^6.0|^7.0|^8.0
• phpunit/phpunit: ^10.0

MIT

• Khaled Sadek

• ui
• laravel
• blade

README

A Blade version of Boring Avatars. Built using Laravel Blade.

Based on Boring Avatar's description,

Boring Avatars a tiny JavaScript React library that generates custom, SVG-based, round avatars from any username and color palette.

Here I make a blade component to use in your laravel projects

Features

• Similar API with the React version of Boring Avatars.

Installation

composer require atereshchuk/blade-boring-avatars

Props

Props:

• size: number
  • Default: 40
• name: string
  • Default: "Clara Barton"
• colors: array[]
  • Accepts a php array of colors.
  • Default: ["#92A1C6", "#146A7C", "#F0AB3D", "#C271B4", "#C20D90"]

Usage

Basic usage (with default props):

<x-avatar />

With props:

  <!--
      view.blade.php
      Where $colors is php valid array
  -->
  <x-avatar size="80" name="Khaled Sadek" :colors="$colors" />

Credits

Credits to @hihayk (GitHub) and @josep_martins (GitHub) for creating the original Boring Avatars library at boringdesigners!