https://github.com/vueup/vue-quill

Rich Text Editor Component for Vue 3.
https://github.com/vueup/vue-quill

editor quill text-editor vue vue-component vue3 wysiwyg-editor

Last synced: 4 days ago
JSON representation

Rich Text Editor Component for Vue 3.

• Host: GitHub
• URL: https://github.com/vueup/vue-quill
• Owner: vueup
• License: mit
• Created: 2021-02-23T05:13:54.000Z (almost 4 years ago)
• Default Branch: master
• Last Pushed: 2025-01-11T08:22:33.000Z (15 days ago)
• Last Synced: 2025-01-14T21:07:02.089Z (11 days ago)
• Topics: editor, quill, text-editor, vue, vue-component, vue3, wysiwyg-editor
• Language: TypeScript
• Homepage: https://vueup.github.io/vue-quill/
• Size: 6.73 MB
• Stars: 1,173
• Watchers: 15
• Forks: 289
• Open Issues: 7
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Funding: .github/FUNDING.yml
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

• awesome-vue-3 - vue-quill - ✒️📝 A Vue 3 rich text editor component based on Quill Editor. See a [Live Demo](https://vueup.github.io/vue-quill/#demo). (Packages)
• awesome-fe-resources - vue-quill

README

        


  

    

  



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.

## 📚 Documentation

- **[📘 Guide](https://vueup.github.io/vue-quill/guide/)**

  - [🚀 Introduction](https://vueup.github.io/vue-quill/guide/)

  - [⚙️ Installation](https://vueup.github.io/vue-quill/guide/installation.html)

  - [💡 Usage](https://vueup.github.io/vue-quill/guide/usage.html)

  - [🎨 Themes](https://vueup.github.io/vue-quill/guide/themes.html)

  - [🚥 Toolbar](https://vueup.github.io/vue-quill/guide/toolbar.html)

  - [📦 Modules](https://vueup.github.io/vue-quill/guide/modules.html)

  - [🛠️ Options](https://vueup.github.io/vue-quill/guide/options.html)

  

- **[🧰 APIs](https://vueup.github.io/vue-quill/api/)**

  - [📌 Props](https://vueup.github.io/vue-quill/api/)

  - [⚡ Events](https://vueup.github.io/vue-quill/api/events.html)

  - [📢 Methods](https://vueup.github.io/vue-quill/api/methods.html)

  - [🔌 Slots](https://vueup.github.io/vue-quill/api/slots.html)

  - [↗️ Export](https://vueup.github.io/vue-quill/api/export.html)

## ☑️ To do list

- [x] Release `alpha` version

- [x] Release `beta` version

- [x] Stable `v1.0.0` release

- [x] 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](https://github.com/vueup/vue-quill/discussions) first about what you would like to change.

## 📝 License

[MIT](https://choosealicense.com/licenses/mit/)