Vue integration

Install and run

The /cms components are released in 1.3.0. The existing useSoEditorWorkspace entry remains compatible.

pnpm add @soeditor/editor@1.3.0 @soeditor/vue@1.3.0 vue

Select “Start editing” to run the published packages. Download complete example sources, extract, run pnpm install and pnpm dev, then open vue.html.

Bind article HTML

<script setup lang="ts">
import { ref } from 'vue';
import { SoEditor } from '@soeditor/vue/cms';
import '@soeditor/editor/cms/styles.css';
const html = ref('<p>Article</p>');
</script>

<template>
    <SoEditor
        v-model="html"
        name="body"
        :options="{ locale: 'zh-CN', ariaLabel: '文章正文' }"
        @error="console.error"
    />
</template>

Behavior contract

• React uses value / onChange(html, change). Vue uses v-model and also emits change(html, change). Echo edits into bound state. External value changes neither emit change again nor recreate the editor.
• Use defaultValue (default-value in Vue templates) without a bound value for uncontrolled editing. The initial bound/default HTML is the native form reset baseline for that mount.
• name participates in native submit and FormData; readonly is reactive. SSR renders escaped readonly textarea text and creates the editor only after client mount.
• Toolbar, locale, plugins, options and createEditor are construction settings. Change the component key for structural changes. Ordinary parent renders preserve selection and undo history.
• React provides onReady / onFocus / onBlur / onError; Vue emits ready / focus / blur / error. Ready receives the Classic instance for focus(), getData() and setWorkspaceView().
• The component owns destruction. Do not call destroy() yourself. An instance that finishes initialization after unmount is cleaned up. Surface errors in the host and change key to retry creation.

Source and loading

The default entry mounts CMS WYSIWYG. To enable Source, supply an explicit createEditor factory and editingModes: ['wysiwyg', 'source']. Source loads on first activation; formatting has its own demand boundary.

import '@soeditor/editor/cms/styles.css';
import '../style.css';
import type { CreateClassicEditorOptions } from '@soeditor/editor/cms';

export const locale =
    new URLSearchParams(location.search).get('lang') === 'en' ? 'en' : 'zh-CN';
document.documentElement.lang = locale;
export const label = (zh: string, en: string) => (locale === 'en' ? en : zh);
export const initial = '<h2>CMS article</h2><p>Edit this content.</p>';
export const options: CreateClassicEditorOptions = {
    locale,
    ariaLabel: label('文章正文', 'Article HTML'),
    editingModes: ['wysiwyg', 'source'],
    minHeight: 240,
};
export const createEditor = async (
    host: HTMLElement,
    configuration: CreateClassicEditorOptions,
) => {
    const cms = await import('@soeditor/editor/cms/optional');
    return cms.createClassicEditor(host, configuration);
};

Troubleshooting and versions

Import the CMS stylesheet if chrome is missing. A missing /cms export usually means an older adapter is installed. Use 1.3.0 or later; 1.2.x does not provide this entry. Never render editor HTML with v-html or dangerouslySetInnerHTML, or create an editor during render/setup.

Declared peer ranges are React 18.2–19 and Vue 3.5. This round uses React 19.2.8 and Vue 3.5.42 in automation. SSR support does not certify every Next/Nuxt version.

Run the complete form example