Skip to content

hugoogb/avatar-generator

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

26 Commits
 
 
 
 
 
 
 
 
 
 

Repository files navigation

@avatar-generator

Generate unique, deterministic SVG avatars with multiple styles.

Features

  • 7 Unique Styles: Initials, Geometric, Pixels, Rings, Faces, Illustrated, and Anime
  • Deterministic: Same seed = same avatar, always
  • Tree-shakeable: Only bundle the styles you use
  • Framework Support: React, Angular, or vanilla JS
  • Tiny: Core is under 2KB minified

Quick Start

npm install @avatar-generator/core @avatar-generator/style-initials
import { createAvatar } from "@avatar-generator/core";
import { initials } from "@avatar-generator/style-initials";

const avatar = createAvatar(initials, {
  seed: "john.doe@example.com",
  size: 64,
});

// Use the SVG
img.src = avatar.toDataUri();

Available Styles

Style Package Description
Initials @avatar-generator/style-initials Letter initials on colored backgrounds
Geometric @avatar-generator/style-geometric Grid-based shapes
Pixels @avatar-generator/style-pixels Retro pixel art
Rings @avatar-generator/style-rings Concentric colored rings
Faces @avatar-generator/style-faces Minimal flat geometric faces
Illustrated @avatar-generator/style-illustrated Detailed cartoon faces with accessories
Anime @avatar-generator/style-anime Anime/manga-inspired faces with expressive eyes

Framework Packages

  • @avatar-generator/react - React component
  • @avatar-generator/angular - Angular component

Documentation

Full documentation: avatar-generator-two.vercel.app

Playground

Test the packages locally:

git clone https://github.com/hugoogb/avatar-generator.git
cd avatar-generator/playgrounds
pnpm install
Package Command
Core pnpm playground:core
React pnpm playground:react

License

MIT

About

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Contributors