banhatten-ui
v0.2.0
Published
Banhatten Design System - React component library with token-based theming
Maintainers
Readme
banhatten-ui
Banhatten Design System - React component library with token-based theming.
Installation
npm install banhatten-uiRequirements
- React 19+ (
react@^19.0.0andreact-dom@^19.0.0) - Tailwind CSS v4
Setup
1. Configure Tailwind CSS
Add the Banhatten tokens to your tailwind.config.ts:
import type { Config } from "tailwindcss";
import banhattenConfig from "banhatten-ui/tokens/tailwind.config";
const config: Config = {
presets: [banhattenConfig],
content: [
"./src/**/*.{js,ts,jsx,tsx}",
"./node_modules/banhatten-ui/dist/**/*.{js,mjs}",
],
};
export default config;2. Import Components
import { Button, Input, Badge } from "banhatten-ui";
export function MyComponent() {
return (
<>
<Button variant="primary" size="md">Submit</Button>
<Input label="Email" preset="email" />
<Badge variant="filled" color="brand">New</Badge>
</>
);
}Exports
- Components:
import { Button, Input, ... } from "banhatten-ui" - Utils:
import { cn } from "banhatten-ui/lib/utils" - Tokens JSON:
import tokens from "banhatten-ui/tokens" - Tailwind Config:
import config from "banhatten-ui/tokens/tailwind.config"
Documentation
Visit the documentation site for component API reference and examples.
