Getting Started
Set up the component library with Tailwind CSS using Vite.
Setup
Create a TypeScript project with Vite, enter the project directory, and install its dependencies:
Terminal window npm create vite@latest my-project -- --template react-tscd my-projectnpm installInstall USWDS + Tailwind, Tailwind CSS, and Tailwind’s Vite plugin:
Terminal window npm install @uswds-tailwind/react@latestnpm install -D tailwindcss @tailwindcss/viteConfigure project
Vite
Add the Tailwind CSS plugin in
vite.config.ts:vite.config.ts import react from '@vitejs/plugin-react'import tailwindcss from '@tailwindcss/vite'import { defineConfig } from 'vite'export default defineConfig({plugins: [react(), tailwindcss()],})CSS
Replace
src/index.csswith the Tailwind CSS and USWDS + Tailwind imports:src/index.css @import 'tailwindcss';@import '@uswds-tailwind/react';Import the stylesheet from
src/main.tsx:src/main.tsx import './index.css'Component
Add a USWDS + Tailwind button to
src/App.tsx:src/App.tsx import { Button } from '@uswds-tailwind/react/button'export default function App() {return (<main className="mx-auto max-w-prose p-6 font-source-sans"><h1 className="mb-6 text-3xl font-bold">Hello, USWDS + Tailwind!</h1><Button>Button</Button></main>)}Complete!
Run
npm run devand open the local URL Vite prints. You should see the button styled with USWDS + Tailwind.When you’re ready to deploy, run
npm run buildand publish the generateddistdirectory.