Getting Started
Get up and running with Cookest UI in under 5 minutes. Install the package, set up your project, and build your first component.
Prerequisites
Setup Guide
Install the package
Install @cookest/ui using your preferred package manager:
$ bun add @cookest/uiImport the styles
Import the Cookest UI stylesheet in your global CSS file or app entry point. This provides all design tokens and component styles.
/* globals.css or app entry */
@import "@cookest/ui/src/styles.css";If you use Tailwind CSS, import it alongside your Tailwind directives:
@import "tailwindcss";
@import "@cookest/ui/src/styles.css";Use a component
Import components from @cookest/ui and use them in your JSX. All components are tree-shakable.
import { Button, Card, CardBody, Badge } from "@cookest/ui";
export function RecipeCard() {
return (
<Card variant="interactive">
<CardBody>
<Badge variant="success" dot>Healthy</Badge>
<h3>Pasta Primavera</h3>
<p>Fresh vegetables in a light garlic sauce.</p>
<Button variant="primary" size="sm">
View Recipe
</Button>
</CardBody>
</Card>
);
}Run your app
Start the development server and see your component in action:
bun devYour First Component
Here is the recipe card from Step 3, rendered live with Cookest UI:
Pasta Primavera
Fresh seasonal vegetables tossed in a light garlic and olive oil sauce with al dente penne pasta.
Dark Mode Support
Cookest UI includes built-in dark mode. Add the dark class to your <html> element and all CSS variables automatically switch to their dark variants. Try the toggle in the sidebar to see it in action!