Readiness: Implemented
Reference
Reference
Look up command flags, configuration defaults and package APIs. For step-by-step instructions, use the guides.
Most read
- Start hereCommandsEvery subcommand, flag and exit code.
- uf.config.jsEvery option, its default, and what reads it.
- APIEvery export of every published package: its signature, its doc comment, and the specifier it is imported from.
- PackagesWhat each @uniflowed/* package is for.
- Standard libraryThe Go standard library modules JavaScript does not have, and the measurements behind why they are JavaScript.
Find an API
| Topic | Reference |
|---|---|
| Commands, flags and exit codes | CLI |
| Project settings and defaults | uf.config.js |
| What each lint rule reports, with examples | Lint rules |
| Package exports and publication status | Packages |
| Component parts and keyboard controls | Components |
| Browser hooks and server rendering | Browser hooks |
| Effect APIs | Effect API |
| Messages and locales | Internationalisation |
| Standard library modules | Standard library |
All reference pages
- CommandsEvery subcommand, flag and exit code.
- uf.config.jsEvery option, its default, and what reads it.
- Lint rulesEvery rule uf lint runs, with an example it reports and one it accepts.
- APIEvery export of every published package: its signature, its doc comment, and the specifier it is imported from.
- PackagesWhat each @uniflowed/* package is for.
- ComponentsEvery StyleX component uf ui add writes, then the headless parts and the keys each one owns.
- Standard libraryThe Go standard library modules JavaScript does not have, and the measurements behind why they are JavaScript.
- Browser hooksWhat each one renders before hydration, and how the ones with no server answer say so.
- Effect APITyped failures, fibers that own what they start, and what Flow cannot say.
- InternationalisationMessageFormat 2 with typed arguments, the subset uf implements, and where the type system stops.
For examples, see Build an app, The toolchain or Targets.
Edit this pagedocs/app/reference/$page.mdx