# Kivi UI - Complete Developer & Agent Reference (llms-full.txt) > Kivi UI is a modern, high-performance React component library and showcase ecosystem designed to craft premium, interactive web interfaces with Tailwind CSS v4, Motion, GSAP, and WebGL GLSL shaders. ## Table of Contents - [Overview & Architecture](#overview--architecture) - [Quick Start & Installation](#quick-start--installation) - [Model Context Protocol (MCP) Server](#model-context-protocol-mcp-server) - [Documentation Pages](#documentation-pages) - [Interactive UI Components](#interactive-ui-components) - [GPU WebGL Shaders](#gpu-webgl-shaders) - [Prebuilt Building Blocks](#prebuilt-building-blocks) - [Developer Tools](#developer-tools) - [Machine-Readable Endpoints](#machine-readable-endpoints) --- ## Overview & Architecture - **Stack**: Next.js App Router, React 18/19, TypeScript, Tailwind CSS v4, Motion (Framer Motion), GSAP, Three.js, Lucide Icons, Radix UI primitives. - **Distribution Model**: Copy-paste / shadcn-compatible registry (`https://kiviui.dev/r/{component}.json`) and dedicated Kivi CLI (`kiviui-cli`). - **Philosophy**: Dark-mode-first aesthetic, rich micro-interactions, responsive touch/pointer parity, zero-bloat self-contained components. --- ## Quick Start & Installation ### Option 1: Official shadcn CLI (Recommended) Add any Kivi UI component directly using shadcn CLI: ```bash npx shadcn@latest add https://kiviui.dev/r/keyboard.json ``` Or configure the registry in your `components.json`: ```json { "registries": { "@kiviui": "https://kiviui.dev/r/{name}.json" } } ``` Then install using the short alias: ```bash npx shadcn@latest add @kiviui/keyboard ``` ### Option 2: Dedicated Kivi UI CLI ```bash npx kiviui-cli add keyboard ``` --- ## Model Context Protocol (MCP) Server Kivi UI provides a first-class MCP server for AI coding agents (Cursor, Claude Desktop, Antigravity): - **Server Endpoint**: `https://kiviui.dev/mcp` - **Supported Capabilities**: - `list-components`: Inspect available components, tags, and props. - `get-component`: Retrieve full TypeScript source code and Tailwind CSS styles. - `list-blocks`: Explore multi-component page sections. - `get-block`: Fetch full block structure, demo code, and metadata. --- ## Documentation Pages - [Introduction](https://kiviui.dev/docs/introduction): Philosophy, design principles, and ecosystem overview. - [Project Setup](https://kiviui.dev/docs/project-setup): Step-by-step setup guides for Next.js and Vite + React applications. - [CLI Setup](https://kiviui.dev/docs/cli): Official guide for shadcn CLI and Kivi UI CLI installation workflows. - [MCP Server Setup](https://kiviui.dev/docs/mcp): Connecting Kivi UI tools directly to your AI IDE. - [Code Structure](https://kiviui.dev/docs/code-structure): Architectural conventions and flat component hierarchy. --- ## Interactive UI Components - [Keyboard](https://kiviui.dev/components/keyboard): A fully functional virtual keyboard UI component with light/dark mode support, fancy keycaps, and integrated mechanical switch audio feedback. - [Animated Button](https://kiviui.dev/components/animated-button): Interactive button component with spring-physics hover animations and click feedback. - [Animated Heading](https://kiviui.dev/components/animated-heading): Sequenced headline animation with word clip reveals, rotation, and sleek accent underline wipe. - [Animated Tooltip](https://kiviui.dev/components/animated-tooltip): Animated tooltip with smooth hover transitions and dynamic border animations. - [AI Response Text](https://kiviui.dev/components/ai-response-text): Word-by-word streaming text component with progressive blur and opacity designed for AI responses and chat interfaces. - [ASCII Trail](https://kiviui.dev/components/ascii-trail): Retro ASCII cursor trail animation for creative landing pages. - [Beat Bars](https://kiviui.dev/components/beat-bars): Audio equalizer frequency bars component with sound reactivity. - [Bento Grid](https://kiviui.dev/components/bento-grid): Responsive bento-box grid layouts with staggered reveals and interactive card hovers. - [Breakable Button](https://kiviui.dev/components/breakable-button): Tactile breakable button featuring polygon shard cracks, physics-based piece breakage, and 360-degree shatter explosion. - [Browser Mockup](https://kiviui.dev/components/browser): Browser window frame mockup with URL bar and responsive layout controls. - [Circle Intro](https://kiviui.dev/components/circle-intro): Circular animated avatar intro component rotating profile images with smooth spring physics. - [Collaborative Cursor](https://kiviui.dev/components/collaborative-cursor): Multiplayer cursor simulation with username badges and smooth pointer trails. - [Dark Mode Toggle](https://kiviui.dev/components/dark-mode-toggle): Animated theme toggle button with smooth circular view transition animations. - [File Tree](https://kiviui.dev/components/file-tree): Interactive directory tree component with animated marching dashed outlines, custom file-type icons, and expandable folders. - [Flippy Text](https://kiviui.dev/components/flippy-text): Kinetic typography component that smoothly flips characters on hover with multiple transition styles. - [Focus Text](https://kiviui.dev/components/focus-text): Smooth sentence highlighting component that illuminates active words on hover or scroll. - [Globe 3D](https://kiviui.dev/components/globe-3d): Interactive Three.js WebGL rotating Earth globe with custom latitude/longitude markers and connection arcs. - [Hero Letter Reveal](https://kiviui.dev/components/hero-letter-reveal): High-impact typography hero section where each line staggers individual letters with blur dissipation. - [Image Carousel Transition](https://kiviui.dev/components/image-carousel-transition): Image carousel slider featuring smooth banner transitions and responsive controls. - [Image Trail](https://kiviui.dev/components/image-trail): Cursor trail component rendering floating image sequences following mouse movements. - [Image Zoom](https://kiviui.dev/components/image-zoom): High-resolution product image zoom with smooth cursor tracking. - [Interactive Testimonials](https://kiviui.dev/components/interactive-testimonial): Social proof review cards with blur-dimming hover focus and avatar scaling. - [iPhone Mockup](https://kiviui.dev/components/iphone): Realistic 3D-styled iPhone mobile frame to showcase mobile responsive layouts and apps. - [Koi Pond](https://kiviui.dev/components/koi-pond): GPU-rendered ripple physics simulation with swimming koi fish and water caustics. - [Magnetic Button](https://kiviui.dev/components/magnetic-button): Cursor-attracting magnetic button with spring-physics relaxation. - [Marquee Testimonials](https://kiviui.dev/components/marquee-testimonials): Infinite auto-scrolling testimonial review carousel with smooth pause on hover. - [Morphing Text](https://kiviui.dev/components/morphing-text): Variable font typography component adjusting font weight, width, and slant on cursor proximity. - [Orbit Circle](https://kiviui.dev/components/orbit-circle): 3D orbital rings component with rotating tech stack icons and glowing trails. - [Particle Image](https://kiviui.dev/components/particle-image): Canvas component converting raster images into interactive floating particles that react to cursor hover. - [Perspective Grid](https://kiviui.dev/components/perspective-grid): Retro neon perspective grid floor background built with Motion. - [QR Code Particles](https://kiviui.dev/components/qr-code-particles): Interactive QR code assembling from randomized floating particles into a scannable QR code. - [Redact Reveal](https://kiviui.dev/components/redact-reveal): Classified document redaction animation wiping away black redaction bars on scroll. - [Scroll Highlight Text](https://kiviui.dev/components/scroll-highlight-text): Scroll-driven sentence highlight reveal with pastel marker wipes and media pop-ins. - [Scroll Reveal Text](https://kiviui.dev/components/scroll-reveal-text): Scroll-triggered text reveal progressively fading in words with smooth spring transitions. - [Scroll Weight Text](https://kiviui.dev/components/scroll-weight-text): Scroll-driven variable font component scaling typography weight from thin to bold as user scrolls. - [Shader Logo Cards](https://kiviui.dev/components/shader-logo-cards): WebGL metallic distortion logo cards with dynamic highlight shaders and 3D tilt. - [Shard Image](https://kiviui.dev/components/shard-image): Photo split into three slanted clip-path shards reacting to cursor depth, tilt, and elevation. - [Shiny Button](https://kiviui.dev/components/shiny-button): Modern CTA button with metallic sheen and animated gradient border rotation. - [Signature Pad](https://kiviui.dev/components/signature): Canvas-based digital signature capture component with export to SVG/PNG. - [Smoke Shader](https://kiviui.dev/components/smoke-shader): GLSL noise smoke animation for abstract dark-mode hero sections. - [Spotlight Card](https://kiviui.dev/components/spotlight-card): Card component with cursor-tracking radial spotlight glow highlighting borders and content. - [Tab Group](https://kiviui.dev/components/tab-group): Animated tab navigation with smooth sliding active pill indicator. - [Terminal](https://kiviui.dev/components/terminal): Interactive terminal mockup with simulated command typing, output streams, and syntax highlighting. - [Text Particle Animation](https://kiviui.dev/components/text-particle-animation): Canvas particle typography scattering letters into particles on mouse hover. - [Typewriter](https://kiviui.dev/components/typewriter): Typing effect component with optional mechanical typing audio, blinking cursor, and loop controls. - [Word Swap Text](https://kiviui.dev/components/word-swap-text): Kinetic headline cycling through words with sliding reveals or staggered letter waves. --- ## GPU WebGL Shaders - [Smoke Shader](https://kiviui.dev/shaders/smoke-shader): GLSL noise smoke animation for hero headers. - [Koi Pond](https://kiviui.dev/shaders/koi-pond): Interactive WebGL water ripples with simulated swimming koi fish. - [Glitch Shader](https://kiviui.dev/shaders/glitch-shader): Retro CRT scanline and chromatic aberration glitch effect. - [Gradient Color Shader](https://kiviui.dev/shaders/gradient-color-shader): Fluid GPU color blending gradients with cursor wave displacement. - [Dotted Shader](https://kiviui.dev/shaders/dotted-shader): Dynamic wandering dot matrix canvas shader. - [Shader Logo Cards](https://kiviui.dev/shaders/shader-logo-cards): Interactive brand logo cards with dynamic shader backdrops. --- ## Prebuilt Building Blocks - [FAQ Block](https://kiviui.dev/block/faq-block): Animated accordion FAQ section with search filtering. - [Signup & Login Block](https://kiviui.dev/block/signup-login-block): Full authentication card with tabbed transitions, floating labels, and validation. - [Testimonial Block](https://kiviui.dev/block/testimonial-block): Animated arc testimonial carousel with social proof metrics. --- ## Developer Tools - [Shadow Maker](https://kiviui.dev/shadow-maker): Multi-layer CSS and Tailwind box-shadow visual editor and code exporter. - [Backgrounds & Gradients](https://kiviui.dev/backgrounds): Ready-to-use radial gradients, grid meshes, and dark mode patterns. --- ## Machine-Readable Endpoints - OpenAPI Specification: `https://kiviui.dev/openapi.json` - XML Sitemap: `https://kiviui.dev/sitemap.xml` - LLM Summary: `https://kiviui.dev/llms.txt`