tomshaw/laravel-gravatar

A zero config named parameter Laravel Gravatar Directive.

v0.1.0 2024-04-14 12:20 UTC

This package is auto-updated.

Last update: 2024-05-14 13:02:01 UTC


README

A zero config named parameter Laravel Gravatar Directive.

GitHub Workflow Status issues forks stars GitHub license

blank mp identicon monsterid wavatar retro robohash blank

Installation

You can install the package via composer:

composer require tomshaw/laravel-gravatar

Usage

Configure the Gravatar Image where you plan on utilizing it.

<img src="@gravatar(email: 'email@example.com', size: 60, default: 'retro', rating: 'g')" />

This generates an 60 pixels retro style image with a g rating.

Parameters

The default parameters are described below:

  • $email (string): The email address of the user. This is required.

  • $size (int): The size of the Gravatar image in pixels. Default is 60. Must be between 1 and 2048.

  • $default (string): The default image to display if the user doesn't have a Gravatar. Default is 'mp'. Options include: 'mp', 'identicon', 'monsterid', 'wavatar', 'retro', 'robohash', 'blank'.

  • $rating (string): The rating of the Gravatar image. Default is 'g'. Options include: 'g', 'pg', 'r', 'x'.

  • $secure (bool): Whether to use the secure Gravatar URL. Default is true.

  • $forceDefault (string): Whether to always load the default image. Default is 'n'.

  • $forceExtension (string): The file extension for the Gravatar image. Default is 'jpg'.

Requirements

The package is compatible with PHP 8 or later.

License

The MIT License (MIT). See License File for more information.