https://github.com/patrickvaler/st-gravatar-img

Web Component to display Gravatar images
https://github.com/patrickvaler/st-gravatar-img

Last synced: 17 days ago
JSON representation

Web Component to display Gravatar images

• Host: GitHub
• URL: https://github.com/patrickvaler/st-gravatar-img
• Owner: patrickvaler
• License: mit
• Created: 2018-07-18T19:15:21.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2020-05-29T21:55:03.000Z (over 4 years ago)
• Last Synced: 2024-10-10T06:43:52.459Z (28 days ago)
• Language: TypeScript
• Size: 7.2 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: readme.md
  • Contributing: .github/CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# st-gravatar-img

[![npm version](https://badge.fury.io/js/st-gravatar-img.svg)](http://badge.fury.io/js/st-gravatar-img)

[![Build Status](https://travis-ci.org/patrickvaler/st-gravatar-img.svg?branch=master)](https://travis-ci.org/patrickvaler/st-gravatar-img)

[![Dependency Status](https://david-dm.org/patrickvaler/st-gravatar-img/status.svg?style=flat)](https://david-dm.org/patrickvaler/st-gravatar-img)

[![semantic-release](https://img.shields.io/badge/%20%20%F0%9F%93%A6%F0%9F%9A%80-semantic--release-e10079.svg)](https://github.com/semantic-release/semantic-release)

[![Greenkeeper badge](https://badges.greenkeeper.io/patrickvaler/st-gravatar-img.svg)](https://greenkeeper.io/)

![Built With Stencil](https://img.shields.io/badge/-Built%20With%20Stencil-16161d.svg?logo=data%3Aimage%2Fsvg%2Bxml%3Bbase64%2CPD94bWwgdmVyc2lvbj0iMS4wIiBlbmNvZGluZz0idXRmLTgiPz4KPCEtLSBHZW5lcmF0b3I6IEFkb2JlIElsbHVzdHJhdG9yIDE5LjIuMSwgU1ZHIEV4cG9ydCBQbHVnLUluIC4gU1ZHIFZlcnNpb246IDYuMDAgQnVpbGQgMCkgIC0tPgo8c3ZnIHZlcnNpb249IjEuMSIgaWQ9IkxheWVyXzEiIHhtbG5zPSJodHRwOi8vd3d3LnczLm9yZy8yMDAwL3N2ZyIgeG1sbnM6eGxpbms9Imh0dHA6Ly93d3cudzMub3JnLzE5OTkveGxpbmsiIHg9IjBweCIgeT0iMHB4IgoJIHZpZXdCb3g9IjAgMCA1MTIgNTEyIiBzdHlsZT0iZW5hYmxlLWJhY2tncm91bmQ6bmV3IDAgMCA1MTIgNTEyOyIgeG1sOnNwYWNlPSJwcmVzZXJ2ZSI%2BCjxzdHlsZSB0eXBlPSJ0ZXh0L2NzcyI%2BCgkuc3Qwe2ZpbGw6I0ZGRkZGRjt9Cjwvc3R5bGU%2BCjxwYXRoIGNsYXNzPSJzdDAiIGQ9Ik00MjQuNywzNzMuOWMwLDM3LjYtNTUuMSw2OC42LTkyLjcsNjguNkgxODAuNGMtMzcuOSwwLTkyLjctMzAuNy05Mi43LTY4LjZ2LTMuNmgzMzYuOVYzNzMuOXoiLz4KPHBhdGggY2xhc3M9InN0MCIgZD0iTTQyNC43LDI5Mi4xSDE4MC40Yy0zNy42LDAtOTIuNy0zMS05Mi43LTY4LjZ2LTMuNkgzMzJjMzcuNiwwLDkyLjcsMzEsOTIuNyw2OC42VjI5Mi4xeiIvPgo8cGF0aCBjbGFzcz0ic3QwIiBkPSJNNDI0LjcsMTQxLjdIODcuN3YtMy42YzAtMzcuNiw1NC44LTY4LjYsOTIuNy02OC42SDMzMmMzNy45LDAsOTIuNywzMC43LDkyLjcsNjguNlYxNDEuN3oiLz4KPC9zdmc%2BCg%3D%3D&colorA=16161d&style=flat-square)

A simple web component to display [gravatar] images based on [stencil].

Checkout the [Demo] / [Demo with Editor].

## Install this component

### By cdn

```html

```

### By npm (self hosted)

```bash

npm install st-gravatar-img --save

```

```html

```

## Use this component

```html

```

## Attributes

| Attribute | Type     | Default | Description                                                |

| --------- | -------- | ------- | ---------------------------------------------------------- |

| `hash`    | _string_ | _none_  | MD5 hash of your email (avoid to expose your email)        |

| `email`   | _string_ | _none_  | Gravatar account email (**warning** email will be exposed) |

| `size`    | _number_ | `120`   | Size (px) of the image                                     |

## CSS Variables

[CSS Variables][css-variables] can be used to style the web component:

### Available variables

| Attribute                      | Default | Description                                            |

| ------------------------------ | ------- | ------------------------------------------------------ |

| `--gravatar-img-border`        | _none_  | Defines `border` property of the `img` element         |

| `--gravatar-img-border-radius` | _none_  | Defines `border-radiues` property of the `img` element |

| `--gravatar-img-background`    | _none_  | Defines `background` property of the `img` element     |

### Example usage

```css

:root {

  --gravatar-img-border: 10px solid #a52525;

  --gravatar-img-border-radius: 100%;

  --gravatar-img-background: #a52525;

}

```

## How to create a hash

Images on [Gravatar] can be accessed by a `MD5` hash of your email address.

### How to use `createHash` method

This web component offers the possibility to create a hash based on your email address by the exposed `createHash` method.

```javascript

let gravatarImg = document.querySelector('st-gravatar-img');

// method is available when component is ready

gravatarImg.componentOnReady().then(() => {

  // create hash

  const hash = gravatarImg.createHash('[email protected]');

  // now you can apply the hash on the web component

  gravatarImg.setAttribute('hash', hash);

});

```

[stencil]: https://stenciljs.com/

[gravatar]: https://gravatar.com/

[css-variables]: https://developer.mozilla.org/en-US/docs/Web/CSS/Using_CSS_variables

[demo]: https://st-gravatar-img-vanilla-js.stackblitz.io/

[demo with editor]: https://stackblitz.com/edit/st-gravatar-img-vanilla-js