README.md

VueQuill

Rich Text Editor Component for Vue 3.

👀 See a Live Demo

🔎 Overview

VueQuill is a Component for building rich text editors, powered by Vue 3 and Quill.

• 💚 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.

🚀 VueQuill is in @beta version! Currently the focus is on making VueQuill stable and feature complete first. Some of its features are not "finalized" and will have breaking changes over time as we discover better solutions.

📚 Documentation

• 📘 Guide

  • 🚀 Introduction
  • ⚙️ Installation
  • 💡 Usage
  • 🎨 Themes
  • 🚥 Toolbar
  • 📦 Modules
  • 🛠️ Options

• 🧰 APIs

  • 📌 Props
  • ⚡ Events
  • 📢 Methods
  • 🔌 Slots
  • ↗️ Export

☑️ To do list

• Release alpha version
• Release beta version
• Stable v1.0.0 release
• Enhance Typescript support with Vue 3
• Update the Documentation with more examples and more information

👏 Contributing

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

📝 License

MIT