API reference · Vue editor bridge
@oriatheme/vue-editor
Vue provide, Composable, and auto-preview coordination for a local source ThemeEditor; it exports no visible UI.Package and environment
Vue 3.5 client bridge; use a locally CLI-installed ThemeEditor as the visible root.
bash
pnpm add @oriatheme/editor-core @oriatheme/vue-editorbash
npm install @oriatheme/editor-core @oriatheme/vue-editorbash
yarn add @oriatheme/editor-core @oriatheme/vue-editorbash
bun add @oriatheme/editor-core @oriatheme/vue-editorUse the package manager and lockfile already chosen by the consumer project. Examples use package-root exports only; do not deep-import from src, dist, or registry templates.
Exports
| Export | Signature | Description |
|---|---|---|
provideThemeEditor | (options | session) => ThemeEditorSession | Provides a caller session or creates an owned session. |
useThemeEditor | () => { session, snapshot } | Exposes a readonly shallow editor snapshot ref. |
useThemeEditorAutoPreview | (runtime, mode?) => Readonly<ShallowRef<ThemeEditorAutoPreviewState>> | Coalesces valid revisions and preserves the last valid preview. |
re-exported editor-core types | ThemeEditorOptions, ThemeEditorSession, … | Convenience type/domain re-exports; behavior remains in editor-core. |
ts
import { provideThemeEditor, useThemeEditorAutoPreview } from "@oriatheme/vue-editor";
const session = provideThemeEditor(options);
const preview = useThemeEditorAutoPreview(runtime);Visible UI lives in your project
This package exports no complete editor or default CSS. Use the CLI to install multi-file Vue source components and preserve editor-core/runtime draft and atomic-preview boundaries.