https://github.com/ihiutch/uswds-tailwind
Build federal websites and applications faster than ever with the speed and flexibility of modern tooling.
https://github.com/ihiutch/uswds-tailwind
design-system javascript lightningcss parceljs tailwindcss uswds
Last synced: about 1 month ago
JSON representation
Build federal websites and applications faster than ever with the speed and flexibility of modern tooling.
- Host: GitHub
- URL: https://github.com/ihiutch/uswds-tailwind
- Owner: IHIutch
- License: mit
- Created: 2023-08-03T02:15:44.000Z (almost 3 years ago)
- Default Branch: next
- Last Pushed: 2026-02-22T19:31:39.000Z (3 months ago)
- Last Synced: 2026-02-23T00:25:08.312Z (3 months ago)
- Topics: design-system, javascript, lightningcss, parceljs, tailwindcss, uswds
- Language: TypeScript
- Homepage: https://uswds-tailwind.com
- Size: 10.1 MB
- Stars: 28
- Watchers: 2
- Forks: 3
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# USWDS + Tailwind
USWDS components for Tailwind CSS, available as React components or vanilla JS modules. Built on top of [zag-js](https://zagjs.com/) state machines for accessible, headless behavior.
> [!NOTE]
> This project is currently in **alpha**. APIs may change between releases.
## Documentation
Full guides, component API, and examples live at [uswds-tailwind.com](https://uswds-tailwind.com).
## Packages
| Package | Description |
|---|---|
| [`@uswds-tailwind/react`](./packages/react) | React component library |
| [`@uswds-tailwind/compat`](./packages/compat) | Drop-in vanilla JS modules |
| [`@uswds-tailwind/theme`](./packages/theme) | Tailwind v4 theme with USWDS design tokens |
| [`@uswds-tailwind/-compat`](./packages/machines) | Headless zag-js state machines (one per component) |
## Repository structure
- `apps/docs/`: Astro documentation site at [uswds-tailwind.com](https://uswds-tailwind.com)
- `packages/react/`: React component library + Storybook
- `packages/compat/`: vanilla JS bundle
- `packages/theme/`: Tailwind v4 theme
- `packages/machines/`: per-component zag-js state machines
- `examples/`: minimal example projects
## Local development
Requires [Node.js](https://nodejs.org/) (see [`.nvmrc`](./.nvmrc)) and [pnpm](https://pnpm.io/).
```bash
git clone https://github.com/IHIutch/uswds-tailwind.git
cd uswds-tailwind
pnpm install
pnpm build:packages
```
Common scripts (run from the repo root):
| Script | What it does |
|---|---|
| `pnpm build:packages` | Build all publishable packages |
| `pnpm build:website` | Build the docs site |
| `pnpm lint` | Run ESLint across the monorepo |
| `pnpm lint:publish` | Run [publint](https://publint.dev) on every package |
| `pnpm typecheck` | Run TypeScript across packages |
| `pnpm test` | Run package tests |
| `pnpm --filter website dev` | Start the docs dev server |
| `pnpm --filter @uswds-tailwind/react storybook` | Start Storybook |
## Contributing
Contributions are welcome. See [CONTRIBUTING.md](./CONTRIBUTING.md) for branching, conventional commits, changesets, and PR conventions.
## Community
- [GitHub Issues](https://github.com/IHIutch/uswds-tailwind/issues) for bug reports and feature requests
- [GitHub Discussions](https://github.com/IHIutch/uswds-tailwind/discussions) for questions and ideas
- [Code of Conduct](./CODE_OF_CONDUCT.md)
- [Security policy](./SECURITY.md)
## License
[MIT](./LICENSE)