Mimo is an open-source avatar system that generates unique, animated characters from any string. Unlike traditional avatars, every Mimo is fully animated — blinking, floating, glancing — right out of the box. 145,152 unique combinations ensure no two avatars look alike.
# bun
bun install mimo-id
# npm
npm install mimo-id
# pnpm
pnpm add mimo-idGenerate avatars as SVG over HTTP. The name is the URL path — all options go in the query string.
<img src="https://api.mimoid.fun/mimo" />Import the Mimo component and pass a name string. Props match the API parameters.
import { Mimo } from "mimo-id/react";
<Mimo
name="mimo"
size={48}
animations={["blink"]}
/>Avatars are derived from a hash of the input string — the same name always produces the same face. Fully deterministic, with nothing stored or fetched.
Faces are assembled from 6 eye styles, 4 eyebrow types, 7 mouths, 2 cheek options, 3 accessories, 16 colors, and 9 rotations.
All animations are CSS-based and injected on demand — combine freely.
| Animation | Description |
|---|---|
blink |
Periodic blinking |
float |
Gentle vertical bob |
sway |
Subtle horizontal sway |
eyeWander |
Eyes drift around |
eyebrowBounce |
Eyebrows bounce |
glance |
Eyes glance to the side |
entrance |
Animated entrance |
Set a mood to give the avatar a specific expression, regardless of the generated features.
happy · surprised · sleepy · cool · cheeky
Pass several to let each name pick one of them deterministically, so a crowd stays varied while every individual keeps the same face: mood={["happy", "surprised", "cool"]} in React, ?mood=happy,surprised,cool in the API.
Three clipping shapes — circle, squircle, square — and four 3D depth levels — none, subtle, medium, dramatic.
Replace the default palette with your own gradient pairs.
<Mimo
name="user"
gradients={[
{ from: "#667EEA", to: "#764BA2" },
{ from: "#F093FB", to: "#F5576C" },
]}
/>Props and API params share the same names. In the API, name is the URL path — all others are query params.
| Prop | Type | Default | Description |
|---|---|---|---|
name |
string |
— | Input string for deterministic generation |
size |
number |
40 / 128 |
Avatar size in px. React: 40, API: 128 |
shape |
"circle" | "squircle" | "square" |
"circle" |
Clipping shape |
variant |
"faces" |
"faces" |
Variant plugin |
background |
"gradient" | "solid" |
"gradient" |
Background style |
mood |
Mood | Mood[] where Mood is "happy" | "surprised" | "sleepy" | "cool" | "cheeky" |
— | Override expression; a list picks one per name deterministically. API: comma-separated |
detailLevel |
"minimal" | "basic" | "standard" | "full" |
auto | Feature visibility. Adapts to size by default |
depth |
"none" | "subtle" | "medium" | "dramatic" |
"dramatic" |
3D perspective depth |
animations |
Animation[] |
[] |
CSS animations. API: comma-separated |
gradients |
{ from, to }[] |
— | Custom gradient palette |
For interactive examples, a live playground, and the full API reference, visit mimoid.fun.
Mimo is licensed under the MIT License.