DataTables logo
≡

CKEditor v5

WYSIWYG editor

Use the next generation of the popular CKEditor v5 WYSIWYG input control in Editor to allow easy creation of complex HTML and Markdown content in a regular form field.

This plug-in supports all three types of editing mode provided by CKEditor v5:

  • For the classic editing interface use a field type of ckeditorClassic
  • For CKEditor balloon editing use ckeditorBalloon
  • For CKEditor inline editing use ckeditorInline

Please refer to the CKEditor documentation for the difference between the various types. You will need to load the CKEditor Javascript for the editor that you wish to use.

Use

This plug-in can be obtained and used in multiple different ways.

Browser

This plug-in is available on the DataTables CDN:

JS

The plug-in will then automatically register itself against a global DataTables instance. This file can also be used if you are using an AMD loader such as Require.js.

Note that if you are using multiple plug-ins, it can be beneficial in terms of performance to combine the plug-ins into a single file and host it on your own server, rather than making multiple requests to the DataTables CDN.

NPM

The plug-ins are all available on NPM (which can also be used with Yarn or any other Javascript package manager) as part of the datatables.net-plugins package. To use this plug-in, first install the plug-ins package:

npm install datatables.net-plugins

Then import datatables.net, any other DataTables extensions you need, plus the plug-in:

import DataTable from 'datatables.net';
import 'datatables.net-plugins/editorFields/editor.ckeditor5.mjs';

Example

new DataTable.Editor( {
 "ajax": "/api/customers",
 "table": "#customers",
 "fields": [ {
     "label": "Info:",
     "name": "info",
     "type": "ckeditorClassic"
   },
   // additional fields...
 ]
} );

Version control

If you have any ideas for how this plug-in can be improved, or spot anything that is in error, it is available on GitHub and pull requests are very welcome!