jg

js-gravatar

A generic library to fetch users gravatar image or generate a custom one if none is found.

Showing:

Popularity

Downloads/wk

1.1K

GitHub Stars

3

Maintenance

Last Commit

2yrs ago

Contributors

0

Package

Dependencies

1

License

MIT

Type Definitions

Tree-Shakeable

No?

Readme

JS Gravatar

npm package

Demo

Vanilla JS

Copy dist/js-gravatar.js into your library folder Load it into your HTML script

<script type="text/javascript" src="path/to/js-gravatar.js"></script>

You can use the UNPKG link https://unpkg.com/js-gravatar@1.1.2/dist/js-gravatar.js. Remember to update the package number to the most recent.

Call the method with its options.

JsGravatar({ element, numberOfDice: 2, callback });

With npm (and CommonJS builder)

Install with npm.

npm install --save js-gravatar

Install with yarn.

yarn add js-gravatar

import the library

ES5

const JsGravatar = require('js-gravatar');

ES6

import JsGravatar from 'js-gravatar';

Call the method

JsGravatar({ email: 'user@email.com', size: 10, defaultImage: 'identicon' });
JsGravatar({ email: 'user@email.com', defaultImage: 'monsterid' });

Parameter Definitions

  • email: Email address of the user to generate gravatar for - string
  • md5Hash: Optional: MD5 hash of the email above. If email is provided, md5hash will be ignored. If neither email nor md5hash is provided, the library will throw en error - string
  • size: Optional: The size of the image to be displayed. Should be from 1 to 2048 - number
  • defaultImage: What image should be used if email does not have a gravatar. See options below - string

Defaultimage Options - ['404', 'mp', 'identicon', 'monsterid', 'wavatar', 'retro', 'robohash', 'blank']

License

MIT License

Rate & Review

Great Documentation0
Easy to Use0
Performant0
Highly Customizable0
Bleeding Edge0
Responsive Maintainers0
Poor Documentation0
Hard to Use0
Slow0
Buggy0
Abandoned0
Unwelcoming Community0
100
No reviews found
Be the first to rate

Tutorials

No tutorials found
Add a tutorial