Skip to content
Avatune Logo

@avatune/react

Source: packages/react/README.md

React component for rendering avatars from themes.

Installation

Section titled “Installation”
Terminal window
npm install @avatune/react

Usage

Section titled “Usage”
import { Avatar } from '@avatune/react'
import theme from '@avatune/yanliu-theme/react'


function App() {
  return (
    <Avatar
      theme={theme}
      seed="user@example.com"
      size={200}
    />
  )
}

Props

Section titled “Props”
{
  theme: ReactTheme          // Theme to use for rendering (required)
  seed?: string              // Random seed for avatar generation
  size?: number              // Avatar size in pixels (default: theme size)
  className?: string         // CSS class for SVG container
  style?: CSSProperties      // Inline styles for SVG container


  // Part selection (string identifier)
  body?: string
  ears?: string
  eyebrows?: string
  eyes?: string
  hair?: string
  head?: string
  mouth?: string
  noses?: string


  // Part colors (CSS color values)
  bodyColor?: string
  earsColor?: string
  eyebrowsColor?: string
  eyesColor?: string
  hairColor?: string
  headColor?: string
  mouthColor?: string
  nosesColor?: string
}

Examples

Section titled “Examples”

Random avatar with seed:

<Avatar theme={nevmstasTheme} seed="521411f1-fab6-4ed5-90bf-2863028bcae6" />

Specific parts with custom colors:

<Avatar
  theme={nevmstasTheme}
  hair="long"
  hairColor="#ff6b6b"
  eyes="happy"
  eyesColor="#4ecdc4"
/>