ckeditor4-vue

CKEditor 4 WYSIWYG editor component for Vue.js

⚠️ CKEditor 4: End of Life and Extended Support Model until Dec 2026

CKEditor 4 was launched in 2012 and reached its End of Life (EOL) on June 30, 2023.

A special edition, CKEditor 4 LTS ("Long Term Support"), is available under commercial terms ("Extended Support Model") for anyone looking to extend the coverage of security updates and critical bug fixes.

With CKEditor 4 LTS, security updates and critical bug fixes are guaranteed until December 2026.

About this repository

Master branch = CKEditor 4 LTS Vue Component

After June 30, 2023 the master version of the LICENSE.md file changed to reflect the license of CKEditor 4 LTS available under the Extended Support Model.

This repository now contains the source code of CKEditor 4 LTS Vue Component that is protected by copyright law.

Getting CKEditor 4 (Open Source)

You may continue using CKEditor Vue Component 2.4.0 and below under the open source license terms. Please note, however, that the open source version no longer comes with any security updates, so your application will be at risk.

In order to download the open source version of CKEditor 4 Vue Component, use tags 2.4.0 and below. CKEditor Vue Component 2.4.0 was the last version available under the open source license terms.

About this package

The official CKEditor 4 WYSIWYG editor component for Vue.js.

We are looking forward to your feedback! You can report any issues, ideas or feature requests on the integration issues page.

Installation and usage

To install the CKEditor 4 component for Vue.js from npm, simply run:

npm install ckeditor4-vue

Then use it by calling the Vue.use() method:

import Vue from 'vue';
import CKEditor from 'ckeditor4-vue';

Vue.use( CKEditor );

new Vue( {
	// ... options
} )

And use the <ckeditor /> component in your template:

<template>
	<div id="app">
		<ckeditor value="Hello, World!"></ckeditor>
	</div>
</template>

Instead of using ES6 imports, the component can also be added via a direct script include:

<script src="../node_modules/ckeditor4-vue/dist/ckeditor.js"></script>

and used in the same way as with ES6 imports:

Vue.use( CKEditor );

Refer to the official CKEditor 4 Vue component documentation for more information about the installation process.

Documentation and examples

See the CKEditor 4 WYSIWYG Editor Vue Integration article in the CKEditor 4 documentation.

You can also check out the CKEditor 4 WYSIWYG Editor Vue Integration samples in CKEditor 4 Examples.

Browser support

The CKEditor 4 Vue component works with all the supported browsers except for Internet Explorer.

To enable Internet Explorer 11 support, instead of the standard import you need to import a specific dist/legacy.js file containing all required polyfills:

import CKEditor from 'ckeditor4-vue/dist/legacy.js'

Note: Even though CKEditor 4 supports older Internet Explorer versions including IE8, IE9 and IE10, the Vue integration is only supported in the latest Internet Explorer 11.

Contributing

After cloning this repository, install necessary dependencies:

npm install

Executing tests

Run:

npm run test

If you are going to change the source files (ones located in the src/ directory), remember about rebuilding the package. You can use npm run develop in order to do it automatically.

Building the package

Build a minified version of the package that is ready to be published:

npm run build

License

Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.

For full details about the license, please check the LICENSE.md file.

CKEditor 4 Vue Component 2.4.0 and below for CKEditor 4 Open Source

Licensed under the terms of any of the following licenses at your choice:

• GNU General Public License Version 2 or later,
• GNU Lesser General Public License Version 2.1 or later,
• Mozilla Public License Version 1.1 or later (the "MPL").

CKEditor 4 Vue Component 3.0 and above for CKEditor 4 LTS ("Long Term Support")

CKEditor 4 LTS Vue Component (starting from version 3.0) is available under a commercial license only.

Changelog

ckeditor4-vue 3.2.0

⚠️️️ CKEditor 4 CDN dependency has been upgraded to the latest secure version. All editor versions below 4.25.0-lts can no longer be considered as secure! ⚠️

Other Changes:

• Updated default CDN CKEditor 4 dependency to 4.25.0-lts.