wenliang-developer/ckeditor5-react

Official CKEditor 5 React component.

CKEditor 5 Component for React

Official CKEditor 5 React component.

Note: This is a developer preview. There might be some small bugs and the API might change a little bit.

Table of contents

• Quick start: Using CKEditor 5 builds
  • Component properties
  • Customizing the builds
  • Note: Building for production
  • Note: Using the Document editor build
• Integrating CKEditor 5 from source
• Contributing
• License

Quick start: Using CKEditor 5 builds

The easiest way to use CKEditor 5 in your React application is by choosing one of the editor builds. There are four official builds which you can choose from:

• CKEditor 5 classic editor build
• CKEditor 5 inline editor build
• CKEditor 5 balloon editor build
• CKEditor 5 document editor build (read this note)

Install the component and one of the builds:

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

Use the CKEditor component inside your project:

import React, { Component } from 'react';
import CKEditor from '@ckeditor/ckeditor5-react';
import ClassicEditor from '@ckeditor/ckeditor5-build-classic';

class App extends Component {
	render() {
		return (
			<div className="App">
				<h2>Using CKEditor 5 build in React</h2>
				<CKEditor
					editor={ ClassicEditor }
					data="<p>Hello from CKEditor 5!</p>"
					onChange={ ( event, editor ) => console.log( { event, editor, text: editor.getData() } ) }
				/>
			</div>
		);
	}
}

export default App;

Component properties

The <CKEditor> component supports the following properties:

• editor (required) – The Editor constructor to use.

• data – The initial data for the created editor. See the DataApi#setData() method.

• config – The editor configuration. See the Configuration guide.

• onChange – A function called when the editor's data changed. See the model.Document#change:data event.

  The callback receives two parameters:

  1. an EventInfo object,
  2. an Editor instance.

• onInit – A function called when the editor was initialized. It receives the initialized editor as a parameter.

Customizing the builds

CKEditor 5 builds come ready to use, with a set of built-in plugins and a predefined configuration. While you can change the configuration easily by using the config property of the <CKEditor> component which allows you to change the toolbar or remove some plugins, in order to add plugins you need to rebuild the editor.

There are two main ways to do that.

• Customize one of the existing builds.

  This option does not require any changes in your project's configuration. You will create a new build somewhere next to your project and include it like you included one of the existing builds. Therefore, it is the easiest way to add missing features. Read more about this method in Installing plugins.

• Integrate the editor from source.

  In this approach you will include CKEditor 5 from source — so you will choose the editor creator you want and the list of plugins, etc. It is more powerful and creates a tighter integration between your application and CKEditor 5, however, it requires adjusting your webpack.config.js to CKEditor 5 needs.

  Read more about this option in Integrating CKEditor 5 from source.

Note: Building for production

If you use create-react-app or use a custom configuration for you application but still use webpack@3, you will need to adjust the UglifyJsPlugin options to make CKEditor 5 compatible with this setup. CKEditor 5 builds use ES6 so the default JavaScript minifier of webpack@3 and create-react-app is not able to digest them.

To do that, you need to first eject the configuration from the setup created via create-react-app (assuming that you use it).

npm run eject

Then, you can customize UglifyJsPlugin options in the webpack configuration. Read how to do this here.

Note: The latest webpack@4 comes with a version of UglifyJsPlugin which supports ES6 out of the box. Also, the React community works on allowing importing ES6 libraries into your applications, so this step will soon be no longer required.

Note: Using the document editor build

If you use the Document editor, you need to add the toolbar to the DOM manually:

import DecoupledEditor from '@ckeditor/ckeditor5-build-decoupled-document';

class App extends Component {
	render() {
		return (
			<div className="App">
				<h2>CKEditor 5 using a custom build - DecoupledEditor</h2>
				<CKEditor
					onInit={ editor => {
						console.log( 'Editor is ready to use!', editor );

						// Insert the toolbar before the editable area.
						editor.ui.view.editable.element.parentElement.insertBefore(
							editor.ui.view.toolbar.element,
							editor.ui.view.editable.element
						);
					} }
					onChange={ ( event, editor ) => console.log( { event, editor } ) }
					editor={ DecoupledEditor }
					data="<p>Hello from CKEditor 5's DecoupledEditor!</p>"
					config={ /* the editor configuration */ }
				/>
		);
	}
}

export default App;

Integrating CKEditor 5 from source

Integrating the editor from source allows you to use the full power of the CKEditor 5 Framework.

This guide assumes that you are using Create React App CLI as your boilerplate and it goes through adjusting it to fit CKEditor 5's needs. If you use your custom webpack setup, please read more about including CKEditor 5 from source.

Install React CLI:

npm install -g create-react-app

Create your project using the CLI and go to the project's directory:

create-react-app ckeditor5-react-example && cd ckeditor5-react-example

Ejecting configuration is needed for custom webpack configuration to load inline SVG images and CKEditor 5's CSS. More information about ejecting can be found here.

npm run eject

Changes required in webpack.config.prod.js

Failed to minify the code from this file:                                              [31/75]
        <project_root>/node_modules/@ckeditor/ckeditor5-build-classic/build/ckeditor.js:5:2077

UglifyJS exported by webpack@3 cannot parse code written in ES6. You need to manually replace it with uglifyjs-webpack-plugin. These changes touche the webpack.config.prod.js file only.

After ejecting, this file is placed in <project_root>/config/webpack.config.prod.js.

1. Install uglifyjs-webpack-plugin.

npm install --save-dev uglifyjs-webpack-plugin

2. Load the installed package (at the top of the webpack.config.prod.js file).

const UglifyJsWebpackPlugin = require( 'uglifyjs-webpack-plugin' );

3. Replace the webpack.optimize.UglifyJsPlugin with UglifyJsWebpackPlugin

- new webpack.optimize.UglifyJsPlugin
+ new UglifyJsWebpackPlugin

Options: compress, mangle and output are invaild for UglifyJsWebpackPlugin. You need to wrap these options as uglifyOptions.

The whole plugin definition should look as follows:

// Minify the code.
new UglifyJsWebpackPlugin( {
  uglifyOptions: {
    compress: {
      warnings: false,
      // Disabled because of an issue with Uglify breaking seemingly valid code:
      // https://github.com/facebookincubator/create-react-app/issues/2376
      // Pending further investigation:
      // https://github.com/mishoo/UglifyJS2/issues/2011
      comparisons: false,
    },
    mangle: {
        safari10: true,
    },
    output: {
        comments: false,
        // Turned on because emoji and regex is not minified properly using default
        // https://github.com/facebookincubator/create-react-app/issues/2488
        ascii_only: true,
    },
  },
  sourceMap: shouldUseSourceMap,
} )

Changes required for both webpack configurations (webpack.config.dev.js and webpack.config.prod.js)

In order to build your application properly, you need to modify your webpack configuration files. After ejecting they are located at:

<project_root>/config/webpack.config.dev.js
<project_root>/config/webpack.config.prod.js

You need to modify the webpack configuration to load CKEditor 5 SVG icons properly.

At the beginning import an object that creates the configuration for PostCSS:

const { styles } = require( '@ckeditor/ckeditor5-dev-utils' );

Then add two new elements to the exported object under the module.rules array (as new items for the oneOf array). These are SVG and CSS loaders only for CKEditor 5 code:

{
  test: /ckeditor5-[^/\\]+[/\\]theme[/\\]icons[/\\][^/\\]+\.svg$/,
  use: [ 'raw-loader' ]
},
{
  test: /ckeditor5-[^/\\]+[/\\]theme[/\\].+\.css/,
  use: [
    {
      loader: 'style-loader',
      options: {
        singleton: true
      }
    },
    {
      loader: 'postcss-loader',
      options: styles.getPostCssConfig( {
        themeImporter: {
          themePath: require.resolve( '@ckeditor/ckeditor5-theme-lark' )
        },
        minify: true
      } )
    }
  ]
},

Exclude CSS files used by CKEditor 5 from project's CSS loader:

{
  test: /\.css$/,
  exclude: /ckeditor5-[^/\\]+[/\\]theme[/\\].+\.css/,
  // (...)
}

And exclude CKEditor 5 SVG and CSS files from file-loader because these files will be handled by the loaders added previously (usually the last item in the module.rules array is the file-loader) so it looks like this:

{
  loader: require.resolve('file-loader'),
  // Exclude `js` files to keep the "css" loader working as it injects
  // its runtime that would otherwise be processed through the "file" loader.
  // Also exclude `html` and `json` extensions so they get processed
  // by webpack's internal loaders.
  exclude: [
  	/\.(js|jsx|mjs)$/,
  	/\.html$/,
  	/\.json$/,
  	/ckeditor5-[^/\\]+[/\\]theme[/\\]icons[/\\][^/\\]+\.svg$/,
  	/ckeditor5-[^/\\]+[/\\]theme[/\\].+\.css/
  ],
  options: {
    name: 'static/media/[name].[hash:8].[ext]'
  }
}

Remember that the changes above should be done in both configuration files.

Next, install raw-loader, the theme for CKEditor 5 and CKEditor 5 development utilities:

npm install --save-dev raw-loader @ckeditor/ckeditor5-theme-lark @ckeditor/ckeditor5-dev-utils

Install the component, editor and plugins you need:

npm install --save \
	@ckeditor/ckeditor5-react \
	@ckeditor/ckeditor5-editor-classic \
	@ckeditor/ckeditor5-essentials \
	@ckeditor/ckeditor5-basic-styles \
	@ckeditor/ckeditor5-heading \
	@ckeditor/ckeditor5-paragraph

Use the CKEditor component together with CKEditor 5 Framework:

import React, { Component } from 'react';
import CKEditor from '@ckeditor/ckeditor5-react';

import ClassicEditor from '@ckeditor/ckeditor5-editor-classic/src/classiceditor';
import Essentials from '@ckeditor/ckeditor5-essentials/src/essentials';
import Paragraph from '@ckeditor/ckeditor5-paragraph/src/paragraph';
import Bold from '@ckeditor/ckeditor5-basic-styles/src/bold';
import Italic from '@ckeditor/ckeditor5-basic-styles/src/italic';
import Heading from '@ckeditor/ckeditor5-heading/src/heading';

class App extends Component {
	render() {
		return (
			<div className="App">
				<h2>Using CKEditor 5 Framework in React</h2>
				<CKEditor
					onInit={ editor => console.log( 'Editor is ready to use!', editor ) }
					onChange={ ( event, editor ) => console.log( { event, editor } ) }
					config={ {
						plugins: [ Essentials, Paragraph, Bold, Italic, Heading ],
						toolbar: [ 'heading', '|', 'bold', 'italic', '|', 'undo', 'redo', ]
					} }
					editor={ ClassicEditor }
					data="<p>Hello from CKEditor 5!</p>"
				/>
			</div>
		);
	}
}

export default App;

Contributing

Having cloned this repository, install necessary dependencies:

npm install

Executing tests

npm run tests -- [additional options]
# or
npm t -- [additional options]

It accepts the following options:

• --coverage (-c) – Whether to generate the code coverage.
• --source-map (-s) – Whether to attach the source maps.
• --watch (-w) – Whether to watch test files.
• --reporter (-r) – Reporter for Karma (default: mocha, can be changed to dots).
• --browsers (-b) – Browsers that will be used to run tests (default: Chrome, available: Firefox, BrowserStack_Edge and BrowserStack_Safari).

Note: If you would like to use the BrowserStack_* browser, you need to specify the BROWSER_STACK_USERNAME and BROWSER_STACK_ACCESS_KEY as an environment variable, e.g.:

BROWSER_STACK_USERNAME=[...] BROWSER_STACK_ACCESS_KEY=[...] npm t -- -b BrowserStack_Edge,BrowserStack_Safari -c

If you are going to change the source (src/ckeditor.jsx) file, remember about rebuilding the package. You can use npm run develop in order to do it automatically.

Building the package

Build a minified version of the package that is ready to publish:

npm run build

Changelog generator

npm run changelog

Releasing

Before starting to release the package, you need to generate the changelog.

npm run release

Note: Only the dist/ directory will be published.

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.