[!WARNING] The design system is still a work in progress so you can expect some breaking changes.

Getting Started

Install ljkui:

$ bun add ljkui

Import the global CSS file at the root of your application:

import 'ljkui/styles.css';

[!NOTE] Using Tailwind? Import styles.css into the ljkui layer, or the global reset flattens every heading. See the Installation & Layers guide in the docs. In development, <Theme> warns in the console if it detects this.

Add the Theme component:

import { Theme } from 'ljkui';

export default function () {
  return (
    <html>
      <body>
        <Theme>
          <MyApp />
        </Theme>
      </body>
    </html>
  );
}

For AI agents

ljkui ships the docs an agent needs to use it, inside the package.

TanStack Intent skills — skills/getting-started, skills/components, skills/forms. Agents that support Intent load these automatically from node_modules/ljkui/skills/*/SKILL.md.

Cheatsheet — node_modules/ljkui/dist/llms.txt, also at https://ljkui.vercel.app/llms.txt. One page: setup, the rules that break things when ignored, and every component with the exact values each prop accepts.

Everything — dist/llms-full.txt / https://ljkui.vercel.app/llms-full.txt. All the guides, plus a working code example for every component.

All of it is generated from the source at build time (scripts/gen-llms-txt.ts), so it cannot drift from the real API.