grapesjs-plugin-ckeditor

Replace the built-in RTE with CKEditor

Usage no npm install needed!

<script type="module">
  import grapesjsPluginCkeditor from 'https://cdn.skypack.dev/grapesjs-plugin-ckeditor';
</script>

README

GrapesJS CKEditor

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

GrapesJS


Summary

  • Plugin
    • Name: gjs-plugin-ckeditor
    • Options:
      • options CKEditor's configuration object, eg. { language: 'en', toolbar: [...], ...}
      • position Position side of the toolbar, default: left, options: left|center|right

Download

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: ['gjs-plugin-ckeditor'],
      pluginsOpts: {
        'gjs-plugin-ckeditor': {/* ...options */}
      }
  });
</script>

Development

Clone the repository

$ git clone https://github.com/artf/grapesjs-plugin-ckeditor.git
$ cd grapesjs-plugin-ckeditor

Install dependencies

$ npm i

The plugin relies on GrapesJS and CKEditor via peerDependencies so you have to install them manually

$ npm i grapesjs ckeditor --no-save

Start the dev server

$ npm start

License

BSD 3-Clause