• Stars
    star
    459
  • Rank 95,377 (Top 2 %)
  • Language
    TypeScript
  • License
    MIT License
  • Created over 4 years ago
  • Updated almost 2 years ago

Reviews

There are no reviews yet. Be the first to send feedback to the community and the maintainers!

Repository Details

Generate your 100% fingerprinted example avatar from id, email, username etc.

generate-avatar

👆 The logo is: generateFromString('generateavatar')

License Version bundle size (minified) type definitions

Check out the example and download your avatar: https://generate-avatar.now.sh/

Why use Generate Avatar?

A lightweight and blazing fast avatar generator, which is 100% fingerprinted and unique for any input you want.

Pass in your email, uuid, username etc. as an input and it will generate everytime the same unique svg based avatar for you.

Which means you don't have to store any generated images in your database anymore. It generates those images on the fly wherever you want based on the id, email and so on.

The best thing it's only 5 kB small, so it can be basically used everywhere you want.

Install

  yarn add generate-avatar

or

  npm install generate-avatar

How it works

You pass in the string you want and it will return the svg in a string format:

  import { generateFromString } from 'generate-avatar'

  generateFromString("[email protected]")

This will generate the svg in a string format. In order to use it, you can use the image data src attribute like this:

<img src={`data:image/svg+xml;utf8,${generateFromString("[email protected]")}`} />

Try it out here and download the image. You will see that it generates the exact same image everytime. Isn't that amazing ?

generate-avatar generate-avatar generate-avatar generate-avatar generate-avatar generate-avatar