Skip to content
On this page

Installation

TIP

This guide assumes intermediate-level knowledge of Vue 3. If you are totally new to Vue 3, grasp the Basics of Vue 3 first and then come back, but is not required.

CDN

VueQuill ships as a UMD module that is accessible in the browser. When loaded in the browser, you can access the component through the VueQuill.QuillEditor global variable. You'll need to load Vue.js, VueQuill JS & VueQuill CSS theme.

html
<!-- include VueJS first -->
<script src="https://unpkg.com/vue@next"></script>

<!-- use the latest VueQuill release -->
<script src="https://unpkg.com/@vueup/vue-quill@latest"></script>
<link rel="stylesheet" href="https://unpkg.com/@vueup/vue-quill@latest/dist/vue-quill.snow.prod.css">

<!-- or point to a specific VueQuill release -->
<script src="https://unpkg.com/@vueup/vue-quill@version"></script>
<link rel="stylesheet" href="https://unpkg.com/@vueup/vue-quill@version/dist/vue-quill.snow.prod.css">

WARNING

For production, we recommend linking to a specific version number and build to avoid unexpected breakage from newer versions.

NPM / Yarn

Use the package manager npm or yarn to install VueQuill.

bash
npm install @vueup/vue-quill@latest --save
# OR
yarn add @vueup/vue-quill@latest

npm or yarn is the recommended installation method when you are using Single File Component, and then you can register the Component in your app.

Released under the MIT License.