ngx-gravatar

ngx-gravatar

The gravatar directive for angular 4, 5 and 6+. It is AoT compatible.

This directive supports two avatar sources:

• Custom image
• Gravatar

By default, the custom image has higher priority. If it is invalid, the Gravatar will be used. The priority can be changed by setting preferGravatar input or override the default configuration (see below).

Visit here for more information about Gravatar.

Demo

Live demo here.

Play with ngx-gravatar here on stackblitz.

Installation

Install ngx-gravatar via NPM, using the command below.

NPM

npm install --save ngx-gravatar

Getting started

Import the GravatarModule in your root application module AppModule:

import { BrowserModule } from  '@angular/platform-browser';
import { NgModule } from  '@angular/core';

import { AppComponent } from './app.component';

import { GravatarModule } from  'ngx-gravatar';

@NgModule({
  declarations: [
    AppComponent,
  ],
  imports: [
    BrowserModule,
    // Import GravatarModule
    GravatarModule,
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Use in component

After importing the GravatarModule, you can use the ngx-gravatar directive in any components as below:

<img ngx-gravatar [email]="'[e-mail]'">
<img ngx-gravatar [email]="'[e-mail]'" size="30">
<img ngx-gravatar [email]="'[e-mail]'" size="30" src="assets/avatar.jpg">
<img ngx-gravatar [email]="'[e-mail]'" size="30" src="assets/avatar.jpg" [style]="styleObject">

Input Parameters

Attribute	Type	Required	Default	Description
email	string	requried	(empty string)	Email associated with Gravatar
src	string	optional		Custom image to use
preferGravatar	boolean	optional	false	If true, Gravatar will have higher priority. Otherwise, src image will be loaded first.
size	number	optional	40	Size of the avatar
round	boolean	optional	true	Circle avatar
cornerRadius	number	optional	0	Round the corner of square avatar. Only applied when round is set to false
borderColor	string	optional		Specify the color of the border
borderWidth	number	optional		Specify the width of the border
style	object	optional		Style object that will be applied on the <img> tag
backgroundColor	string	optional	transparent	Specify the background color
rating	string	optional	g	The rating string of Gravatar. Possible values: g, pg, r, x. rating type is case-insensitive.
fallback	string	optional	retro	The fallback string of Gravatar. Possible values: blank, indenticon, mm, monsterid, retro, robohash, wavatar. fallback is case sensitive.

Override Default Configuration

Default configuration options can be set globally by using the .forRoot() method. Note that the input parameters that are passed into an ngx-gravatar element will override any custom global config options that have been set. Please see below for an example of how to override default configurations.

import { BrowserModule } from '@angular/platform-browser';
import { NgModule } from '@angular/core';

import { AppComponent } from './app.component';

import { GravatarModule, GravatarDefaultConfig, FALLBACK_TYPES, RATING_TYPES } from 'ngx-gravatar';

const gravatarConfig: GravatarDefaultConfig = {
  fallback: FALLBACK_TYPES.robohash,
  rating: RATING_TYPES.x,
  backgroundColor: 'rgba(0, 0, 0, 0.1)',
  borderColor: 'rgba(0, 0, 0, 0.1)',
  hasBorder: true // Set this flag to true to have a border by default
}

@NgModule({
  declarations: [
    AppComponent,
  ],
  imports: [
    BrowserModule,
    // Import GravatarModule with custom configuration globally
    GravatarModule.forRoot(gravatarConfig)
  ],
  providers: [],
  bootstrap: [AppComponent]
})
export class AppModule { }

Options

Option	Type	Required	Default	Description
hasBorder	boolean	optional	false	Specify whether to have border or not
preferGravatar	boolean	optional	false	If true, Gravatar will have higher priority. Otherwise, src image will be loaded first.
size	number	optional	40	Size of the avatar
round	boolean	optional	true	Circle avatar
cornerRadius	number	optional	0	Round the corner of square avatar. Only applied when round is set to false
borderRadius	string	optional	50%	Only applied when round is set to true.
borderColor	string	optional	#000000	Specify the color of the border
borderWidth	number	optional	1	Specify the width of the border
borderStyle	string	optional	solid	Style object that will be applied on the <img> tag
backgroundColor	string	optional	transparent	Specify the background color
rating	string	optional	g	The rating string of Gravatar. Possible values: g, pg, r, x. Note: rating type is case insensitive.
fallback	string	optional	retro	The fallback string of Gravatar. Possible values: blank, indenticon, mm, monsterid, retro, robohash, wavatar. Note: fallback is case sensitive.

Testing

To lint

ng lint

To run all tests

ng test

License

MIT © t-ho

Changelog

v2.1.0

• Be able to set backgroundColor locally and globally
• Be able to set Gravatar rating (g, pg, r, x)
• BugFix: ngx-gravatar tried to load the invalid Gravatar over and over again, spamming the console when invalid Gravata fallback type is passed to forRoot() method.
• Remove @type/lodash package from dependencies