Privacy-friendly analytics only with consent. No ads, no cross-site tracking. Read the privacy policy.
Get started with Slipstream UI in your project.
Slipstream UI is React-first: every component is a React 18+ / TypeScript component. It runs in any React environment — Next.js, Vite, Remix, and Astro are all covered below. Framework-agnostic builds (Vue, Svelte, vanilla JS) are not on the roadmap yet; if your app renders React, you can use Slipstream.
The original slipstream-ui npm package (v3.x, Tailwind 2/3 era) is deprecated and no longer maintained. Use @slipstream-ui/core and @slipstream-ui/ai instead — they are unrelated to the old package and ship with machine-readable manifests, an MCP server, and a shadcn-compatible registry.
| Path | How | Server components |
|---|---|---|
| Package imports | Install the npm packages and import from the root or a component subpath such as @slipstream-ui/core/card. | The root entry is one client bundle for compatibility. Subpaths keep each file's directive, so presentational components stay server-rendered. |
| Registry copy-in | Copy component source with npx shadcn@latest add. You own the files. | Per-file directives are preserved. Presentational components stay server-rendered. |
| CLI add | npx @slipstream-ui/cli@latest add <id> copies the component, its dependency closure, and shared utils. | Same as registry copy-in, with dependency resolution handled for you. |
Use package imports for a quick client-side integration. Use registry or CLI copies when the host app renders server components, needs editable source, or wants to avoid a package-wide client boundary. The compatibility matrix and the consumer smoke build record what is tested.
Every package is published to npm with matching types and a COMPONENT_MANIFEST where it ships components. Open the npm link for a package to see its version history and dependency list.
| Package | What it provides | npm |
|---|---|---|
| @slipstream-ui/core | Components, design tokens, and the cn() utility | npm ↗ |
| @slipstream-ui/ai | AI chat and agent components | npm ↗ |
| @slipstream-ui/themes | createTheme(), presets, and the CSS-variable contract | npm ↗ |
| @slipstream-ui/cli | init, add, list, and diff for copying component source | npm ↗ |
| @slipstream-ui/registry | Manifest registry resolution shared by the CLI and MCP server | npm ↗ |
| @slipstream-ui/mcp-server | MCP tools for agent-driven component lookup and validation | npm ↗ |
| @slipstream-ui/i18n | Locale provider, switcher, and message catalogs | npm ↗ |
The fastest way to get started is using the Slipstream UI CLI:
npx @slipstream-ui/cli@latest init
This will:
If you prefer to install manually, follow these steps:
pnpm add @slipstream-ui/core @slipstream-ui/ai @slipstream-ui/themes
Extend your Tailwind config with the Slipstream UI theme. Tailwind CSS 3 users can use the published preset, which carries every token mapping and the animate plugin:
// tailwind.config.jsmodule.exports = {presets: [require('@slipstream-ui/themes/tailwind-preset')],content: ['./src/**/*.{ts,tsx}','./node_modules/@slipstream-ui/**/*.{js,ts,tsx}',],}
If you already maintain your own token map, the longhand equivalent is below.
// tailwind.config.jsconst path = require('node:path')// Resolve the real package directory: pnpm symlinks make a literal// ./node_modules/@slipstream-ui glob unreliable.const slipstreamDist = path.dirname(require.resolve('@slipstream-ui/core'))module.exports = {darkMode: ['class'],content: ['./src/**/*.{ts,tsx}',`${slipstreamDist}/**/*.{js,mjs}`,],theme: {extend: {colors: {border: 'hsl(var(--border))',input: 'hsl(var(--input))',ring: 'hsl(var(--ring))',background: 'hsl(var(--background))',foreground: 'hsl(var(--foreground))',primary: {DEFAULT: 'hsl(var(--primary))',foreground: 'hsl(var(--primary-foreground))',},secondary: {DEFAULT: 'hsl(var(--secondary))',foreground: 'hsl(var(--secondary-foreground))',},destructive: {DEFAULT: 'hsl(var(--destructive))',foreground: 'hsl(var(--destructive-foreground))',},success: {DEFAULT: 'hsl(var(--success))',foreground: 'hsl(var(--success-foreground))',},warning: {DEFAULT: 'hsl(var(--warning))',foreground: 'hsl(var(--warning-foreground))',ink: 'hsl(var(--warning-ink))',},info: {DEFAULT: 'hsl(var(--info))',foreground: 'hsl(var(--info-foreground))',ink: 'hsl(var(--info-ink))',},muted: {DEFAULT: 'hsl(var(--muted))',foreground: 'hsl(var(--muted-foreground))',},accent: {DEFAULT: 'hsl(var(--accent))',foreground: 'hsl(var(--accent-foreground))',},popover: {DEFAULT: 'hsl(var(--popover))',foreground: 'hsl(var(--popover-foreground))',},card: {DEFAULT: 'hsl(var(--card))',foreground: 'hsl(var(--card-foreground))',},},borderRadius: {lg: 'var(--radius)',md: 'calc(var(--radius) - 2px)',sm: 'calc(var(--radius) - 4px)',},},},plugins: [require('tailwindcss-animate')],}
Add the CSS variables to your global CSS file:
@tailwind base;@tailwind components;@tailwind utilities;@layer base {:root {--background: 0 0% 100%;--foreground: 222 85% 7%;--card: 0 0% 100%;--card-foreground: 222 85% 7%;--popover: 0 0% 100%;--popover-foreground: 222 85% 7%;--primary: 224 89% 53%;--primary-foreground: 0 0% 100%;--secondary: 214 45% 96%;--secondary-foreground: 222 47% 11%;--muted: 214 40% 96%;--muted-foreground: 219 12% 42%;--accent: 214 45% 96%;--accent-foreground: 222 47% 11%;--destructive: 348 68% 44%;--destructive-foreground: 0 0% 100%;--success: 142 63% 32%;--success-foreground: 0 0% 100%;--warning: 38 92% 50%;--warning-foreground: 26 83% 14%;--warning-ink: 32 90% 32%;--info: 190 76% 38%;--info-foreground: 222 75% 10%;--info-ink: 190 90% 28%;--border: 214 28% 89%;--input: 214 28% 89%;--ring: 224 89% 53%;--radius: 0.375rem;}.dark {color-scheme: dark;--background: 220 6% 7%;--foreground: 220 9% 95%;--card: 220 5% 12%;--card-foreground: 220 9% 95%;--popover: 220 5% 15%;--popover-foreground: 220 9% 95%;--primary: 224 90% 70%;--primary-foreground: 220 30% 8%;--secondary: 220 5% 16%;--secondary-foreground: 220 9% 95%;--muted: 220 5% 16%;--muted-foreground: 220 6% 68%;--accent: 220 5% 16%;--accent-foreground: 220 9% 95%;--destructive: 0 76% 64%;--destructive-foreground: 220 30% 8%;--success: 142 62% 52%;--success-foreground: 220 30% 8%;--warning: 38 92% 60%;--warning-foreground: 26 83% 14%;--warning-ink: 38 92% 62%;--info: 190 80% 58%;--info-foreground: 220 30% 8%;--info-ink: 190 80% 62%;--border: 220 6% 22%;--input: 220 6% 28%;--ring: 224 90% 70%;}}
Start using components in your app:
import { Button } from '@slipstream-ui/core'import { Message, Conversation } from '@slipstream-ui/ai'function App() {return (<div><Button>Click me</Button><Conversation messages={messages} /></div>)}
Slipstream UI works with all major package managers:
pnpm add @slipstream-ui/core @slipstream-ui/ai
npm install @slipstream-ui/core @slipstream-ui/ai
yarn add @slipstream-ui/core @slipstream-ui/ai
When the package is linked from a local checkout through a pnpm workspace or a file: dependency, Vite can resolve a second React copy from the package's development dependencies. Dedupe React in the consumer config:
// vite.config.tsimport { defineConfig } from 'vite';export default defineConfig({resolve: {dedupe: ['react', 'react-dom', 'react/jsx-runtime'],},});
A repacked tarball reinstalled under the same name and version may come from the package manager cache. Bump the version or clear the store entry before reinstalling. Registry copies are unaffected.
Slipstream UI works with any React framework. Here are the specifics for the most common setups:
Add the CSS variables to your global stylesheet, then import components in client components:
// app/globals.css@tailwind base;@tailwind components;@tailwind utilities;@layer base {:root {/* ... CSS variables from step 3 ... */}.dark {color-scheme: dark;/* ... dark CSS variables ... */}}
// app/layout.tsximport './globals.css';// Pre-paint theme script (avoids flash of wrong theme)const THEME_INIT = `try {const stored = localStorage.getItem('slipstream-theme');if (stored === 'dark' || (!stored && matchMedia('(prefers-color-scheme: dark)').matches)) {document.documentElement.classList.add('dark');}} catch {}`;export default function RootLayout({ children }: { children: React.ReactNode }) {return (<html lang="en" suppressHydrationWarning><head><script dangerouslySetInnerHTML={{ __html: THEME_INIT }} /></head><body>{children}</body></html>);}
Components use 'use client' internally, so they work as client components within server layouts. No additional configuration is needed.
Import the CSS variables in your entry file and add the Tailwind content paths:
// src/main.tsximport './index.css';import App from './App';// src/index.css — same CSS variables as above// tailwind.config.js — content paths include:// './src/**/*.{ts,tsx}',// './node_modules/@slipstream-ui/**/*.{js,ts,tsx}'
Add the CSS via your root route's links export:
// app/root.tsximport stylesheet from '~/tailwind.css';export const links = () => [{ rel: 'stylesheet', href: stylesheet },];// Same CSS variables + Tailwind content paths as above
Use a React integration for interactive components. Static markup works without it:
# Install the React integrationnpx astro add react// Then use components in .astro files with client:load// for interactive components:---import { Button } from '@slipstream-ui/core';---<Button client:load>Click me</Button>
As long as you have React 18 or 19 and either Tailwind CSS 3.4+/4.x or the prebuilt stylesheets (@slipstream-ui/core/styles.css plus @slipstream-ui/themes/styles.css), Slipstream UI works. Components are plain React; runtime dependencies are @radix-ui/react-slot, @radix-ui/react-avatar, class-variance-authority, clsx, tailwind-merge, and tailwindcss-animate, all installed automatically.