vue-quilly
Version:
Tiny Vue component, that helps to create [Quill v2](https://quilljs.com/) based WYSIWYG editors in Vue-powered apps.
205 lines (161 loc) • 7.35 kB
Markdown
# vue-quilly
Tiny Vue component, that helps to create [Quill v2](https://quilljs.com/) based WYSIWYG editors in Vue-powered apps.
[](https://www.npmjs.com/package/vue-quilly)
[](https://www.npmjs.com/package/vue-quilly?activeTab=code)
[](https://www.npmjs.com/package/vue-quilly?activeTab=code)
[](https://github.com/alekswebnet/vue-quilly?tab=readme-ov-file#license)
It's not a all-in-one solution and requires further Quill configuration.
In other hand, you can build your own editor, that matches your needs, with easy.
No matter if you want to create full-featured editor with all Quill's modules or small custom solution with extra functionality, you can use this package as a base start point:
- Run [demo](https://vue-quilly.vercel.app/), that shows editors, builded upon `QuillyEditor` component.
- See editors [example](https://github.com/alekswebnet/vue-quilly/blob/main/demo/).
- Create editors with [Nuxt 4](https://github.com/alekswebnet/vue-quilly/blob/main/nuxt/app/app.vue).
Default input data format is HTML, but also has [Delta](https://quilljs.com/docs/delta) support - using Quill API and exposed Quill instance.
In short, HTML and Delta inputs works in a same way, you can use one of them or both formats to change editor data model.
## Features
- Builded on top of [Quill v2](https://github.com/quilljs/quill) and Vue 3
- Uses `quill/core` to prevent importing all Quill modules
- Works with both HTML and Quill Delta format
- Typescript support
## Support via Ko-fi
If you find `vue-quilly` useful and want to support its development, consider making a donation via Ko-fi:
[](https://ko-fi.com/oleksandrshevchuk)
> ❤️ Your support helps with maintenance, bug fixes, and long-term improvements.
## Setup
**Browser:**
```html
<!-- Include Quill 2 -->
<link href="https://cdn.jsdelivr.net/npm/quill@2.0.3/dist/quill.snow.css" rel="stylesheet">
<script src="https://cdn.jsdelivr.net/npm/quill@2.0.3/dist/quill.js"></script>
<!-- Import Vue and vue-quilly -->
<script type="importmap">
{
"imports": {
"vue": "https://unpkg.com/vue@3/dist/vue.esm-browser.js",
"vue-quilly": "https://unpkg.com/vue-quilly@1.1.3/dist/vue-quilly.js"
}
}
</script>
<!-- Initialize the editor -->
<div id="app">
<quilly-editor ref="editor" v-model="model" :options="options" />
</div>
<script type="module">
import { createApp, ref, onMounted } from 'vue'
import { QuillyEditor } from 'vue-quilly'
createApp({
setup() {
const options = {
theme: 'snow',
modules: {
toolbar: true,
},
placeholder: 'Compose an epic...',
readOnly: false
}
const editor = ref()
const model = ref('<p>Hello Quilly!</p>')
let quill = null
onMounted(() => {
quill = editor.value.initialize(Quill)
})
return {
editor,
options,
model
}
}
})
.component('QuillyEditor', QuillyEditor)
.mount('#app')
</script>
```
Browser setup demo - https://codepen.io/redrobot753/pen/VwJwPLP
**Bundlers:**
```bash
npm install quill vue-quilly
# Or
yarn add quill vue-quilly
# Or
pnpm add quill vue-quilly
```
Import Quill full build if you need all modules or [core build](https://quilljs.com/docs/installation#core-build) with minimum required modules:
```ts
import Quill from 'quill' // Full build
import Quill from 'quill/core' // Core build
import { QuillyEditor } from 'vue-quilly'
```
Add core styles. Also import one of Quill's [themes](https://quilljs.com/docs/customization/themes#themes), if you need one:
```ts
import 'quill/dist/quill.core.css' // Required
import 'quill/dist/quill.snow.css' // For snow theme (optional)
import 'quill/dist/quill.bubble.css' // For bubble theme (optional)
```
Define Quill [options](https://quilljs.com/docs/configuration#options):
```ts
const options = {
theme: 'snow', // If you need Quill theme
modules: {
toolbar: true,
},
placeholder: 'Compose an epic...',
readOnly: false
}
```
Initialize the editor:
```ts
const editor = ref<InstanceType<typeof QuillyEditor>>()
const model = ref<string>('<p>Hello Quilly!</p>')
// Quill instance
let quill: Quill | null = null
onMounted(() => {
quill = editor.value?.initialize(Quill)!
})
```
```html
<QuillyEditor
ref="editor"
v-model="model"
:options="options"
@update:modelValue="(value) => console.log('HTML model updated:', value)"
@text-change="({ delta, oldContent, source }) => console.log('text-change', delta, oldContent, source)"
@selection-change="({ range, oldRange, source }) => console.log('selection-change', range, oldRange, source)"
@editor-change="(eventName) => console.log('editor-change', `eventName: ${eventName}`)"
@focus="(quill) => console.log('focus', quill)"
@blur="(quill) => console.log('blur', quill)"
@ready="(quill) => console.log('ready', quill)"
/>
```
⚠️ Use `v-model` for HTML content type. The received content is equal to Quill's editor element `innerHTML` property value.
In some cases it will be better to use `quill.semanticHTML()` to get a clean HTML output. For doing this just set a property `:is-semantic-html-model="true"`. See [SemanticHTMLEditor example](https://github.com/alekswebnet/vue-quilly/tree/main/demo/src/components/SemanticHTMLEditor.vue).
Also you can set content in Delta format using Quill instance:
```ts
quill?.setContents(
new Delta()
.insert('Hello')
.insert('\n', { header: 1 })
.insert('Some ')
.insert('initial', { bold: true })
.insert(' ')
.insert('content', { underline: true })
.insert('\n')
)
```
This is just basic example and shows you how to build your editor.
See creating editors with `QullyEditor` [example](https://github.com/alekswebnet/vue-quilly/blob/main/demo/) or run [demo](https://vue-quilly.vercel.app/).
## Events
The component emits `text-change`, `selection-change`, `editor-change` events, similar to [Quill events](https://quilljs.com/docs/api#events).
All events types:
| Event name | Params |
| ------------------- | ---------------------------------------------------------------- |
| `update:modelValue` | value: `string` |
| `text-change` | { delta: `Delta`, oldContent: `Delta`, source: `EmitterSource` } |
| `selection-change` | { range: `Range`, oldRange: `Range`, source: `EmitterSource` } |
| `editor-change` | eventName: `string` |
| `focus` | quill: `Quill` |
| `blur` | quill: `Quill` |
| `ready` | quill: `Quill` |
## Nuxt
See [Nuxt 4 example](https://github.com/alekswebnet/vue-quilly/blob/main/nuxt/app/app.vue).
## License
[MIT](https://choosealicense.com/licenses/mit/)