API reference · Veloz

Reactivity

Function	Description
`createSignal(value, options?)`	`[get, set]`. `options.equals`: comparison or `false` to always notify.
`createMemo(fn, initial?, options?)`	Cached derived value; notifies only when the result changes.
`createEffect(fn, initial?)`	Runs now and whenever what it read changes; receives the previous return value.
`createRenderEffect(fn, initial?)`	Same scheduling as `createEffect`; used for DOM updates.
`batch(fn)`	Runs `fn` and flushes effects once at the end; returns `fn`'s result.
`untrack(fn)`	Reads signals in `fn` without subscribing.
`on(deps, fn, { defer }?)`	Explicit dependencies (a getter or an array); `fn` runs untracked.
`createRoot(fn)`	A scope not disposed with its parent; `fn` receives `dispose`.
`onCleanup(fn)`	Runs before the owner re-runs and when it is disposed.
`onMount(fn)`	Runs once after the component is created, inside its owner.
`catchError(fn, handler)`	Sends errors from `fn` and from computations created in it to `handler`.
`createContext(default?)` / `useContext(ctx)`	Dependency injection through the owner tree.
`access(value)`	Calls `value` if it is a function (for `MaybeAccessor<T>` props).
`getCurrentOwner()` / `runWithOwner(owner, fn)`	Low-level access to ownership.

Function	Description
`createResource(fetcher, options?)`	Async value; fetches once.
`createResource(source, fetcher, options?)`	Fetches when `source` is set and whenever it changes.
`resource()`	Value, or throws the last error.
`resource.state` / `.loading` / `.error` / `.latest`	Reactive status.
`{ mutate, refetch }`	Set the value locally; load again.
`options.initialValue` / `options.name`	Start ready with a value; stable key for SSR hand-off.

Export	Description
`render(fn, container)`	Renders into `container`, replacing its content; returns a disposer.
`hydrate(fn, container)`	Attaches to server-rendered HTML in `container`; returns a disposer.
`createElement(tag, props, ...children)`	JSX without a compiler.
`Fragment`	`<>…</>`
`toNodes(value)`	Resolves anything renderable into DOM nodes.
`sanitize(html, options?)`	Allowlist HTML sanitizer (`allowedTags`, `allowedAttrs`).
`sanitizeURL(url)` / `validateAttribute(name, value)`	The URL and attribute checks used by the renderer.

Component	Props
`Show`	`when`, `fallback?`, `children` (nodes or `(value) => nodes`)
`For`	`each`, `fallback?`, `children: (item, index) => nodes`
`Switch` / `Match`	`Switch`: `fallback?`; `Match`: `when`, `children`
`ErrorBoundary`	`fallback` (nodes or `(error, reset) => nodes`), `children`
`Suspense`	`fallback?`, `children`
`Portal`	`mount?` (default `document.body`), `children`
`Dynamic`	`component` (tag name or component), other props passed through

Export	Description
css`…`	Scoped class name from a CSS block.
styled(tag)`…`	Component with styles; interpolations receive props.
`css={{…}}` prop	Enabled by importing `@velozjs/css`.
`getSSRStyles()`	Styles collected on the server (also returned by `renderToString`).

Export	Description
`renderToString(fn)`	`{ html, css }`, synchronous.
`renderToStringAsync(fn, options?)`	`{ html, css, data, script }` after the data loads.
`renderToStream(fn)`	`ReadableStream<Uint8Array>` with styles first.
`serializeData(data)`	The escaped JSON used by the data script.
`escapeHTML(s)` / `escapeAttr(s)`	Escaping helpers.

import veloz from 'vite-plugin-veloz';

veloz({ exclude: ['my-ui-kit'] });

exclude: packages whose imports of @velozjs/dom should not be redirected during SSR.