@framingui/ui
v0.6.12
Published
FramingUI Reference Component Library
Downloads
272
Maintainers
Readme
@framingui/ui
React components for FramingUI.
Use this package when you want FramingUI components directly in an app, whether you install them manually or through @framingui/mcp-server init.
Install
pnpm add @framingui/ui
pnpm add -D tailwindcss-animateImport the shared styles once at the app root when your app uses the FramingUI-native style contract:
/* app/globals.css */
@import '@framingui/ui/styles';In Tailwind v4 projects, that import also registers FramingUI's packaged utility sources and the tailwindcss-animate plugin hook.
Then mount FramingUIProvider near your root layout. Pass a full theme object when you want FramingUI to inject the CSS variables for you.
import {
FramingUIProvider,
Button,
Card,
CardContent,
CardHeader,
CardTitle,
Input,
} from '@framingui/ui';
import theme from './neutral-workspace.json';
export function App() {
return (
<FramingUIProvider theme={theme}>
<Card>
<CardHeader>
<CardTitle>Create account</CardTitle>
</CardHeader>
<CardContent>
<Input type="email" placeholder="Email" />
<Button>Create account</Button>
</CardContent>
</Card>
</FramingUIProvider>
);
}If your app already loads theme CSS separately, you can use the provider just to keep data-theme in sync:
import { FramingUIProvider } from '@framingui/ui';
export function App() {
return <FramingUIProvider themeId="neutral-workspace">{/* app */}</FramingUIProvider>;
}What You Get
- core components such as
Button,Input,Card,Badge,Avatar, andSelect - complex components such as
Dialog,Tabs,Table, andPopover - advanced components such as
Sidebar,NavigationMenu, andCalendar - styles designed to work with FramingUI themes and MCP workflows
MCP Guidance
If you are using FramingUI through MCP, do not guess component APIs. Use:
list-componentspreview-componentvalidate-environment
Docs
License
MIT
