Skip to main content

CKEditor

Description​

<jp-ckeditor> is a text editor form component.

It's a wrapper around https://ckeditor.com/.


Attributes​

NameRequiredTypeDescription
serviceImageServiceservice that handles image adding
valuestringsetter
optionsObjectCKEditor config
idstringunique identifier
name✓stringname of the form control
labelstringshows at the top
heightstringdefines the height of the editable area
widthstringdefines the width of the editable area


Interfaces​

ImageService​

Defines the accepted file types and provides a method to upload a file.



Properties​
NameRequiredTypeDescription
uploadFilefunctionuploads a file and returns a promise
which is a string that represents an identifier for the image


Dependencies​

In order for this component to work you have to include the following

<script src="https://cdn.ckeditor.com/ckeditor5/41.2.1/super-build/ckeditor.js"></script>


Slots​

This component does not have any slots.



Methods​

  • getValue
    • returns form field value


Events​

  • value
    • triggers when value of the editor changes


Demo​

Live Editor
// import '@jaspero/web-components/ckeditor.wc.js';
// import '@jaspero/web-components/ckeditor.css';

<jp-ckeditor value="<p>Blup</p>"></jp-ckeditor>
Result
Loading...