API Reference

@themvora/bootstrap · Svelte

Bootstrap adapter: concrete --bs-* variables (including -rgb triplets) kept in sync with the runtime.

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

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

Functions

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

Svelte composable that installs the Bootstrap adapter onto the given Theme Kit runtime. Maintains a tagged :root style element with concrete --bs-* variables (including -rgb triplets), 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 { useBootstrapTheme } from "@themvora/bootstrap/svelte";

useBootstrapTheme(runtime);

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

See also: createBootstrapAdapter

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. useBootstrapTheme).

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

Related docs

Bootstrap — the adapter integration