@avatune/yanliu-theme

Source: packages/assets/yanliu-theme/README.md

Avatar theme for Avatune using yanliu design assets.

Installation

npm install @avatune/yanliu-theme

yarn add @avatune/yanliu-theme

pnpm add @avatune/yanliu-theme

bun add @avatune/yanliu-theme

Usage

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

React

import { Avatar } from '@avatune/react'
import theme from '@avatune/yanliu-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/yanliu-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/yanliu-theme/svelte'
</script>

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

Vanilla JavaScript

import { avatar } from '@avatune/vanilla'
import theme from '@avatune/yanliu-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="braids"          // Choose specific hair style
  hairColor="#FF5733"    // Custom hair color
  body="blouse"     // Choose specific clothing
  bodyColor="#3498DB"    // Custom clothing color
/>

Design Assets

This theme uses Yanliu style SVG assets for creating customizable avatars. Assets include various options for hair, eyes, eyebrows, mouth, nose, ears, head shape, and body/clothing.

The assets are available in the @avatune/yanliu-assets package.

Using Assets Directly

SVG Paths

import { hair, eyes, mouth } from '@avatune/yanliu-assets';

React Components

import { HairShort, EyesBoring, MouthSmile } from '@avatune/yanliu-assets/react';

Svelte Components

import { HairShort, EyesBoring, MouthSmile } from '@avatune/yanliu-assets/svelte';

Vue Components

import { HairShort, EyesBoring, MouthSmile } from '@avatune/yanliu-assets/vue';

Available Assets

Body

Preview	Filename
	`blouse`
	`flowerCardigan`
	`simpleCardigan`
	`simpleOverall`
	`striped`
	`sweaterVest`
	`sweaterWavy`
	`teeBasic`
	`teeButtoned`
	`teePocket`
	`teeRound`

Ears

Preview	Filename
	`standard`

Eyes

Preview	Filename
	`standard`

FaceDetails

Preview	Filename
	`blushes`

FaceHair

Preview	Filename
	`bigBeard`
	`chevronMustache`
	`mustache`

Forelock

Preview	Filename
	`bubble`
	`curve`
	`short`
	`split`
	`straight`
	`underCut`

Glasses

Preview	Filename
	`glass`

Hair

Preview	Filename
	`braids`
	`hijab`
	`medium`
	`puff`
	`straightLong`
	`straightMedium`

Hats

Preview	Filename
	`beanie`
	`hat`

Head

Preview	Filename
	`standard`

Mouth

Preview	Filename
	`smile`

Neck

Preview	Filename
	`standard`

Noses

Preview	Filename
	`standard`

License & Credits

Theme License

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

Design Assets License

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

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

For full details, see CREDITS.md.

@avatune/yanliu-assets - SVG assets used by this theme
@avatune/react - React avatar renderer
@avatune/vue - Vue avatar renderer
@avatune/svelte - Svelte 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