Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/ckeditor/ckeditor4
The best enterprise-grade WYSIWYG editor. Fully customizable with countless features and plugins.
https://github.com/ckeditor/ckeditor4
ckeditor ckeditor4 contenteditable html-editor rich-text-editor rte wysiwyg
Last synced: 28 days ago
JSON representation
The best enterprise-grade WYSIWYG editor. Fully customizable with countless features and plugins.
- Host: GitHub
- URL: https://github.com/ckeditor/ckeditor4
- Owner: ckeditor
- License: other
- Created: 2012-08-20T14:21:13.000Z (about 12 years ago)
- Default Branch: master
- Last Pushed: 2024-08-21T07:42:32.000Z (3 months ago)
- Last Synced: 2024-10-12T22:31:52.124Z (29 days ago)
- Topics: ckeditor, ckeditor4, contenteditable, html-editor, rich-text-editor, rte, wysiwyg
- Language: Rich Text Format
- Homepage: https://ckeditor.com/ckeditor-4
- Size: 132 MB
- Stars: 5,795
- Watchers: 267
- Forks: 2,475
- Open Issues: 1,184
-
Metadata Files:
- Readme: README.md
- Changelog: CHANGES.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Security: SECURITY.md
- Support: .github/SUPPORT.md
Awesome Lists containing this project
README
# CKEditor 4 LTS - Smart WYSIWYG HTML editor [](https://twitter.com/intent/tweet?text=Check%20out%20CKEditor%204%20on%20GitHub&url=https%3A%2F%2Fgithub.com%2Fckeditor%2Fckeditor4)
[](https://www.npmjs.com/package/ckeditor4)
[](https://github.com/ckeditor/ckeditor4)
[](https://dl.circleci.com/status-badge/redirect/gh/ckeditor/ckeditor4/tree/master)
[](http://eepurl.com/c3zRPr)
[](https://twitter.com/ckeditor)
## ⚠️ 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](https://ckeditor.com/ckeditor-4-support/)** ("Long Term Support"), is available under commercial terms (["Extended Support Model"](https://ckeditor.com/ckeditor-4-support/)) 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.
### Important update for CKEditor 4 Users
Starting July 1, 2024, on the first anniversary of the end of life of CKEditor 4, we will activate security notifications for CKEditor 4. This change will impact the open-source version 4.22 and all earlier versions served via our CDN. Read more about the planned changes in a [dedicated article](https://ckeditor.com/blog/important-update-for-ckeditor-4-users/).
## About this repository
### Master branch = CKEditor 4 LTS
After June 30, 2023 the `master` version of the [LICENSE.md](https://github.com/ckeditor/ckeditor4/blob/master/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 that is protected by copyright law.
### Getting CKEditor 4 (Open Source)
You may continue using CKEditor 4.22.1 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, use ****tags 4.22.1 and below****. CKEditor 4.22.1 was the last version of CKEditor 4 available under the open source license terms.
## Summary of options after the CKEditor 4 End of Life
### Upgrading to CKEditor 5
CKEditor 5 is a great new editor with [lots of exciting features](https://ckeditor.com/docs/ckeditor5/latest/features/index.html).
Before upgrading, please be aware of the following changes:
- CKEditor 5 is a completely new editor. **Upgrading is not as simple as replacing the folder with "ckeditor"** - read more in the [Migration from CKEditor 4](https://ckeditor.com/docs/ckeditor5/latest/updating/ckeditor4/migration-from-ckeditor-4.html) guide.
- CKEditor 5 is available only under the GPL copyleft license (or under a commercial license).
- Open source projects with a GPL-incompatible license may apply for a license under the [Free for Open Source](https://ckeditor.com/wysiwyg-editor-open-source/) program.
### Using an outdated, unsupported version
You may continue using CKEditor 4.22.1 (or below). The license terms of the older CKEditor 4 versions have not changed. However, please note that by using software that is no longer maintained, you are introducing a **security risk to your application**.
### Signing an "Extended Support Model" contract
If you are not ready to replace CKEditor 4 in your application yet, you may continue using CKEditor 4 until December 2026.
CKEditor 4 LTS, available under the "Extended Support Model", will ship all important security updates and critical bug fixes, providing an interrupted editing experience for your end users. Please note that this version of CKEditor 4 is available only under a special agreement and requires a license key.
## About CKEditor 4
A highly configurable WYSIWYG HTML editor with hundreds of features, from creating rich text content with captioned images, videos, tables, media embeds, emoji, or mentions to pasting from Word and Google Docs and drag&drop image upload.
It supports a broad range of browsers, including legacy ones.
## Getting started
### Using [npm package](https://www.npmjs.com/package/ckeditor4)
```bash
npm install --save ckeditor4
```
Use it on your website:
```html
This is the editor content.
CKEDITOR.replace( 'editor' );
```
### Using [CDN](https://cdn.ckeditor.com/#ckeditor4)
Load the CKEditor 4 script from the CDN:
```html
This is the editor content.
CKEDITOR.replace( 'editor' );
```
#### CKEditor 4 LTS
Since the introduction of the LTS version of CKEditor (`4.23.0-lts`) in June 2023, all future versions of CKEditor 4 contain `-lts` in their version number.
All future versions of CKEditor 4 (4.23.0-lts and above) are released as CKEditor 4 LTS distributions and require a license key.
If you acquired the [Extended Support Model](https://ckeditor.com/ckeditor-4-support/) for CKEditor 4 LTS, please read [the CKEditor 4 LTS key activation guide.](https://ckeditor.com/docs/ckeditor4/latest/support/licensing/license-key-and-activation.html)
In order to activate CKEditor 4 LTS, add `licenseKey` configure the editor with a valid license key:
```html
CKEDITOR.replace( 'editor', {
licenseKey: 'your license key'
} );
```
### Integrating with Angular, React, and Vue.js
Refer to the official usage guides for the [`ckeditor4-angular`](https://www.npmjs.com/package/ckeditor4-angular#usage), [`ckeditor4-react`](https://www.npmjs.com/package/ckeditor4-react#usage), and [`ckeditor4-vue`](https://www.npmjs.com/package/ckeditor4-vue#installation-and-usage) packages.
### Manual download
Visit the [CKEditor 4 download section](https://ckeditor.com/ckeditor-4/download/) on the [CKEditor website](https://ckeditor.com/ckeditor-4/) to download ready-to-use CKEditor 4 packages or to create a customized CKEditor 4 build.
## Features
* Over 500 plugins in the [Add-ons Repository](https://ckeditor.com/cke4/addons).
* Pasting from Microsoft Word, Excel, and Google Docs.
* Drag&drop image uploads.
* Media embeds to insert videos, tweets, maps, or slideshows.
* Powerful clipboard integration.
* Content quality control with Advanced Content Filter.
* Extensible widget system.
* Custom table selection.
* Accessibility conforming to WCAG and Section 508.
* Over 70 localizations available with full RTL support.
## Browser support
| [
](http://godban.github.io/browsers-support-badges/)
IE / Edge | [
](http://godban.github.io/browsers-support-badges/)
Firefox | [
](http://godban.github.io/browsers-support-badges/)
Chrome | [](http://godban.github.io/browsers-support-badges/)
Chrome (Android) | [
](http://godban.github.io/browsers-support-badges/)
Safari | [
](http://godban.github.io/browsers-support-badges/)
iOS Safari | [
](http://godban.github.io/browsers-support-badges/)
Opera |
| --------- | --------- | --------- | --------- | --------- | --------- | --------- |
| IE8, IE9, IE10, IE11, Edge| latest version| latest version| latest version| latest version| latest version| latest version
Find out more in the [Browser Compatibility guide](https://ckeditor.com/docs/ckeditor4/latest/guide/dev_browsers.html#officially-supported-browsers).
---
## Working with the `ckeditor4` repository
**Attention**: The code in this repository should be used locally and for development purposes only. We do not recommend using it in a production environment because the user experience will be very limited.
### Code installation
There is no special installation procedure to install the development code.
Simply clone it to any local directory and you are set.
### Available branches
This repository contains the following branches:
- **`master`** – Development of the upcoming minor release.
- **`stable`** – Latest stable release tag point (non-beta).
- **`latest`** – Latest release tag point (including betas).
- **`release/A.B.x`** (e.g. `4.0.x`, `4.1.x`) – Release freeze, tests, and tagging. Hotfixing.
Note that the `master` branch is under heavy development. Its code did not pass the release testing phase, though, so it may be unstable.
Additionally, all releases have their respective tags in the following form: `4.4.0`, `4.4.1`, etc. LTS editions have `-lts` at the end: `4.23.0-lts`, etc.
### Samples
The `samples/` folder contains some examples that you can use to test your installation. Visit [CKEditor 4 Examples](https://ckeditor.com/docs/ckeditor4/latest/examples/index.html) for plenty of samples showcasing numerous editor features, with source code readily available to view, copy, and use in your own solution.
### Code structure
The development code contains the following main elements:
- Main coding folders:
- `core/` – The core API of CKEditor 4. Alone, it does nothing, but it provides the entire JavaScript API that makes the magic happen.
- `plugins/` – Contains most of the plugins maintained by the CKEditor 4 core team.
- `skin/` – Contains the official default skin of CKEditor 4.
- `dev/` – Contains some developer tools.
- `tests/` – Contains the CKEditor 4 tests suite.
### Building a release
You can create a release-optimized version of the development code locally. Use the `dev/builder/build.sh` script for that purpose:
> ./dev/builder/build.sh
A "release-ready" working copy of your development code will be built in the new `dev/builder/release/` folder. An Internet connection is necessary to run the builder, at least for the first time.
### Testing environment
Read more on how to set up the environment and execute tests in the [CKEditor 4 Testing Environment](https://ckeditor.com/docs/ckeditor4/latest/guide/dev_tests.html) guide.
### Reporting issues
Use the [CKEditor 4 GitHub issue page](https://github.com/ckeditor/ckeditor4/issues) to report bugs and feature requests.
### License
Copyright (c) 2003-2024, CKSource Holding sp. z o.o. All rights reserved.
For licensing, see LICENSE.md or [https://ckeditor.com/legal/ckeditor-oss-license](https://ckeditor.com/legal/ckeditor-oss-license)
#### CKEditor 4.22.1 and below
CKEditor 4 until version 4.22.1 was licensed under the terms of any of the following licenses of 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.
#### CKEditor 4.23.0-lts and above
CKEditor 4 LTS (starting from version 4.23.0-lts) is available under a commercial license only.