OriaTheme
GitHub

API リファレンス · Vue エディター ブリッジ

@oriatheme/vue-editor

Vue は、ローカル ソースの ThemeEditor のコンポーザブルおよび自動プレビュー調整を提供します。表示される UI はエクスポートされません。

パッケージと環境

Vue 3.5 クライアント ブリッジ。ローカルに CLI でインストールされた ThemeEditor を表示ルートとして使用します。

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

コンシューマ プロジェクトによってすでに選択されているパッケージ マネージャーとロックファイルを使用します。例では、パッケージ ルート エクスポートのみを使用します。 src、dist、またはレジストリ テンプレートからディープ インポートしないでください。

Exports

エクスポート署名説明
provideThemeEditor(options | session) => ThemeEditorSession呼び出し元セッションを提供するか、所有セッションを作成します。
useThemeEditor() => { session, snapshot }読み取り専用の浅いエディターのスナップショット参照を公開します。
useThemeEditorAutoPreview(runtime, mode?) => Readonly<ShallowRef<ThemeEditorAutoPreviewState>>有効なリビジョンを結合し、最後の有効なプレビューを保存します。
re-exported editor-core typesThemeEditorOptions, ThemeEditorSession, …便利なタイプ/ドメインの再エクスポート。動作はエディターコアに残ります。
ts
import { provideThemeEditor, useThemeEditorAutoPreview } from "@oriatheme/vue-editor";

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

目に見える UI はプロジェクト内に存在します

このパッケージは、完全なエディターまたはデフォルトの CSS をエクスポートしません。 CLI を使用して、複数ファイル Vue ソース コンポーネントをインストールし、エディター コア/ランタイム ドラフトとアトミック プレビューの境界を保持します。