Xvatar SDK 🎨

Generate beautiful, unique gradient avatars for your users with Xvatar SDK - a powerful TypeScript library that creates consistent, personalized avatars from usernames. ✨

Website : Xvatar

🚀 Installation

npm install xvatar-sdk
# or
yarn add xvatar-sdk
# or
pnpm add xvatar-sdk
# or
bun add xvatar-sdk

💡 Quick Start

import { generateAvatar } from "xvatar-sdk";

// Generate a simple avatar
const avatarUrl = generateAvatar({ username: "johndoe" });

// Customize your avatar
const customAvatar = generateAvatar({
  username: "johndoe",
  size: 200,
  format: "svg",
  rounded: 50,
});

🛠️ Features

• 🎯 Consistent avatars for the same username
• 🖼️ Support for PNG and SVG formats
• 📐 Customizable size and roundness
• ⚡ Lightweight and fast
• 🌈 Beautiful color combinations

🔧 API Reference

generateAvatar(options)

Creates a unique avatar based on the provided options.

interface AvatarOptions {
  username: string; // Required: Seed for the avatar
  size?: number; // Optional: Size in pixels (default: 140)
  format?: "png" | "svg"; // Optional: Output format (default: 'png')
  rounded?: number; // Optional: Corner roundness (default: 70)
  text?: string; // Optional: Custom text (SVG only)
  userLogo?: boolean; // Optional: Use user logo (default: false)
}

// Basic usage
const basic = generateAvatar({
  username: "alice",
});

// All options
const advanced = generateAvatar({
  username: "bob",
  size: 200,
  format: "svg",
  rounded: 50,
  userLogo: true,
});

🎨 Examples

Here are some example avatars generated with different options:

// SVG with custom text
const svgAvatar = generateAvatar({
  username: "[email protected]",
  format: "svg",
  text: "CEO",
});

// Large PNG avatar
const largeAvatar = generateAvatar({
  username: "cool_user_123",
  size: 400,
});

// Square avatar
const squareAvatar = generateAvatar({
  username: "minimalist",
  rounded: 0,
});

// Cute user avatar
const squareAvatar = generateAvatar({
  username: "minimalist",
  rounded: 30,
  userLogo: true,
});

🖼️ Gallery

Here are some example avatars generated using Xvatar SDK:

Default Avatars

SVG with User Logo

Different Shapes

SVG with Text

Made with ❤️ by the Anish Biswas aka Xeven777