Reference

Information-oriented API reference.

Component API → Storybook

This is a TypeScript/React library, so the authoritative component reference is Storybook — it renders each component's props, variants, and live interactive examples straight from the source *.stories.tsx files, so it can't drift from the code. (The Python mkdocstrings autodoc tool used elsewhere in AltaForge does not apply to a TypeScript codebase.)

Run it from the repo root:

npm run storybook

Then open http://localhost:6006. Build a static bundle with npm run build-storybook (output is gitignored under storybook-static/).

Component sources and their stories live in src/components/ (and src/maps/ for the Leaflet map components). Edit a component's *.stories.tsx to extend its reference.

Package exports

The library ships these entry points (see the README for import order and peer dependencies):

Entry point	Contents
altaforge-ui	top-level barrel
altaforge-ui/themes	Radix theme and layout primitives
altaforge-ui/components	custom components (AppShell, DataGrid, DatePicker, MultiSelect, StatCard, DataVisualCard, …)
altaforge-ui/charts	Chart.js setup and types
altaforge-ui/maps	Leaflet map components

TypeDoc (optional, future)

If a static, browsable API reference is wanted alongside Storybook, TypeDoc can generate one from the TypeScript types and TSDoc comments. It is not wired up today; Storybook is the reference of record. If added, generate into docs/reference/ and link it from here.