API Reference

The complete API reference is generated from TypeScript sources using TypeDoc.

Viewing the API Reference

Online

The hosted API reference is available at the documentation site under /api/reference/.

• Open API reference

Local Build

Generate the API documentation locally:

npm run docs:api

The output is written to out/typedoc/index.html.

Alternatively, build the complete documentation site:

npm run docs:build

The API reference is included at out/site/api/reference/index.html.

Quick Reference

For the most common APIs, see:

• Widget Catalog - All widget types and props
• @rezi-ui/core - Core package exports
• @rezi-ui/node - Node.js backend