Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@requarks/ckeditor5

Requarks1.9kGPL-2.0-or-later19.0.1-wiki.2

Custom CKEditor5 component build for Wiki.js

ckeditor5-build, ckeditor, ckeditor5, ckeditor 5, wysiwyg, rich text, editor, html, contentEditable, editing, operational transformation, ot, collaboration, collaborative, real-time, framework

readme

CKEditor 5 document editor build

Join the chat at https://gitter.im/ckeditor/ckeditor5 npm version Build Status
Dependency Status devDependency Status

The document editor build for CKEditor 5, featuring the decoupled UI editor implementation. Read more about the document editor build and see the demo.

CKEditor 5 decoupled document editor build screenshot

Documentation

See:

Quick start

First, install the build from npm:

npm install --save @ckeditor/ckeditor5-build-decoupled-document

And use it in your website:

<div id="editor">
    <p>This is the editor content.</p>
</div>
<script src="./node_modules/@ckeditor/ckeditor5-build-decoupled-document/build/ckeditor.js"></script>
<script>
    DecoupledEditor
        .create( '<h2>Hello world!</h2>', {
            toolbarContainer: document.querySelector( '.toolbar-container' ),
            editableContainer: document.querySelector( '.editable-container' )
        } )
        .then( editor => {
            window.editor = editor;
        } )
        .catch( err => {
            console.error( err.stack );
        } );
</script>

Or in your JavaScript application:

import DecoupledEditor from '@ckeditor/ckeditor5-build-decoupled-document';

// Or using the CommonJS version:
// const DecoupledEditor = require( '@ckeditor/ckeditor5-build-decoupled-document' );

DecoupledEditor
    .create( '<h2>Hello world!</h2>', {
        toolbarContainer: document.querySelector( '.toolbar-container' ),
        editableContainer: document.querySelector( '.editable-container' )
    } )
    .then( editor => {
        window.editor = editor;
    } )
    .catch( err => {
        console.error( err.stack );
    } );

Note: If you are planning to integrate CKEditor 5 deep into your application, it is actually more convenient and recommended to install and import the source modules directly (like it happens in ckeditor.js). Read more in the Advanced setup guide.

License

Licensed under the terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file or https://ckeditor.com/legal/ckeditor-oss-license.

changelog

Changelog

12.4.0 (2019-08-26)

This release brings a huge set of new features: image resizing, to-do lists, support for RTL languages, simple upload adapter, support for pasting from Google Docs, mathematic formulas, and spelling and grammar checking. In addition to that, as always, it contains many improvements and bug fixes.

Dependencies

Major releases (contain breaking changes):

Minor releases:

Patch releases (bug fixes, internal changes):

Other changes

12.3.1 (2019-07-10)

We are happy to report the release of CKEditor 5 v12.3.0 (and v12.3.1 with a small fix). This release introduces several new features (word count, automatic text transformations, ability to control link attributes such as target and block indentation). It also brings improvements to existing features (e.g. the "document colors" section in the font color picker dropdowns) and many bug fixes.

Dependencies

Patch releases (bug fixes, internal changes):

12.3.0 (2019-07-04)

Dependencies

Major releases (contain breaking changes):

Minor releases:

Patch releases (bug fixes, internal changes):

12.2.0 (2019-06-05)

We are happy to report the release of CKEditor 5 v12.2.0. This is a minor release with many bug fixes and a new UI feature which allows to navigating between multiple balloons.

Note: The config.table.toolbar property that had been deprecated last year has now been completely removed. Use config.table.contentToolbar instead.

Dependencies

Major releases (contain breaking changes):

Minor releases:

Patch releases (bug fixes, internal changes):

12.1.0 (2019-04-10)

We are happy to report the release of CKEditor 5 v12.1.0. This release introduces 3 new features (mentions, font color and background color and remove format).

Check out the linked guides for information how to install and configure those features in your editor.

Dependencies

Minor releases:

Patch releases (bug fixes, internal changes):

12.0.0 (2019-02-28)

We are happy to report the release of CKEditor 5 v12.0.0. This release introduces a new editor (called "Balloon block editor"), the editor content placeholder and support for inline widgets (watch this PR for updates). In addition to that we enabled media embeds and images in tables and resolved the issue where editor.getData() returned <p>&nbsp;</p> for empty content (now it returns an empty string in this case).

Besides new features, this release contains many improvements to stability, performance and API. The last group of changes contain many breaking ones. Make sure to read the main package's changelog.

Dependencies

Major releases (contain breaking changes):

BREAKING CHANGES

11.2.0 (2018-12-05)

We are happy to report the release of CKEditor 5 v11.2.0. This editor version brings the long-awaited support for paste from Office (e.g. from Microsoft Word), integration with CKFinder file manager, improved image upload documentation, improved editor UI on mobile devices, as well as many smaller features and improvements.

Blog post is comming soon...

Dependencies

New packages:

Major releases (contain breaking changes):

Minor releases:

Patch releases (bug fixes, internal changes):

11.1.1 (2018-10-11)

This releases fixes the README of this package on npm.

11.1.0 (2018-10-08)

This is a minor release. Besides updating all used CKEditor 5 packages to their latest versions it brings the Media embed feature which is now enabled in this build by default.

Read more in the blog post: https://ckeditor.com/blog/CKEditor-5-v11.1.0-released/

Dependencies

Major releases (contain breaking changes):

Minor releases:

Patch releases (bug fixes, internal changes):

Features

Besides new features introduced by the dependencies, this version also introduces the following features:

11.0.1 (2018-07-18)

Internal changes only (updated dependencies, documentation, etc.).

11.0.0 (2018-07-18)

Release notes

This is a major releases that introduces many smaller features, dozens of bug fixes and a couple of infrastructure changes (an upgrade to webpack@4, simplified structure of the build repository). Additionally, the DecoupledEditor#element property was renamed to DecoupledEditor#sourceElement.

If you maintain a custom build of CKEditor 5 or integrate CKEditor 5 from source, we recommend reading the migration guide.

Blog post is coming soon...

Dependencies

Major releases (contain breaking changes):

Minor releases:

Patch releases (bug fixes, internal changes):

Other changes

BREAKING CHANGES

If you maintain a custom build, we recommend reading the migration guide. Closes ckeditor/ckeditor5#1038.

  • CKEditor 5 environment was updated to use webpack@4. webpack@4 introduced major changes in its configuration and plugin system. CKEditor 5 tools and build configuration were updated to work with webpack@4 and will not work with webpack@3.
  • The structure of the build repository was changed. The build-config.js file was removed and the build configuration is now kept only in the src/ckeditor.js file.

10.1.0 (2018-06-21)

This is a minor release that introduces many bug fixes and new features. Most notable ones are the table plugin and support for inserting soft breaks with <kbd>Shift</kbd>+<kbd>Enter</kbd>.

You can read more in the blog post.

Dependencies

New packages:

Major releases (contain breaking changes):

Minor releases:

Patch releases (bug fixes, internal changes):

Features

Besides new features introduced by the dependencies, this version also introduces the following features:

  • Added the table feature to the build. Closes #12. (58bfd46)

10.0.1 (2018-05-22)

Dependencies

Patch releases (bug fixes, internal changes):

10.0.0 (2018-04-25)

Dependencies

Major releases (contain breaking changes):

Other changes

BREAKING CHANGES

  • The license under which CKEditor 5 is released has been changed from a triple GPL, LGPL and MPL license to a GPL2+ only. See ckeditor/ckeditor5#991 for more information.

1.0.0-beta.4 (2018-04-19)

Dependencies

Major releases (contain breaking changes):

Other changes

  • Image styles's default configuration has been changed to: left-aligned, right-aligned image and full-size image (instead of the typical: side-image and full-size image). This change makes content previously created with this build incompatible with the new setup.

    You can configure image styles in order to bring back the old setting ([ 'full', 'side' ]).

    Closes #10. (75855d9)

BREAKING CHANGES

  • The default image styles configuration has been changed (see the section above for more information).

1.0.0-beta.3 (2018-04-10)

NOTE

This release followed v1.0.0-beta.2 immediately to fix the issue mentioned below. Therefore, when upgrading from v1.0.0-beta.1 make sure to also check v1.0.0-beta.2 release notes.

Bug fixes

1.0.0-beta.2 (2018-04-10)

Note: Make sure to see the BREAKING CHANGES section below.

Dependencies

Major releases (contain breaking changes):

Other changes

BREAKING CHANGES

  • The global variable exported by the build is now called DecoupledEditor instead of DecoupledDocumentEditor. See #6.
  • The config options config.toolbarContainer and config.editableContainer have been removed. Please refer to the DecoupledEditor class API documentation to learn about possible methods of bootstrapping the UI.

1.0.0-beta.1 (2018-03-15)

Features

  • Implemented the document editor build on top of the decoupled editor. Closes #1. (5bf2a07)