ckeditor4-react
v5.2.0
Published
Official React component for CKEditor 4 – the best browser-based rich text editor.
Downloads
160,598
Maintainers
Readme
CKEditor 4 WYSIWYG editor component for React
⚠️ 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 React 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 React Component that is protected by copyright law.
Getting CKEditor 4 (Open Source)
You may continue using CKEditor React Component 4.3.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 React Component, use tags 4.3.0 and below. CKEditor React Component 4.3.0 was the last version available under the open source license terms.
About this package
Official CKEditor 4 WYSIWYG editor component for React.
We are looking forward to your feedback! You can report any issues, ideas or feature requests on the integration issues page.
Usage
import React from 'react';
import { CKEditor } from 'ckeditor4-react';
function App() {
return <CKEditor initData="<p>This is an example CKEditor 4 WYSIWYG editor instance.</p>" />;
}
export default App;
Documentation and examples
See the CKEditor 4 WYSIWYG Editor React Integration article in the CKEditor 4 documentation.
You can also check out CKEditor 4 WYSIWYG Editor React Integration example in CKEditor 4 Examples.
For even more examples, check out ready-to-fork samples inside samples directory. Each sample is a self-contained app that can be forked via GitHub or via services such as CodeSandbox. For instance, in order to clone basic
sample, use this link.
React support
The CKEditor 4 React integration was tested with React 18.
TypeScript support
TypeScript 3.5+ is supported.
Browser support
The CKEditor 4 React integration works with all the supported browsers except for Internet Explorer.
Previous versions of ckeditor4-react
also support Internet Explorer 11 (requires additional polyfill for Promise
).
Contributing
See CONTRIBUTING.md.
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 React Component 4.3.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 React Component 5.0 and above for CKEditor 4 LTS ("Long Term Support")
CKEditor 4 LTS React Component (starting from version 5.0) is available under a commercial license only.