planet-avatar

Planet Avatar turns any string or number seed into a stable, self-contained SVG planet. It is useful for user avatars, team members, account images, activity feeds, placeholders, and product UI where the same identity should always render the same visual.

Website: http://planet-avatar.vikingz.me/

Features

• Deterministic output from any seed
• Self-contained SVG strings with no canvas runtime or image assets
• Vanilla JavaScript core API
• Thin React and Vue adapters
• Built-in planet variants: void, drift, mira, flux, luna, orbit, sol
• Optional custom palettes, rings, backgrounds, sizes, and accessible titles
• ESM, CommonJS, and TypeScript declaration output

Install

npm install planet-avatar

React and Vue are optional peer dependencies. Install only the framework adapter you use.

Quick Start

import { createPlanetAvatar } from 'planet-avatar'

const svg = createPlanetAvatar({
  seed: 'viking',
  size: 128,
  variant: 'orbit',
  rings: true,
  title: 'Viking avatar'
})

document.querySelector('#avatar')!.innerHTML = svg

Use the DOM helper when you want Planet Avatar to mount directly into an element:

import { mountPlanetAvatar } from 'planet-avatar'

mountPlanetAvatar(document.querySelector('#avatar')!, {
  seed: 'nova-42',
  size: 96,
  title: 'Nova avatar'
})

Core API

import {
  createPlanetAvatar,
  createPlanetAvatarDataUri,
  mountPlanetAvatar,
  VARIANT_NAMES,
  VARIANTS
} from 'planet-avatar'

createPlanetAvatar(options)

Returns a complete SVG string.

const svg = createPlanetAvatar({
  seed: 'atlas',
  size: 160,
  variant: 'luna'
})

createPlanetAvatarDataUri(options)

Returns a data:image/svg+xml URI for image tags or CSS.

const src = createPlanetAvatarDataUri({
  seed: 'atlas',
  size: 160
})

mountPlanetAvatar(target, options)

Renders the SVG into an existing element.

mountPlanetAvatar(element, {
  seed: 'atlas',
  size: 160
})

Options

type PlanetAvatarOptions = {
  seed: string | number
  size?: number
  variant?: 'auto' | 'void' | 'drift' | 'mira' | 'flux' | 'luna' | 'orbit' | 'sol'
  palette?: 'auto' | string[]
  rings?: boolean | 'auto'
  background?: 'transparent' | string
  title?: string
}

Variants

import { VARIANT_NAMES } from 'planet-avatar'

console.log(VARIANT_NAMES)
// ['void', 'drift', 'mira', 'flux', 'luna', 'orbit', 'sol']

Use variant: 'auto' when you want the seed to choose a stable preset. Use a named variant when product art direction matters.

React

import { PlanetAvatar, usePlanetAvatar } from 'planet-avatar/react'

export function Profile() {
  const svg = usePlanetAvatar({ seed: 'viking', size: 96 })

  return (
    <>
      <PlanetAvatar seed="viking" size={96} variant="orbit" title="Viking avatar" />
      <output>{svg.length}</output>
    </>
  )
}

The React adapter exports:

• PlanetAvatar
• usePlanetAvatar
• PlanetAvatarProps

Vue

<script setup lang="ts">
import { PlanetAvatar } from 'planet-avatar/vue'
</script>

<template>
  <PlanetAvatar seed="viking" :size="96" variant="orbit" title="Viking avatar" />
</template>

The Vue adapter exports:

• PlanetAvatar
• usePlanetAvatar

Accessibility

Pass title when the avatar conveys identity or content. Planet Avatar will render a <title> and connect it with aria-labelledby.

When title is omitted, the generated SVG uses aria-hidden="true" so it behaves as decorative artwork.

Development

npm install
npm run check

Common scripts:

Repository Layout

src/core        Core SVG generator, palettes, random helpers, and types
src/react       React component and hook
src/vue         Vue component and composable
docs/src        Astro/Starlight documentation site and landing page
docs/public     Static docs assets, including logo.svg and favicon.svg
examples        Vanilla, React, and Vue starter examples
tests           Core and adapter tests

Publishing

Before publishing:

npm run check
npm run release:pack
npm run release:dry

Then publish:

npm run release:publish

Cloudflare Pages

Deploy the docs site with:

npm run pages:deploy

The script builds the docs site first, then deploys docs/dist using Wrangler:

npx wrangler pages deploy docs/dist --project-name planet-avatar

License

MIT