/grapesjs_ckeditor

This plugin replaces the default Rich Text Editor with the one from CKEditor

Primary LanguageTypeScriptBSD 3-Clause "New" or "Revised" LicenseBSD-3-Clause

GrapesJS CKEditor

This plugin replaces the default Rich Text Editor with the CKEditor

Demo

GrapesJS


Summary

  • Plugin name: grapesjs-plugin-ckeditor

Options

Option Description Default
options CKEditor's configuration object, eg. { language: 'en', toolbar: [...], ...} {}
position Position side of the toolbar, options: left, center, right left
ckeditor Pass CKEDITOR constructor or the CDN string from which the CKEDITOR will be loaded. https://cdn.ckeditor.com/4.21.0/standard-all/ckeditor.js
customRte Extend the default customRTE interface. {}
onToolbar Customize CKEditor toolbar element once created, eg. onToolbar: (el) => { el.style.minWidth = '350px' } ``

Download

  • CDN
    • https://unpkg.com/grapesjs-plugin-ckeditor
  • NPM
    • npm i grapesjs-plugin-ckeditor
  • GIT
    • git clone https://github.com/GrapesJS/ckeditor.git

Usage

<link href="path/to/grapes.min.css" rel="stylesheet"/>
<script src="path/to/grapes.min.js"></script>
<script src="path/to/grapesjs-plugin-ckeditor.min.js"></script>

<div id="gjs"></div>

<script type="text/javascript">
  var editor = grapesjs.init({
      container : '#gjs',
      plugins: ['grapesjs-plugin-ckeditor'],
      pluginsOpts: {
        'grapesjs-plugin-ckeditor': {/* ...options */}
      }
  });
</script>

Development

Clone the repository

$ git clone https://github.com/GrapesJS/ckeditor.git
$ cd ckeditor

Install dependencies

$ npm i

Start the dev server

$ npm start

License

BSD 3-Clause