https://github.com/beyonk-group/initials-avatar

Create avatars from user initials in pure javascript
https://github.com/beyonk-group/initials-avatar

avatar google image-generation initials

Last synced: 12 months ago
JSON representation

Create avatars from user initials in pure javascript

• Host: GitHub
• URL: https://github.com/beyonk-group/initials-avatar
• Owner: beyonk-group
• Created: 2019-10-25T15:48:55.000Z (over 6 years ago)
• Default Branch: master
• Last Pushed: 2024-08-01T21:10:01.000Z (almost 2 years ago)
• Last Synced: 2025-05-30T13:47:47.929Z (about 1 year ago)
• Topics: avatar, google, image-generation, initials
• Language: JavaScript
• Size: 91.8 KB
• Stars: 4
• Watchers: 3
• Forks: 0
• Open Issues: 4
• Metadata Files:
  • Readme: README.MD

Awesome Lists containing this project

README

          


    


    


    

    


    




![image](https://user-images.githubusercontent.com/218949/67595311-40f07e00-f75e-11e9-96bf-ffe9842ee869.jpg)

# Initials Avatar

[![js-standard-style](https://img.shields.io/badge/code%20style-standard-brightgreen.svg)](http://standardjs.com)

Generates image based avatars from initials, in node.

Uses a random background colour and a contrasting foreground colour.

Uses pure javascript, no native dependencies.

## Install

```sh

$ npm install --save @beyonk/initials-avatar

```

## Usage

Add the plugin to your loadtest configuration:

```js

const { createWriteStream } = require('fs')

const { createAvatar } = require('@beyonk/initials-avatar')

const output = createWriteStream('/some/output/file.jpg')

await createAvatar({ firstName: 'Antony', lastName: 'MacKenzie-Jones' }, output)

```

### Config

#### Changing avatar size

You can change the default avatar size from 128px

```js

await createAvatar({ firstName: 'Antony', lastName: 'MacKenzie-Jones' }, output, { size: 512 })

```

#### Forcing avatar background-colour

You can choose the background colour (and the foreground will contrast automatically)

```js

await createAvatar({ firstName: 'Antony', lastName: 'MacKenzie-Jones' }, output, { background: '#ff0c7e' })

```