Skip to main content
Glama
README.md
# labsUI

Clean, composable React components with one smooth spring for every motion.
Hand-made, accessible, and copied into your project so you own the code.

[Docs and live demos](https://kznlabs.github.io/labsUI) ·
[npm](https://www.npmjs.com/package/@kznlabs/labsui) ·
[JSR](https://jsr.io/@kznlabs/labsui) ·
[MCP registry][mcp-registry] ·
[Glama][glama]

[![Chromium][chromium]](#accessibility-and-browsers)
[![Firefox][firefox]](#accessibility-and-browsers)
[![WebKit][webkit]](#accessibility-and-browsers)
[![WCAG 2.2 AA][wcag]](#accessibility-and-browsers)
[![MCP server score on Glama][glama-score]][glama]

<a href="https://kznlabs.github.io/labsUI">
  <picture>
    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/kznlabs/labsUI/hero/hero-dark.gif">
    <img
      src="https://raw.githubusercontent.com/kznlabs/labsUI/hero/hero-light.gif"
      width="720"
      alt="The labsUI site, then the CLI building an app from its components"
    >
  </picture>
</a>

## Why labsUI

- **One spring.** Every animation shares
  `{ type: "spring", stiffness: 400, damping: 30 }`, so the whole UI moves the
  same way. Reduced motion is respected everywhere.
- **You own the code.** `npx @kznlabs/labsui add` writes plain TSX into your
  repo. No runtime package to upgrade around, edit anything.
- **Accessible by default.** WAI-ARIA patterns, full keyboard support, and WCAG
  AA contrast in light and dark mode for all eight accent colors.
- **Server-friendly.** Many components are server-safe, and form controls use
  native validation, so forms work without JavaScript and with Server Actions.
- **80+ components and blocks.** Inputs, overlays, navigation, data display,
  charts, motion helpers, and ready-made blocks like pricing, site header and
  changelog.

[Why labsUI](https://kznlabs.github.io/labsUI/why) has more, including when it
is not a fit.

## Accessibility and browsers

CI runs an automated sweep on pull requests (the pages a change reaches) and
daily (everything): all component pages, light and dark, at 390 px and
1280 px, in three browser engines. The badges show the latest full run on
`main`.

| Check                                         | Required             |
| --------------------------------------------- | -------------------- |
| WCAG 2.2 A + AA rules (axe)                   | 0 violations         |
| JavaScript errors                             | none                 |
| Sideways page overflow                        | none                 |
| Every control reachable by a click            | pass                 |
| Scroll containers move under the wheel        | pass                 |
| Menus, popovers, tabs, sliders, Escape, focus | pass                 |
| Pointer targets                               | 24 × 24 px or larger |
| Text contrast, both themes                    | 4.5:1 or higher      |

| Engine   | Covers                                | Status                |
| -------- | ------------------------------------- | --------------------- |
| Chromium | Chrome, Edge, Brave, Opera, Opera GX  | ![Chromium][chromium] |
| Gecko    | Firefox                               | ![Firefox][firefox]   |
| WebKit   | Safari (macOS); iOS shares the engine | ![WebKit][webkit]     |

[chromium]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fkznlabs%2FlabsUI%2Fbadges%2Fchromium.json
[firefox]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fkznlabs%2FlabsUI%2Fbadges%2Ffirefox.json
[webkit]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fkznlabs%2FlabsUI%2Fbadges%2Fwebkit.json
[wcag]: https://img.shields.io/endpoint?url=https%3A%2F%2Fraw.githubusercontent.com%2Fkznlabs%2FlabsUI%2Fbadges%2Fwcag.json
[mcp-registry]: https://registry.modelcontextprotocol.io/v0.1/servers?search=io.github.kznlabs/labsui
[glama]: https://glama.ai/mcp/servers/kznlabs/labsUI
[glama-score]: https://glama.ai/mcp/servers/kznlabs/labsUI/badges/score.svg

Minimum versions come from Tailwind CSS v4: Chrome 111, Safari 16.4,
Firefox 128. Two features enhance where supported and fall back cleanly:
styled select popups (`appearance: base-select`, Chromium and newer Safari;
elsewhere the native list) and auto-growing textareas (`field-sizing`; a
resize handle in Firefox).

Automated checks find many problems, not all: axe covers roughly half of the
WCAG criteria, so this is not a full conformance audit. Not yet covered:
screen reader passes, real phones (iOS Safari, Android Chrome), Samsung
Internet and other less common browsers.

## Quick start

Requires React 19, Tailwind CSS v4 and a `@/*` path alias in `tsconfig.json`.
The CLI runs on Node.js 22 or newer, or Deno.

```sh
npx @kznlabs/labsui init               # styles, theme, utils, motion provider
npx @kznlabs/labsui add button dialog  # components plus everything they import
npx @kznlabs/labsui search date range  # find by name, export or intent
npx @kznlabs/labsui view dialog        # exact props, examples, what it installs
npx @kznlabs/labsui doctor             # check the setup, with a fix for each problem
```

Any package manager works: `bunx`, `pnpm dlx`, `yarn dlx` and
`deno run -A jsr:@kznlabs/labsui` too, and npm packages install with whichever
one your lockfile shows. Bun is recommended: labsUI is built with it.
See the [CLI reference](packages/cli/README.md) for every option.

Coding agents get the same through `npx @kznlabs/labsui mcp`, an MCP server
with search, view, add, init, diff, update and doctor tools plus the
library's coding rules, or through `--json` on any command. It's listed in the
[MCP registry][mcp-registry] as `io.github.kznlabs/labsui` and on
[Glama][glama]:

```json
{
	"mcpServers": {
		"labsui": { "command": "npx", "args": ["-y", "@kznlabs/labsui", "mcp"] }
	}
}
```

Agents that share no workspace, such as Claude Desktop, also need
`"--cwd", "/path/to/app"` after `"mcp"`
([setup](packages/cli/README.md#mcp-server)).

```tsx
import { Button } from "@/components/ui/button";

export function DeleteButton({ onDelete }: { onDelete: () => void }) {
	return (
		<Button variant="destructive" confirmLabel="Yes, delete" onClick={onDelete}>
			Delete
		</Button>
	);
}
```

## What's inside

| Group               | Examples                                                                    |
| ------------------- | --------------------------------------------------------------------------- |
| Actions & inputs    | Button, Field, Select, Combobox, Date picker, Slider, OTP, Tag input        |
| Overlays & feedback | Dialog, Drawer, Popover, Dropdown and context menus, Command palette, Toast |
| Navigation          | Tabs, Sidebar, Navigation menu, Breadcrumb, Pagination, Table of contents   |
| Data display        | Table, Data table, Chart, Carousel, Timeline, Code, Terminal                |
| Layout              | Card, Accordion, App window, Resizable panels, Scroll area                  |
| Motion              | Reveal, Count to, Typewriter, Text swap, Custom cursor                      |
| Blocks              | Pricing, Site header, Post card, Product card, Cart, Comparison table       |

Theming is built on OKLCH tokens with light and dark mode and eight accent
presets, or your own hue through `--accent-hue`.

## Development

labsUI is built with [Bun](https://bun.sh), and the repo scripts run on it, so
install Bun to work on the library itself.

```sh
bun install
bun dev                     # docs site with every component
bun run lint                # Biome
bun run typecheck           # also rebuilds the registry and API docs
bun run check-dead-code     # Knip
bun test                    # unit tests for helpers and the CLI
bunx markdownlint-cli2      # Markdown
```

The docs site deploys from `main` to GitHub Pages. A `cli-v<version>` tag
publishes the CLI to npm and JSR.

## License

[MIT](LICENSE)

TDQS

A4.6/5.0

Scored across 7 tools

Disambiguation5/5

Each tool owns a distinct lifecycle step: init sets up, add installs new items, update upgrades installed ones, search finds names, view reads docs, diff compares, doctor checks health. The descriptions explicitly cross-reference each other (e.g. add says 'to bring installed items to a newer version, use update instead'), resolving the only potential overlaps between add/update and diff/doctor.

Naming Consistency5/5

All seven tools are single lowercase words with no mixed casing or verb/noun style drift, matching a conventional CLI subcommand grammar. The lone noun ('doctor') is a standard CLI idiom and reads consistently with the rest.

Tool Count5/5

Seven tools is well-scoped for a component-registry CLI, with no redundant or filler entries. Each tool corresponds to a genuine workflow stage an agent would need.

Completeness4/5

The surface covers setup, discovery, inspection, installation, upgrade, diffing and diagnostics, which is close to full lifecycle coverage. The notable gap is removal: there is no uninstall/remove tool for taking items back out, and no dedicated way to enumerate only installed items, though diff partially surfaces them.

Maintenance

ActivityMaintained
ResponsivenessNo recent community issues