@vueup/vue-quill v1.2.0

VueQuill is a Vue Component for building rich text editors, this package is a thin wrapper around Quill, to make it easier to use in a Vue 3 application.

• 💚 Built With Vue 3: More powerful and performant framework than ever before.
• 🧙‍♂️ Fully Typescript: VueQuill source code is written entirely in TypeScript.
• 🛠️ Easy To Use: Straightforward implementation through a simple API.

👀 See a Live Demo.

📘 Read the Docs to Learn More.

🚀 VueQuill is in alpha version! Currently the focus is on making VueQuill stable and feature complete first. It is not recommended to use this for anything serious yet. Some of its features are not "finalized" and will have breaking changes over time as we discover better solutions.

🧑‍🤝‍🧑 VueQuill is also contributor-driven. It is not backed by any huge company, which means that all contributions are voluntary and done by the people who need them. If you need something improved, added, or fixed, please contribute it yourself or no one will.

Support me

You can support me by ☕ buying me a cup of coffee ☕ to help me stay awake while I am coding, spend more time on the projects, and speed up the development.

To do list

• Release alpha version
• Release beta version
• Initial v1.0.0 release
• Enhance Typescript support with Vue 3
• Update the Documentation with improved examples and more information
• vue-quill-plugin-api: provide built-in API for quill modules

Our Dream Features

Our next goal is to provide a first-class plugins ecosystem:

• vue-quill-table: add table editing functionality with options to modify cells, rows and columns.
• vue-quill-media: add image, HTML5 video, and audio elements to the editable area. Includes option for live preview of embedded videos.
• vue-quill-emoji: Insert emojis into VueQuill’s editable area. The default emoji set can be extended or overridden.
• vue-quill-suggest: insert shortcut-text and transforming it into @mentions, links, and #hashtags.
• vue-quill-form: module for automatic form input and submit binding.
• vue-quill-code: insert and embed syntax color highlighted code snippets into the editable area.
• vue-quill-collab: module for realtime collaboration.

Demo

• See a Live Demo.

  

Documentation

• Guide

  • Introduction
  • Installation
  • Usage
  • Themes
  • Toolbar
  • Options

• APIs

  • Props
  • Events
  • Methods
  • Slots
  • Export

Contributing

Pull requests are welcome. For major changes, please create a new discussion first about what you would like to change.

Quill

Quill API document

License

MIT