https://github.com/divbrands/payload-plugin-ckeditor
Implementation of CKEditor on top of PayloadCMS
https://github.com/divbrands/payload-plugin-ckeditor
payload-plugin
Last synced: about 1 year ago
JSON representation
Implementation of CKEditor on top of PayloadCMS
- Host: GitHub
- URL: https://github.com/divbrands/payload-plugin-ckeditor
- Owner: divbrands
- License: mit
- Created: 2023-10-09T14:15:15.000Z (over 2 years ago)
- Default Branch: main
- Last Pushed: 2023-10-17T03:27:13.000Z (over 2 years ago)
- Last Synced: 2023-11-20T15:13:01.977Z (over 2 years ago)
- Topics: payload-plugin
- Language: JavaScript
- Homepage: https://www.npmjs.com/package/@divbrands/payload-plugin-ckeditor
- Size: 30.3 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Payload Plugin CKEditor
* This plugin is still under development. PR's are welcomed.
This plugin adds a function that returns a `Field` representing CKEditor 5. it is a HTML Editor for simple and efficient editing.
As of now, it uses a minimal build of CKEditor 5. We may change this later.
## Installation
### Install the package
```
yarn add @divbrands/payload-plugin-ckeditor
```
### Import the Field helper on config
```
import { ckeditorField } from "@divbrands/payload-plugin-ckeditor"
```
### Add the field with needed params
```js
fields: [
ckeditorField({
name: "longDescription",
label: "Long Description",
localized: true,
required: true,
}),
],
```
### That's it!
Your new field should present a full blown CkEditor 5 editor saving everything as HTML.