Versatile
An adaptable ecosystem capable of handling end-to-end document editing, interoperability with third-party tools, document management, and collaboration.
Extensible
Modular architecture where everything is a plugin. You can tune up, add, or remove plugins as you wish. Use custom processors to handle HTML, Markdown, or JSON output.
Progressive
Takes advantage of a superb team of 50+ industry experts and 20+ years of experience in WYSIWYG editing. We are releasing new features every month.
Simple setup
Here is a quick example of how to use the Vue Rich Text Editor
component for CKEditor 5 by using Vite!
1
Create a project
Create a project using a basic Vite template and change
the working directory to a newly created project.
npm create vite@latest ckeditor5-vue -- --template vue && cd ckeditor5-vue2
Install packages
Install dependencies to Vue Text Editor Component and a chosen Editor Type
according to the editing experience of your preference. In this case, we use the classic one.
npm install ckeditor5 @ckeditor/ckeditor5-vue3
Add component
Replace contents of src/App.vue with code responsible for importing and the initialization of the editor.
<script>
import CKEditor from '@ckeditor/ckeditor5-vue';
import {
ClassicEditor,
Bold,
Essentials,
Heading,
Indent,
IndentBlock,
Italic,
Link,
List,
MediaEmbed,
Paragraph,
Table,
Undo
} from 'ckeditor5';
import 'ckeditor5/ckeditor5.css';
export default {
name: 'app',
components: {
ckeditor: CKEditor.component
},
data() {
return {
editor: ClassicEditor,
editorData: '<h1>Hello from CKEditor 5!</h1>',
editorConfig: {
toolbar: [
'undo', 'redo', '|',
'heading', '|', 'bold', 'italic', '|',
'link', 'insertTable', 'mediaEmbed', '|',
'bulletedList', 'numberedList', 'indent', 'outdent'
],
plugins: [
Bold,
Essentials,
Heading,
Indent,
IndentBlock,
Italic,
Link,
List,
MediaEmbed,
Paragraph,
Table,
Undo
],
}
};
}
}
</script>
<template>
<div id="app">
<ckeditor :editor="editor" v-model="editorData" :config="editorConfig"></ckeditor>
</div>
</template>
4
Done!
Run the app by executing the following command
in your project's directory.
npm run dev5
Explore the documentation
Congratulations on setting up CKEditor! To make the most of it, visit the CKEditor documentation
for comprehensive guidance on how to fully customize and integrate the editor.