API-Referenz · Vue-Editor-Brücke

@oriatheme/vue-editor

Vue bietet Composable- und automatische Vorschaukoordination für einen lokalen Quell-ThemeEditor; Es wird keine sichtbare Benutzeroberfläche exportiert.

Paket und Umgebung

Vue 3.5 Client-Brücke; Verwenden Sie einen lokal über die CLI installierten ThemeEditor als sichtbares Stammverzeichnis.

bash

pnpm add @oriatheme/editor-core @oriatheme/vue-editor

bash

npm install @oriatheme/editor-core @oriatheme/vue-editor

bash

yarn add @oriatheme/editor-core @oriatheme/vue-editor

bash

bun add @oriatheme/editor-core @oriatheme/vue-editor

Verwenden Sie den Paketmanager und die Sperrdatei, die bereits vom Verbraucherprojekt ausgewählt wurden. Beispiele verwenden nur Paket-Root-Exporte; Führen Sie keinen Deep-Import aus src-, dist- oder Registry-Vorlagen durch.

Exports

Exportieren	Unterschrift	Beschreibung
`provideThemeEditor`	`(options \| session) => ThemeEditorSession`	Stellt eine Anrufersitzung bereit oder erstellt eine eigene Sitzung.
`useThemeEditor`	`() => { session, snapshot }`	Macht eine schreibgeschützte Snapshot-Referenz des flachen Editors verfügbar.
`useThemeEditorAutoPreview`	`(runtime, mode?) => Readonly<ShallowRef<ThemeEditorAutoPreviewState>>`	Führt gültige Revisionen zusammen und behält die letzte gültige Vorschau bei.
`re-exported editor-core types`	`ThemeEditorOptions, ThemeEditorSession, …`	Convenience-Typ-/Domain-Reexporte; Verhalten bleibt im Editor-Core.

import { provideThemeEditor, useThemeEditorAutoPreview } from "@oriatheme/vue-editor";

const session = provideThemeEditor(options);
const preview = useThemeEditorAutoPreview(runtime);

Die sichtbare Benutzeroberfläche befindet sich in Ihrem Projekt

Dieses Paket exportiert keinen vollständigen Editor oder Standard-CSS. Verwenden Sie die CLI, um Vue-Quellkomponenten mit mehreren Dateien zu installieren und die Grenzen zwischen Editor-Kern/Laufzeitentwurf und atomarer Vorschau beizubehalten.