API Reference

@themvora/open-props · Svelte

Open Props adapter: map theme tokens onto Open Props custom properties.

useOpenPropsTheme(runtime, options?) installs the Open Props adapter onto an explicitly provided Themvora runtime and disposes it on unmount.

Generated from packages/open-props/src by apps/docs/scripts/generate-api-reference.mjs. Do not edit by hand — run pnpm --filter @themvora/docs api:generate.

Functions

`useOpenPropsTheme<T extends ThemeDefinition<string>>(runtime, options): ThemeAdapter<T>`

Svelte composable that installs the Open Props adapter onto the given Theme Kit runtime. Maintains a tagged :root style element with concrete --brand, --link, --size-* and related variables, kept in sync as the active theme changes.

Must be called during component initialization, passing the runtime from your Themvora provider (e.g. getThemeRuntime() from @themvora/svelte):

TS / JS

import { useOpenPropsTheme } from "@themvora/open-props/svelte";

useOpenPropsTheme(runtime);

The adapter installs synchronously (guarded on window, so it is SSR-safe) and is disposed via Svelte's effect tree.

See also: createOpenPropsAdapter

Parameter	Type	Description
`runtime`	`ThemeRuntime<T>`	The active Themvora runtime to install the adapter on.
`options`	`UseAdapterOptions`	Adapter options. Defaults to `{}`.

Returns ThemeAdapter<T> — The installed adapter instance.

Interfaces

`UseAdapterOptions`

Options accepted by the Svelte adapter composables (e.g. useOpenPropsTheme).

Member	Type	Description
`strategy` (optional)	`AdapterStrategy`	The adapter strategy to use. When omitted, the adapter's default strategy applies.

Related docs

Open Props — the adapter integration