weblineindia/vue-ck-editor

An easy-to-use but yet powerful and customizable rich text editor powered by Quill.js and Vue.js

Vue-Ck-Editor

An easy-to-use but yet powerful and customizable rich text editor powered by Quill.js and Vue.js

Table of contents

• Browser Support
• Demo
• Getting started
• Usage
• Available Props
• Methods
• Want to Contribute?
• Need Help / Support?
• Collection of Components
• Changelog
• Credits
• License
• Keywords

Browser Support

| | | | | --- | --- | --- | --- | --- | --- | 83.0 ✔ | 77.0 ✔ | 13.1.1 ✔ | 83.0 ✔ | 11.9 ✔ |

Demo

Getting started

Install the npm package:

npm install vue-weblineindia-ck-editor
#OR
yarn add vue-weblineindia-ck-editor

Usage

Use the <vue-weblineindia-ck-editor> component:

<template>
  <div>
  <VueCkEditor v-model="content"/>
  </div>
</template>

<script>
// import vue-weblineindia-ck-editor
import VueCkEditor from 'vue-weblineindia-ck-editor'

export default {
  components: {
    VueCkEditor,
  },
  data() {
    return {
      content: "<h1>Hello from WeblineIndia</h1>"
    };
  }
}
</script>

Available Props

Name	Type	Default	Description
customModules	Array	-	Declare Quill modules to register
disabled	Boolean	false	Set to true to disable editor
editorOptions	Object	-	Offers object for merging into default config (add formats, custom Quill modules, ect)
editorToolbar	Array	** Too long for table. See toolbar example below	Use a custom toolbar
id	String	quill-container	Set the id (necessary if multiple editors in the same view)
placeholder	String	-	Placeholder text for the editor
useCustomImageHandler	Boolean	false	Handle image uploading instead of using default conversion to Base64
v-model	String	-	Set v-model to the the content or data property you wish to bind it to

Methods

Name	Parameters	Description
blur	quill	Emitted on blur event
focus	quill	Emitted on focus event
image-added	file, Editor, cursorLocation	Emitted when useCustomImageHandler is true and photo is being added to the editor
image-removed	file, Editor, cursorLocation	Emitted when useCustomImageHandler is true and photo has been deleted
selection-change	range, oldRange, source	Emitted on Quill's selection-change event
text-change	delta, oldDelta, source	Emitted on Quill's text-change event

Want to Contribute?

• Created something awesome, made this code better, added some functionality, or whatever (this is the hardest part).
• Fork it.
• Create new branch to contribute your changes.
• Commit all your changes to your branch.
• Submit a pull request.

---

Need Help?

We also provide a free, basic support for all users who want to use this VueJS Ck Editor in their software project. In case you want to customize this Ck Editor to suit your development needs, then feel free to contact our VueJS developers.

---

Collection of Components

We have built many other components and free resources for software development in various programming languages. Kindly click here to view our Free Resources for Software Development

---

Changelog

Detailed changes for each release are documented in CHANGELOG.md.

Credits

vue-weblineindia-ck-editor is inspired by vue2-editor.

License

MIT

Keywords

vue-weblineindia-ck-editor,rich text,editor,ckeditor,vue components,vuejs,vuejs component