# AI Mascot

A minimal 3D mascot for AI products, rendered in three.js with flat illustration shading: just a round body and two eyes. It listens, thinks, speaks, celebrates, fails and sleeps, blending smoothly between states, and takes any shape, material, colour and eye style, with six presets.

- Page and source: https://uibrik.com/components/ai-mascot
- Install (Pro, needs a license key, see https://uibrik.com/docs/pro): `npx shadcn@latest add @uibrik-pro/ai-mascot`
- Packages: none beyond React
- Import: `import { AIMascot } from "@/components/uibrik/ai-mascot/ai-mascot"`

Where to use the AI Mascot React component:

- **Voice assistants**: Listening and speaking can follow a real audio level, so the mascot leans in and bounces along with the voice. Pairs with [Siri Orb](https://uibrik.com/components/siri-orb).
- **Agent status**: Thinking, success and failed give an agent run a face users read at a glance instead of a spinner. Pairs with [Agent Trace](https://uibrik.com/components/agent-trace).
- **Brand characters**: Shape, material, colour and eyes are all props, so one tiny character can become your product's own. Pairs with [AI Blob](https://uibrik.com/components/ai-blob).

| Prop | Type | Default | Description |
| --- | --- | --- | --- |
| state | `"idle" \| "listening" \| "thinking" \| "speaking" \| "success" \| "failed" \| "sleeping"` | `"idle"` | What the mascot is doing. Changes blend smoothly. |
| preset | `"ink" \| "peach" \| "mint" \| "lumen" \| "bolt" \| "frost" \| "custom"` | `"ink"` | A ready-made look. Any look prop you pass overrides it. |
| shape | `"mochi" \| "orb" \| "bean" \| "block" \| "drop"` | `"drop"` | Body shape. |
| material | `"flat" \| "soft" \| "glow" \| "gloss"` | `"flat"` | Flat two-tone shading, a soft gradient, lit from within, or glossy. |
| color | `string` | `"#8adcff"` | Body colour. "auto" is charcoal on light pages and near-white on dark ones. |
| eyeColor | `string` | `"#1d1a4d"` | Eye colour. "auto" picks black or white against the body. |
| eyes | `"pill" \| "round" \| "line" \| "visor"` | `"pill"` | Eye style. |
| eyeSize | `number` | `1.35` | Size of the eyes. |
| eyeGap | `number` | `1` | Space between the eyes. |
| size | `number` | `280` | Width of the frame. |
| follow | `number` | `12` | Most the body turns toward the pointer. 0 keeps it facing front. |
| speed | `number` | `1` | Speed of every animation. |
| interactive | `boolean` | `true` | Click or tap for a poke. |
| getLevel | `() => number` |  | Returns the current audio level, 0 to 1, read every frame while listening or speaking. Without it a made-up voice is used. |
| label | `string` | `"Assistant"` | Read out to screen readers, followed by the state. |
| MASCOT_PRESETS | `export` |  | The six preset looks, to start your own from. |
| className | `string` |  | Classes for the frame. |
