# `@iamsaroj/smart-ui` documentation

Consumer guides for each public entrypoint, the architecture decision records,
and a component → demo route map. For the architecture overview see
[`CLAUDE.md`](../CLAUDE.md); for the audit trail see [`report.md`](../report.md).

## Domain guides

Each guide follows the same skeleton: **What it is → Import → 80% example → Key
props → Escape hatches → Gotchas → Demo route.**

| Guide                                        | Entrypoint                                                          |
| -------------------------------------------- | ------------------------------------------------------------------- |
| [form.md](./form.md)                         | `@iamsaroj/smart-ui/form`                                           |
| [data-grid.md](./data-grid.md)               | `@iamsaroj/smart-ui/data-grid`                                      |
| [search.md](./search.md)                     | `@iamsaroj/smart-ui/search`                                         |
| [tree.md](./tree.md)                         | `@iamsaroj/smart-ui/tree`                                           |
| [transfer-list.md](./transfer-list.md)       | `@iamsaroj/smart-ui/transfer-list`                                  |
| [calendar.md](./calendar.md)                 | `@iamsaroj/smart-ui/calendar`                                       |
| [text-editor.md](./text-editor.md)           | `@iamsaroj/smart-ui/text-editor`                                    |
| [smart-components.md](./smart-components.md) | `@iamsaroj/smart-ui/smart-components/*` (incl. `/page`, `/buttons`) |

## Other references

- [security.md](./security.md) — sanitize contract, export formula guard, CSP.
- [component-map.md](./component-map.md) — every exported component/engine → demo route → doc.
- [adr/](./adr/) — architecture decision records.

## Keeping docs honest

- **Consistency check** (`scripts/check-docs.mjs`, run in CI): every public
  subpath in `packages/ui/package.json` `exports` must map to a guide listed in
  the table above. A new engine entrypoint ships **failing** CI until it is
  documented here.
- **Snippet type safety:** the non-trivial code samples live typed in
  [`snippets.test-d.ts`](./snippets.test-d.ts) and are compiled with `tsc --noEmit`
  (via `docs/tsconfig.json`) by the same check — a doc example that stops
  type-checking fails CI. (Chosen as the lighter mechanism over a full doc
  extractor.)