@avatune/miniavs-theme

@avatune/miniavs-theme

Avatar theme for Avatune using miniavs design assets.

Installation

npm install @avatune/miniavs-theme

Usage

This theme is available for multiple frameworks: React, Vue, Svelte, Angular, and Vanilla JavaScript.

React

import { Avatar } from '@avatune/react'
import theme from '@avatune/miniavs-theme/react'

function App() {
  return (
    <Avatar
      theme={theme}
      size={300}
      seed="optional-seed-for-random-generation"
    />
  )
}

Vue

<script setup lang="ts">
import { Avatar } from '@avatune/vue'
import theme from '@avatune/miniavs-theme/vue'
</script>

<template>
  <Avatar
    :theme="theme"
    :size="300"
    seed="optional-seed-for-random-generation"
  />
</template>

Svelte

<script lang="ts">
  import { Avatar } from '@avatune/svelte'
  import theme from '@avatune/miniavs-theme/svelte'
</script>

<Avatar
  theme={theme}
  size={300}
  seed="optional-seed-for-random-generation"
/>

Angular

import { Component } from '@angular/core'
import { Avatar } from '@avatune/angular'
import theme from '@avatune/miniavs-theme/angular'

@Component({
  selector: 'app-root',
  standalone: true,
  imports: [Avatar],
  template: `
    <avatune-avatar
      [theme]="theme"
      [inputSize]="300"
      seed="optional-seed-for-random-generation"
    />
  `,
})
export class AppComponent {
  theme = theme
}

Vanilla JavaScript

import { avatar } from '@avatune/vanilla'
import theme from '@avatune/miniavs-theme/vanilla'

const container = document.getElementById('avatar-container')
const svg = avatar({
  theme,
  size: 300,
  seed: 'optional-seed-for-random-generation',
})

container?.appendChild(svg)

Customization

You can override specific avatar parts:

<Avatar
  theme={theme}
  size={300}
  hair="baldness"          // Choose specific hair style
  hairColor="#FF5733"    // Custom hair color
  body="standard"     // Choose specific clothing
  bodyColor="#3498DB"    // Custom clothing color
/>

Design Assets

This theme uses assets from the @avatune/miniavs-assets package.

License

This theme package is licensed under MIT (see LICENSE.md).

The design assets used in this theme have their own license and attribution:

This project uses avatar design assets licensed under CC BY 4.0.

Original designs by Webpixels. Modifications were made to adapt them for composable SVG avatars.

For full details, see:

• CREDITS.md - Asset attribution
• Asset package license in @avatune/miniavs-assets

Related Packages

• @avatune/miniavs-assets - SVG assets used by this theme
• @avatune/react - React avatar renderer
• @avatune/vue - Vue avatar renderer
• @avatune/svelte - Svelte avatar renderer
• @avatune/angular - Angular avatar renderer
• @avatune/vanilla - Vanilla JavaScript avatar renderer

Development

# Build the theme
bun run build

# Build in watch mode
bun run dev

# Type checking
bun run check-types