JSPM

@ckeditor/ckeditor5-build-classic

0.2.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 151611
  • Score
    100M100P100Q23488F
  • License (GPL-2.0 OR LGPL-2.1 OR MPL-1.1)

CKEditor 5 classic build.

Package Exports

  • @ckeditor/ckeditor5-build-classic

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (@ckeditor/ckeditor5-build-classic) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

CKEditor 5 classic build

npm version Dependency Status devDependency Status

Classic build of CKEditor 5. Features the classic creator and the standard set of article features.

Bundles

The package contain two bundles of the classic editor:

  • build/ckeditor.js – minified, ES6 version of the bundle,
  • build/ckeditor.compat.js – minified, backward-compatible version of the bundle (babel-preset-env is configured to support 'last 2 versions', 'ie >= 11').

Usage

First, install the build from npm:

npm install --save @ckeditor/ckeditor5-build-classic

And use it in your website:

<div id="editor">
    <p>This is the editor content.</p>
</div>
<script src="./node_modules/@ckeditor/ckeditor5-build-classic/build/ckeditor.js"></script>
<script>
ClassicEditor.create( document.querySelector( '#editor' ) )
    .then( editor => {
        window.editor = editor;
    } )
    .catch( err => {
        console.error( err.stack );
    } );
</script>

Or in your JavaScript application:

import { ClassicEditor } from '@ckeditor/ckeditor5-build-classic/build/ckeditor';

// or using CommonJS verion:
// const ClassicEditor = require( '@ckeditor/ckeditor5-build-classic/build/ckeditor' ).ClassicEditor;

ClassicEditor.create( document.querySelector( '#editor' ) )
    .then( editor => {
        window.editor = editor;
    } )
    .catch( err => {
        console.error( err.stack );
    } );

Note: If you're planning to integrate CKEditor 5 deep into your application it's actually more convenient and recommended to install and import the source modules directly (like it happens in ckeditor.js).

Rebuilding the bundle

Note: This section assumes that you cloned this package repository and execute the commands inside it.

You can modify config-editor.js, config-build.js or any of the Webpack configs and run:

npm run build

To rebuild the entry-point (ckeditor.js) and both builds (build/*).

You can also modify ckeditor.js directly and run one of npm run build-ckeditor or npm run build-ckeditor-compat.

License

Licensed under the GPL, LGPL and MPL licenses, at your choice. For full details about the license, please check the LICENSE.md file.