@dkaufmann/ckeditor5-build-decoupled-custom-document

    19.2.0 • Public • Published

    CKEditor 5 document editor build

    npm version Build Status
    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

    Documentation

    See:

    Quick start

    First, install the build from npm:

    npm install --save @ckeditor/ckeditor5-build-decoupled-document

    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/@ckeditor/ckeditor5-build-decoupled-document/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 '@ckeditor/ckeditor5-build-decoupled-document';
    
    // Or using the CommonJS version:
    // const DecoupledEditor = require( '@ckeditor/ckeditor5-build-decoupled-document' );
    
    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.

    Install

    npm i @dkaufmann/ckeditor5-build-decoupled-custom-document

    DownloadsWeekly Downloads

    3

    Version

    19.2.0

    License

    GPL-2.0-or-later

    Unpacked Size

    5.4 MB

    Total Files

    65

    Last publish

    Collaborators

    • dkaufmann