API Reference

The v0.44.0-beta.1 current line documents only the five consumer packages. Retired alpha packages and internal subpaths are not authoring surfaces.

01 / interface rule

Authoring starts at product packages.

Current documentation, starters and dogfood use the five supported interfaces. Loader, action and form semantics are frozen at 0.42.0 (ADR-0122); framework session, active cache and streaming are outside the current contract and have no assigned version.

02 / supported surface

Five products, one application path.

Each package owns a distinct consumer decision; absorbed implementation packages remain private.

@openelement/adapter-vite@openelement/adapter-vite

The official Vite, content, static-build and Nitro output adapter.

Use `buildApp()` or the generated build task.Plugin ordering, manifests and content scans are adapter implementation details.

rootcli/buildcli/startnitro-mountsitemap

BUILD

@openelement/app@openelement/app

The application surface for pages, routes, islands and request/render semantics.

Use `definePage`, `defineIslandConfig` and `defineApp` for application authoring.The router and request-driver implementation are internal product knowledge.

rootmodelpreactspa

CORE

@openelement/create@openelement/create

The installed starter and zero-context consumer entrypoint.

Generated projects expose `dev`, `check`, `test`, `build`, `start` and `preview`.The starter imports product packages only.

root

BUILD

@openelement/element@openelement/element

The supported Custom Element authoring surface for JSX, DSD, hydration, signals and styles.

Start here for standalone element authoring.Author compiled elements as `@element`-decorated `OpenElement` classes with `@property` state; `StyleSheet` and signal helpers come from the same root.@experimental additions: the `element`/`property` decorator intrinsics (#1209) and the dangerous-key guards `isDangerousKey`, `injectPropsSafe`, `DANGEROUS_KEYS` (#1214).

rootbuild-utilsjsx-dev-runtimejsx-runtimesanitize

CORE

@openelement/ui@openelement/ui

Optional primitives retained only when they have demonstrated reusable behavior.

UI is not required to use OpenElement.Website-specific brand, hero, lab and layout artifacts are not UI package contracts.

rootopen-badgeopen-buttonopen-callout+8 more

OPTIONAL