0.0.4 • Published 4 years ago

ckeditor5-build-decoupled-codefusion v0.0.4

Weekly downloads
6
License
GPL-2.0-or-later
Repository
github
Last release
4 years ago

CKEditor 5 document editor build

Custom build of CKEditor 5 decoupled document build. Forked from the official repository.

npm version Dependency Status devDependency Status

The document editor build for CKEditor 5, featuring the decoupled UI editor implementation. Read more about the document editor build and see the demo.

CKEditor 5 decoupled document editor build screenshot

Plugins Included

  • Essentials
  • Alignment
  • FontSize
  • FontFamily
  • FontColor
  • FontBackgroundColor
  • UploadAdapter
  • Autoformat
  • Bold
  • Italic
  • Strikethrough
  • Underline
  • BlockQuote
  • CKFinder
  • Heading
  • Indent
  • IndentBlock
  • Link
  • List
  • ListStyle
  • Paragraph
  • PasteFromOffice
  • Table
  • TableToolbar
  • TableProperties
  • TableCellProperties
  • TextTransformation
  • PageBreak
  • SpecialCharacters
  • SpecialCharactersEssentials
  • HorizontalLine

Documentation

See:

Quick start

First, install the build from npm:

npm install --save ckeditor5-build-decoupled-codefusion

And use it in your website:

<div id="toolbar-container"></div>
<div id="editor">
	<p>This is the editor content.</p>
</div>
<script src="./node_modules/ckeditor5-build-decoupled-codefusion/build/ckeditor.js"></script>
<script>
	DecoupledEditor
		.create( document.querySelector( '#editor' ) )
		.then( editor => {
			// The toolbar needs to be explicitly appended.
			document.querySelector( '#toolbar-container' ).appendChild( editor.ui.view.toolbar.element );

			window.editor = editor;
		} )
		.catch( error => {
			console.error( 'There was a problem initializing the editor.', error );
		} );
</script>

Or in your JavaScript application:

import DecoupledEditor from 'ckeditor5-build-decoupled-codefusion';

// Or using the CommonJS version:
// const DecoupledEditor = require( 'ckeditor5-build-decoupled-codefusion' );

DecoupledEditor
	.create( document.querySelector( '#editor' ) )
	.then( editor => {
		// The toolbar needs to be explicitly appended.
		document.querySelector( '#toolbar-container' ).appendChild( editor.ui.view.toolbar.element );

		window.editor = editor;
	} )
	.catch( error => {
		console.error( 'There was a problem initializing the editor.', error );
	} );

Note: If you are planning to integrate CKEditor 5 deep into your application, it is actually more convenient and recommended to install and import the source modules directly (like it happens in ckeditor.js). Read more in the Advanced setup guide.

License

Licensed under the terms of GNU General Public License Version 2 or later. For full details about the license, please check the LICENSE.md file or https://ckeditor.com/legal/ckeditor-oss-license.