@ckeditor/ckeditor5-inspector

CKEditor 5 inspector

The official CKEditor 5 rich text editor instance inspector for developers.

Usage

Include the script to load the inspector:

<script src="path/to/inspector.js"></script>

Call CKEditorInspector.attach( name, editor ) when editor instance is ready:

ClassicEditor
    .create( ... )
    .then( editor => {
        CKEditorInspector.attach( 'editor-name', editor );
    } )
    .catch( error => {
        console.error( error );
    } );

Note: You can attach multiple editors to the inspector. Select the editor instance in the drop–down inside the inspector panel to switch context.

Call CKEditorInspector.detach( name ) to detach an instance from the inspector.

Compatibility

The inspector works with CKEditor 5 v12.0.0+.

Development

To configure the environment:

git clone [e-mail]:ckeditor/ckeditor5-inspector.git
cd ckeditor5-inspector
yarn install

Working with the code

Start the webpack file watcher:

yarn dev

and open http://path/to/ckeditor5-inspector/sample in your web browser.

Building

To build the production version of the inspector, run:

yarn build

Releasing

The release process is as follows (order matters):

Note: We recommend using npm for that.

npm run changelog
npm run preversion

Run the sample and make sure global CKEDITOR_INSPECTOR_VERSION is right. Then:

npm run release

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.

Changelog

1.2.0 (2019-03-11)

Features

• Implemented vertical inspector resizing. Closes #4. (97d56aa)