Skip to content
Entropy UI
DocsGetting StartedIntroduction

Introduction

What Entropy UI is and how this repository is organised.

What this is

Entropy UI is a set of open-source React components for data-heavy apps: tables, filters, metrics, charts, log streams, feedback boards and form flows. They are built on shadcn/ui conventions and distributed as a shadcn registry, so you install a component and own its code.

Layers

Library source never imports documentation code. src/components/ui is what the CLI copies into your project; everything else exists to document it.

Repository layout

src/components/ui     component source (distributed)
src/styles/strata.css design tokens (distributed as the "tokens" item)
src/lib/appearance.tsx runtime theming provider (distributed)
src/examples          runnable examples, shown as preview and source
src/content           MDX documentation
src/docs/catalog.json docs navigation and metadata
registry.json         shadcn registry definition

Add a component

  1. Add the component at src/components/ui/my-component.tsx.
  2. Add examples under src/examples/my-component/ (default-export a React component).
  3. Add src/content/components/my-component.mdx.
  4. Add one entry to src/docs/catalog.json and one item to registry.json.

No new route is needed. Run npm run check:project to catch broken references.

Where next

Start with Installation, then read Theming to see how density, accent and borders are controlled at runtime.