OriaTheme
GitHub

Справочник API · Мост редактора Vue

@oriatheme/vue-editor

Vue обеспечивает компоновку и координацию автоматического предварительного просмотра для локального исходного редактора ThemeEditor; он не экспортирует видимый пользовательский интерфейс.

Упаковка и окружающая среда

Vue 3.5 клиентский мост; используйте локально установленный через CLI ThemeEditor в качестве видимого корня.

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

Используйте менеджер пакетов и файл блокировки, уже выбранный потребительским проектом. В примерах используется только экспорт корня пакета; не выполняйте глубокий импорт из шаблонов src, dist или реестра.

Exports

ЭкспортПодписьОписание
provideThemeEditor(options | session) => ThemeEditorSessionПредоставляет сеанс вызывающего абонента или создает собственный сеанс.
useThemeEditor() => { session, snapshot }Предоставляет доступный только для чтения снимок поверхностного редактора ref.
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);

Видимый пользовательский интерфейс живет в вашем проекте

Этот пакет не экспортирует полный редактор или CSS по умолчанию. Используйте интерфейс командной строки для установки многофайловых исходных компонентов Vue и сохранения границ ядра редактора/времени выполнения и атомарного предварительного просмотра.