# grapesjs-plugin-ckeditor

> Replace the built-in RTE with CKEditor

Latest version **1.0.1** (published 2023-06-06) · BSD-3-Clause license · 0 weekly downloads

## Install

```sh
npm install grapesjs-plugin-ckeditor
pnpm add grapesjs-plugin-ckeditor
yarn add grapesjs-plugin-ckeditor
bun add grapesjs-plugin-ckeditor
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.0.1 |
| Published | 2023-06-06 |
| First published | 2017-04-08 |
| Weekly downloads | 0 |
| License | BSD-3-Clause |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 19.7 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 109 |
| Author | Artur Arseniev |
| Maintainers | artf |
| Keywords | grapesjs, plugin, ckeditor, wysiwyg |

## Links

- npm: https://www.npmjs.com/package/grapesjs-plugin-ckeditor
- Repository: https://github.com/GrapesJS/ckeditor
- Homepage: https://github.com/GrapesJS/ckeditor#readme
- Issues: https://github.com/GrapesJS/ckeditor/issues
- npm.io page: https://npm.io/package/grapesjs-plugin-ckeditor

## Dependencies (1)

- [@types/ckeditor4](https://npm.io/package/@types/ckeditor4.md) ^4.20.0

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 1.0.1 (latest) — 2023-06-06
- 0.0.10 — 2020-12-06
- 0.0.9 — 2017-12-14
- 0.0.5 — 2017-04-08

## README

# GrapesJS CKEditor

This plugin replaces the default Rich Text Editor with the CKEditor

[Demo](https://grapesjs.com/demo-newsletter-editor.html)

<p align="center"><img src="http://grapesjs.com/img/screen-ckeditor.jpg" alt="GrapesJS" align="center"/></p>
<br/>

## Summary

* Plugin name: `grapesjs-plugin-ckeditor`




## Options

|Option|Description|Default|
|-|-|-
|`options`|CKEditor's configuration [object](https://ckeditor.com/docs/ckeditor4/latest/api/CKEDITOR_config.html), 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](https://grapesjs.com/docs/guides/Replace-Rich-Text-Editor.html).|`{}`|
|`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

```html
<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

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

Install dependencies

```sh
$ npm i
```

Start the dev server

```sh
$ npm start
```



## License

BSD 3-Clause

---
_Source: https://npm.io/package/grapesjs-plugin-ckeditor · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._