Updated
AI Mascot
ProCustomize
Idle
Ink
Size280px
Follow12°
Speed1.0×
Installation
ProAI Mascot is a Pro component
Sign in to see the source, or install it with a license key. The live preview and props above are free to explore.
Install with a key
- Add the Pro registry to
components.json:components.json { "registries": { "@uibrik-pro": { "url": "https://uibrik.com/r/pro/{name}.json", "headers": { "Authorization": "Bearer ${UIBRIK_LICENSE}" } } } } - Put your key in
.env.localand add that file to.gitignore:.env.local UIBRIK_LICENSE=your-license-key - Install it:
Terminal npx shadcn@latest add @uibrik-pro/ai-mascot
Loading your installation…
Usage
import { AIMascot } from "@/components/uibrik/ai-mascot/ai-mascot";<AIMascot state="idle" preset="ink" size={280} follow={12} speed={1} interactive label="Assistant" // getLevel={() => {}} // MASCOT_PRESETS={…}/>Where to use AI Mascot
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
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
Brand characters
Shape, material, colour and eyes are all props, so one tiny character can become your product's own.
Pairs with AI Blob
Props
AIMascot- state
- Type "idle" | "listening" | "thinking" | "speaking" | "success" | "failed" | "sleeping"
- "idle"
- What the mascot is doing. Changes blend smoothly.
- preset
- Type "ink" | "peach" | "mint" | "lumen" | "bolt" | "frost" | "custom"
- "ink"
- A ready-made look. Any look prop you pass overrides it.
- shape
- Type "mochi" | "orb" | "bean" | "block" | "drop"
- "drop"
- Body shape.
- material
- Type "flat" | "soft" | "glow" | "gloss"
- "flat"
- Flat two-tone shading, a soft gradient, lit from within, or glossy.
- color
- Type string
- "#8adcff"
- Body colour. "auto" is charcoal on light pages and near-white on dark ones.
- eyeColor
- Type string
- "#1d1a4d"
- Eye colour. "auto" picks black or white against the body.
- eyes
- Type "pill" | "round" | "line" | "visor"
- "pill"
- Eye style.
- eyeSize
- Type number
- 1.35
- Size of the eyes.
- eyeGap
- Type number
- 1
- Space between the eyes.
- size
- Type number
- 280
- Width of the frame.
- follow
- Type number
- 12
- Most the body turns toward the pointer. 0 keeps it facing front.
- speed
- Type number
- 1
- Speed of every animation.
- interactive
- Type boolean
- true
- Click or tap for a poke.
- getLevel
- Type () => 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
- Type string
- "Assistant"
- Read out to screen readers, followed by the state.
- MASCOT_PRESETS
- Type export
- –
- The six preset looks, to start your own from.
- className
- Type string
- –
- Classes for the frame.