Vue Adapter

Back to Home

Getting Started with Vue

Lilac Editor provides a Vue 3 component with Composition API support and two-way data binding.

Installation

# Using npm
npm install @lilac-wysiwyg/vue

# Using pnpm
pnpm add @lilac-wysiwyg/vue

# Using yarn
yarn add @lilac-wysiwyg/vue

Plugin Setup

// main.ts
import { createApp } from 'vue';
import { LilacEditorPlugin } from '@lilac-wysiwyg/vue';
import App from './App.vue';

const app = createApp(App);
app.use(LilacEditorPlugin);
app.mount('#app');

Basic Usage

// App.vue
<template>
  <LilacEditor
    v-model="content"
    :toolbar="{ show: true }"
    placeholder="Start writing..."
    @change="handleChange"
  />
</template>

<script setup>
  import { ref } from 'vue';
  import { LilacEditor } from '@lilac-wysiwyg/vue';

  const content = ref('<p>Hello Vue!</p>')

  function handleChange(newContent) {
    console.log('Content updated:', newContent)
  }
</script>

Features

Composition API

Built with Vue 3 Composition API for clean and reusable component logic.

Two-Way Binding

Native v-model support with automatic content synchronization.

TypeScript Support

Full TypeScript definitions included with proper typing.

Plugin System

Easy installation via Vue plugin system with global registration.

Vue Adapter v0.5.0