Guide
The guide is organised by what you are trying to do. If you are starting out, the Learn path is a better entry point — it introduces the same material one idea at a time.
Start here
Four pages carry most of the weight. Reading them in this order is worth an afternoon:
- The mental model — the principles the API follows and the guarantees they provide
- Which primitive should I use? — the five-way decision you make constantly
- Anatomy of a primitive — the shape all five share
- Generators and
yield*— the tracking channel everything is built on - Insertions — how behaviour is composed
Project setup
Create a CraftTS project — interactive and non-interactive starters, configuration options, and first checks
By topic
Managing state
Local state · State machines · query · Mutations · queryParams · asyncProcess · Collections · Persistence · Selecting · Reacting to mutations · Schema validation
Structuring the app
craftService · Service scopes · Shaping the public API · Abstract services · App start · Lazy services
Recommended approaches
Routing and type-safe DI
Setup · CLI automation · ESLint rules · Route providers · Guards · Exception handling · Pending UI · Route load errors · Scaling routes
Components and templates
Components · Fine-grained reactivity · Progressive forNode · Directives and .pipe(...) · Customization · Content projection · Styling a component · Accessibility
Forms
Overview · Validators · Submitting · Nested forms
Testing
Services · Components · Type-level tests · Browser boundaries · Architecture rules · Craft graph vs Nx
Reactivity utilities
craftComputed · craftEffect · craftMethod · source$ · on$
Going further
SSR and hydration · Program operators · Pattern matching · Observability
AI agents
AI agents overview · Coding agents · MCP tools · Live page MCP · Send context to AI
Looking for one symbol?
The API index lists every export with a one-line description.