API Reference

@themvora/open-props · React

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?): void`

React hook that installs the Open Props adapter onto the given Themvora runtime. The adapter maintains a tagged :root style element containing concrete --color-* / --brand / --size-* / --shadow-* variables in sync as the theme changes.

Call once in your app root, passing the runtime from your Themvora provider (e.g. the useThemeRuntime() hook from @themvora/react):

TSX / JSX

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

function App() {
  useOpenPropsTheme(runtime);
  return <YourApp />;
}

See also: createOpenPropsAdapter

Parameter	Type	Description
`runtime`	`ThemeRuntime<T>`	The active Themvora runtime to install the adapter on.
`options`	`{ strategy?: AdapterStrategy }` (optional)	Adapter options. Defaults to `{}`.

Returns void

Related docs

Open Props — the adapter integration