uf0.44.0

Type to search every page and heading. Page titles only, while the full index loads.

All pages

Readiness: Implemented

Reference

Reference

Look up command flags, configuration defaults and package APIs. For step-by-step instructions, use the guides.

Most read

Find an API

TopicReference
Commands, flags and exit codesCLI
Project settings and defaultsuf.config.js
What each lint rule reports, with examplesLint rules
Package exports and publication statusPackages
Component parts and keyboard controlsComponents
Browser hooks and server renderingBrowser hooks
Effect APIsEffect API
Messages and localesInternationalisation
Standard library modulesStandard library

All reference pages

  1. CommandsEvery subcommand, flag and exit code.
  2. uf.config.jsEvery option, its default, and what reads it.
  3. Lint rulesEvery rule uf lint runs, with an example it reports and one it accepts.
  4. APIEvery export of every published package: its signature, its doc comment, and the specifier it is imported from.
  5. PackagesWhat each @uniflowed/* package is for.
  6. ComponentsEvery StyleX component uf ui add writes, then the headless parts and the keys each one owns.
  7. Standard libraryThe Go standard library modules JavaScript does not have, and the measurements behind why they are JavaScript.
  8. Browser hooksWhat each one renders before hydration, and how the ones with no server answer say so.
  9. Effect APITyped failures, fibers that own what they start, and what Flow cannot say.
  10. 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