API

Everything the three packages export. Each entry links to the page that explains it.

`@ramonda/core`

Classes


`Component<P>`	The base class. Extend it and implement `render()`.
`Hook<O>`	State and lifecycle with no element.
`Ref<T>` / `createRef<T>()`	Holds a real DOM node. Refs
`list<T>(options)`	Renders a list, minting identity from the items. Lists
`Head`	Per-page `<title>` and `<meta>`. Head and metadata
`AsyncLoad`	Loads a module the first time it is rendered. Lazy loading
`ErrorBoundary`	Catches what a subtree throws while rendering. Error boundaries
`createContext(default, options?)`	Returns `[Provider, Consumer]`. Context

Entry points


`bootstrap(vnode, element)`	Mounts an app.
`unmount(element)`	Tears down everything `bootstrap` mounted, running `@destroy` throughout. Removing the element is not a substitute.
`h(tag, props, ...children)`	What JSX compiles to. Callable directly for a tag that is a value. JSX

Server rendering


`renderToString(vnode)`	An app → HTML, awaiting async lifecycle. Details
`renderPage(vnode)`	The same, plus `{ title, head }`. Head
`renderDocument(page, options?)`	Wraps a rendered page in a complete document. Static builds
`hydrateRoot(vnode, element)`	Adopts the server's DOM instead of rebuilding it.

Decorators — state


`@state`	Turns a field into a signal. State
`@compute`	Caches a derived value; method or getter. Derived values
`@persist`	Marks a non-reactive field as part of the hydration payload. env
`@memoizedHandler`	Caches a function by its arguments, per instance.

Decorators — lifecycle


`@create(options?)`	Runs while building; no DOM yet. Lifecycle
`@mount(options?)`	Runs once the element is in the document. Returning a promise makes a server render wait. Async on the server
`@destroy`	Runs on teardown, while state is still readable.
`@effect`	After the commit, and again when a signal it read changes. Return a cleanup. Effects

All three lifecycle decorators take { env: "client" | "server" | "shared" }. Which to use

Decorators — reacting


`@watchProp(selector)`	Runs when one prop changes, before the render. Props
`@shouldUpdateProps`	Decides whether a prop change should re-render.
`@deferHydration`	Keeps the server's markup while a promise settles. Async on the server

Decorators — the DOM


`@Host(tag, props?)`	The element a component is. `tag` may be a callback of props. The host element
`@onElement(type, options?)`	Listener on the component's host. Events
`@onWindow(type, options?)` / `@onDocument(...)`	Listeners on `window` / `document`. Work on a Hook too.
`@interval(ms)` / `@timeout(ms)`	Timers cleared on unmount. Timers

Building your own


`createSubscriptionDecorator(name, connect, validate?)`	Turns "subscribe, and unsubscribe on unmount" into a decorator. Your own decorators

Types

VNode · RamondaNode · ComponentChild · ComponentClassKind · RenderedPage · DocumentOptions · HeadOptions · MetaTag · LinkTag · ListOptions · AsyncLoadProps · AsyncLoadFailure · Lazy · RefCallback · RefTarget · ContextOptions · SubscriptionOwner · Disconnect

`@ramonda/router`


`Router`	A hook on the app root; owns the store, adds no element. Setup
`RouteOutlet`	Renders the matched route.
`RouteHook`	`pathname` · `params<T>()` · `searchParams` · `hashTags` · `push` · `replace` · `back` · `forward`. Reading the URL
`Link`	A real `<a href>` that intercepts a plain left click. Links
`createRoutes(map)`	Compiles a route table once. Call it at module scope.
`routePaths(config, extra?)`	`{ paths, needsData }` for a static build. Static builds
`matchRoute` · `matchParams` · `matchCompiled`	Matching, for tooling.
`parseUrl` · `parseUrlString` · `buildUrl` · `sanitizeHref`	URL helpers.

Types: RouteConfig · RouteParams · RoutePaths · RouterState · RouterNavigator · NavigateOptions · HashTag · StateUpdater · RouteOutletProps · LinkProps

`@ramonda/lens`

Immutable updates by path. Zero dependencies, usable on its own. Immutable updates


`focusOn(root)`	Starts a path into `root`. Nothing runs until a terminal operation does.

Walking — details


`.get(key)`	Descends into a property. Creating an absent key is allowed at the end of a path.
`.at(index)`	Descends into one element. Negative counts from the end.
`.where(pred)`	Descends into every element the predicate accepts. Narrow explicitly: `where<T>(…)`.

Writing — each returns the new root. Details


`.set(value)`	Replaces the focused value. An equal value copies nothing.
`.update(fn)`	Replaces it with `fn(current)`.
`.merge(partial)`	Copies the focused object and assigns over it.
`.remove()`	Drops the property or element from its container.
`.push(...items)`	Appends to the focused array.
`.insert(i, ...items)`	Inserts at a position. `i === length` appends.
`.and(...branches)`	Forks the path: several edits, one walk of the shared prefix.

Reading


`.value()`	The first focused value, or `undefined`.
`.values()`	Every focused value.

Types: Focus · FocusCommon · FocusArray · ElementOf

`@ramonda/testing-library`


`render(ui, options?)`	Mounts and returns the DOM plus bound queries. Rendering
`renderHook(hook, options?)`	Mounts a hook on a throwaway host. Testing hooks
`act(callback?)`	Commits everything the callback caused. act
`fireEvent`	The DOM library's, wrapped so the render is committed.
`cleanup()`	Unmounts everything. Registered automatically.

Everything from @testing-library/dom is re-exported — screen, waitFor, within, prettyDOM, every query.

`@ramonda/core/testing`

A separate entry point, for building a test harness rather than for apps.


`flushSync()`	Runs every pending update and mount now.
`rerenderRoot(vnode, container)`	Diffs new JSX into an already-rendered container.
`getComponentInstance(node)`	The component a DOM node belongs to.

It exists so index.ts does not have to be widened for a test utility — the same shape as react-dom/test-utils.