avatar-alias-gen

avatar-alias-gen: Username and Avatar Generator

A lightweight library for generating random usernames and avatars, inspired by Reddit-style naming conventions. This library is customizable, supports multiple themes, and includes avatar generation using the DiceBear API.

Demo

View Demo

NPM Package

View on NPM

Features

• Random Username Generation: Create unique usernames with customizable themes.
• Avatar Generation: Generate visually appealing avatars for each username using DiceBear API.
• Themes:
  • Classic: Adjective + Noun + Number (Geometric avatars)
  • Emotional: Emotion + Verb + Element (Emoji avatars)
  • Elemental: Element + Color + Verb (Glass avatars)
  • Tech: Tech Term + Element + Number (Bot avatars)
• Easy integration with modern JavaScript frameworks.

Installation

npm i avatar-alias-gen

Usage

Basic example

import { generateUsernameAndAvatar, generateAvatar } from 'avatar-alias-gen';

async function generateUser() {
  const { username, avatar } = await generateUsernameAndAvatar("classic");
  console.log("Username:", username);
  console.log("Avatar URL:", avatar);
}
generateUser();

// Using generateAvatar to generate only avatar
generateAvatar("classic", "test_username").then((avatar) => {
  console.log("Avatar URL:", avatar);
});

React

Example on codesandbox

import React,{useState} from 'react';
import { generateUsernameAndAvatar } from 'avatar-alias-gen';

const App = () => {
   const [result, setResult] = useState<{
    username: string;
    avatar: string;
  } | null>({
    username: "",
    avatar: "",
  });

  const generateUser = async () => {
    const data = await generateUsernameAndAvatar({
      theme:'classic',
    });
    setResult(data);
  };
  return (
    <div>
      <h1>{username}</h1>
      <img src={avatar} alt="User Avatar" />
    </div>
  );
};
export default App;

Angular

Example on codesandbox

import { Component, OnInit } from '@angular/core';
import { generateUsernameAndAvatar } from 'avatar-alias-gen';

@Component({
  selector: 'app-root',
  template: `
    <div>
      <h1>{{ username }}</h1>
      <img [src]="avatarUrl" alt="User Avatar" />
    </div>
  `,
  styleUrls: ['./app.component.css']
})
export class AppComponent implements OnInit {
  username: string = '';
  avatarUrl: string = '';

  ngOnInit() {
    generateUsernameAndAvatar({ theme: 'classic' }) 
      .then(result => {
        this.username = result.username;
        this.avatarUrl = result.avatar;
      })
      .catch(error => {
        console.error('Error generating username and avatar:', error);
      });
  }
}

Vue

Example on codesandbox

<template>
  <div>
    <h1>{{ username }}</h1>
    <img :src="avatarUrl" alt="User Avatar" />
  </div>
</template>

<script>
import { ref, onMounted } from "vue";
import { generateUsernameAndAvatar, generateAvatar } from 'avatar-alias-gen';

const username = ref("");
const avatarUrl = ref("");

onMounted(async () => { 
  const generatedUsername = await generateUsernameAndAvatar({theme:'classic',separator:true});
  username.value = generatedUsername.username;
  avatarUrl.value = generatedUsername.avatar
});
</script>

Functions

generateUsernameAndAvatar(theme:string, separator:boolean): Promise<{ username: string; avatar: string }>

• Description: Generates a username and avatar based on the theme.
• Parameters:
  • theme: One of classic, emotional, elemental, tech.
  • separator: Determines whether to add separator or not in the username.

generateUsername(theme:string, separator:boolean): string

• Description: Generates a username based on the theme.
• Parameters:
  • theme: One of classic, emotional, elemental, tech.
  • separator: Determines whether to add separator or not in the username.
  • Example: bright_tiger42

generateAvatar(theme: string, username: string): string

• Description: Generates an avatar URL based on the selected theme and username.
• Parameters:
  • theme: One of classic, emotional, elemental, tech.
  • username: The username to generate the avatar for.