---
title: Quill - Rich Content Editor
product: Form Library
description: Form builder tool with Quill, a rich text editor that enables users to input and format their content with bold, italics, lists, hyperlinks, and more. View a free demo for JavaScript to learn how to integrate Quill into SurveyJS.
framework: Vue 3
source: https://surveyjs.io/form-library/examples/form-builder-with-rich-content-editor/vue3js
index: https://surveyjs.io/form-library/examples/overview.md
---

# Quill - Rich Content Editor (Vue 3)

A rich text editor is a tool that allows users to create, edit, and format text using advanced features. For instance, your respondents can apply a bold, italic, or underline font style to text, add bullet points, numbered lists, hyperlinks, adjust text alignment, and more. This demo shows how to integrate the <a href="https://quilljs.com/" target="_blank">Quill</a> text editor into your survey.

For a step-by step Quill integration tutorial, refer to the following documentation articles. Although they describe integration of a color picker, the same instructions apply to any other third-party component, including Quill. 

- [Integrate Third-Party React Components](https://surveyjs.io/form-library/documentation/customize-question-types/third-party-component-integration-react)
- [Integrate Third-Party Angular Components](https://surveyjs.io/form-library/documentation/customize-question-types/third-party-component-integration-angular)
- [Integrate Third-Party Vue 3 Components](/form-library/documentation/customize-question-types/third-party-component-integration-vue)

## Files

### `public/index.html`

```html
<div id="app" style="position: absolute; top: 0; left: 0; right: 0; bottom: 0; height:100%"></div>
```

### `src/Quill.vue`

```html
<template>
  <quill-editor
    :style="{ height: question.height }"
    v-model:value="question.value"
    :disabled="question.isReadOnly"
    :options="quillOptions"
  />
</template>
<script setup lang="ts">
import { useQuestion } from "survey-vue3-ui";
import { ref } from "vue";
import { QuestionQuillModel } from "./QuillModel";

const quillOptions = {
    theme: "snow",
    modules: {
        toolbar: [[{ "header": [1, 2, 3, false] }], ["bold", "italic", "underline", "link"], [{ "list": "ordered" }, { "list": "bullet" }], ["clean"]]
    }
};
const root = ref(null);
const props = defineProps<{ question: QuestionQuillModel }>();

useQuestion(props, root);
</script>
```

### `src/QuillModel.ts`

```ts
import { Question, Serializer, ElementFactory } from "survey-core";

// Must use lowercase
const CUSTOM_TYPE = "quill";

// Create a question model
export class QuestionQuillModel extends Question {
    getType() {
        return CUSTOM_TYPE;
    }
    get height(): string {
        return this.getPropertyValue("height");
    }
    set height(val: string) {
        this.setPropertyValue("height", val);
    }
}

// Register the model in `ElementFactory`
ElementFactory.Instance.registerElement(CUSTOM_TYPE, (name) => {
    return new QuestionQuillModel(name);
});

// Add question type metadata for further serialization into JSON
Serializer.addClass(
    CUSTOM_TYPE,
    [{ name: "height", default: "200px", category: "layout" }],
    function () {
        return new QuestionQuillModel("");
    },
    "question"
);
```

### `src/App.vue`

```html
<script lang="ts">


import { registerFunction } from "survey-core";

function encodeHtml([ input ]) {
    return input
        .replace(/&/g, '&amp;')
        .replace(/</g, '&lt;')
        .replace(/>/g, '&gt;');
}
registerFunction({ name: "encodeHtml", func: encodeHtml });

</script>
<template>
    <SurveyComponent :model="survey" />
</template>
<script setup lang="ts">
    import { Model } from "survey-core";
    import { SurveyComponent } from "survey-vue3-ui";
    import "survey-core/survey-core.min.css";
    import "./index.css";
    import { json } from "./json";

    const survey = new Model(json);
    survey.onComplete.add((sender, options) => {
        console.log(JSON.stringify(sender.data, null, 3));
    });
</script>
```

### `src/index.css`

```css
.ql-toolbar.ql-snow {
    white-space: normal;
}
```

### `src/json.ts`

```ts
export const json = {
  "elements": [
    {
      "type": "quill",
      "name": "rich-text-editor",
      "defaultValue": "Hello world!"
    },
    {
      "type": "html",
      "name": "rich-text-editor-html",
      "html": "{encodedHtml}"
    }
  ],
  "calculatedValues": [{
    "name": "encodedHtml",
    "expression": "encodeHtml({rich-text-editor})"
  }],
  "questionTitleLocation": "hidden",
  "showNavigationButtons": false
}
;
```

### `src/main.ts`

```ts
import { createApp } from "vue";
import App from "./App.vue";
import { quillEditor } from "vue3-quill";
export * from "./QuillModel";
import Quill from "./Quill.vue";

const app = createApp(App);
app.use(quillEditor);
app.component("survey-quill", Quill);
app.mount("#app");
```

### `src/shims-vue.d.ts`

```ts
/* eslint-disable */
declare module "*.vue" {
    import type { DefineComponent } from "vue"
    const component: DefineComponent<{}, {}, any>
    export default component
}
```

### `.eslintrc.js`

```js
module.exports = {
    root: true,
    env: {
        node: true
    },
    extends: [
        "plugin:vue/vue3-essential",
        "eslint:recommended",
        "@vue/typescript/recommended",
        "@vue/prettier",
        "@vue/prettier/@typescript-eslint"
    ],
    parserOptions: {
        ecmaVersion: 2020
    },
    rules: {
        "no-console": process.env.NODE_ENV === "production" ? "warn" : "off",
        "no-debugger": process.env.NODE_ENV === "production" ? "warn" : "off"
    },
    overrides: [
        {
            files: [
                "**/__tests__/*.{j,t}s?(x)",
                "**/tests/unit/**/*.spec.{j,t}s?(x)"
            ],
            env: {
                jest: true
            }
        }
    ]
};
```

### `babel.config.js`

```js
module.exports = {
  presets: ["@vue/cli-plugin-babel/preset"]
};
```

### `package.json`

```json
{
  "name": "surveyjs-library-vue3",
  "version": "0.1.0",
  "scripts": {
    "serve": "vue-cli-service serve",
    "build": "vue-cli-service build",
    "lint": "vue-cli-service lint"
  },
  "dependencies": {
    "core-js": "^3.6.5",
    "tslib": "2.6.1",
    "vue": "^3.4.1",
    "vue3-quill": "latest",
    
    "survey-core": "latest",
    "survey-vue3-ui": "latest",
    "vue-router": "^4.0.0-0",
    "vuex": "^4.0.0-0"
  },
  "devDependencies": {
    "@typescript-eslint/eslint-plugin": "^2.33.0",
    "@typescript-eslint/parser": "^2.33.0",
    "@vue/cli-plugin-babel": "~4.5.0",
    "@vue/cli-plugin-eslint": "~4.5.0",
    "@vue/cli-plugin-pwa": "~4.5.0",
    "@vue/cli-plugin-router": "~4.5.0",
    "@vue/cli-plugin-typescript": "~4.5.0",
    "@vue/cli-plugin-vuex": "~4.5.0",
    "@vue/cli-service": "~4.5.0",
    "@vue/compiler-sfc": "^3.0.0",
    "@vue/eslint-config-prettier": "^6.0.0",
    "@vue/eslint-config-typescript": "^5.0.2",
    "@vue/test-utils": "^2.0.0-0",
    "eslint": "^6.7.2",
    "eslint-plugin-prettier": "^3.1.3",
    "eslint-plugin-vue": "^7.0.0-0",
    "node-sass": "^4.12.0",
    "prettier": "^1.19.1",
    "sass-loader": "^8.0.2",
    "typescript": "~3.9.3"
  }
}
```

### `tsconfig.json`

```json
{
  "compilerOptions": {
    "target": "esnext",
    "module": "esnext",
    "strict": true,
    "jsx": "preserve",
    "importHelpers": true,
    "moduleResolution": "node",
    "skipLibCheck": true,
    "esModuleInterop": true,
    "allowSyntheticDefaultImports": true,
    "sourceMap": true,
    "baseUrl": ".",
    "types": [
      "webpack-env",
      "jest"
    ],
    "paths": {
      "@/*": [
        "src/*"
      ]
    },
    "lib": [
      "esnext",
      "dom",
      "dom.iterable",
      "scripthost"
    ]
  },
  "include": [
    "src/**/*.ts",
    "src/**/*.tsx",
    "src/**/*.vue",
    "tests/**/*.ts",
    "tests/**/*.tsx"
  ],
  "exclude": [
    "node_modules"
  ]
}
```

## Other Frameworks

- [Angular](https://surveyjs.io/form-library/examples/form-builder-with-rich-content-editor/angular.md)
- [React](https://surveyjs.io/form-library/examples/form-builder-with-rich-content-editor/reactjs.md)
- [jQuery](https://surveyjs.io/form-library/examples/form-builder-with-rich-content-editor/jquery.md)