Permalink
Fetching contributors…
Cannot retrieve contributors at this time
385 lines (294 sloc) 15.8 KB
menu-title category order
React component
builds-integration-frameworks
30

Rich text editor component for React

npm version

CKEditor 5 consists of {@link builds/guides/overview ready-to-use editor builds} and {@link framework/guides/overview CKEditor 5 Framework} upon which the builds are based.

The easiest way to use CKEditor 5 in your React application is by choosing one of the {@link builds/guides/overview#available-builds rich text editor builds}. Additionally, it is also possible to integrate CKEditor 5 built from source into your application.

Quick start

### Compatibility with `create-react-app@2`
The latest version of `create-react-app` (2.x) does not work with CKEditor 5 Builds due to a [bug (most likely in Babel)](https://github.com/facebook/create-react-app/issues/5387).

If you want to use CKEditor 5 with an application created via `create-react-app@2` you will need to [eject the configuration even in the development mode](https://github.com/facebook/create-react-app/issues/5387#issuecomment-429255695).

Until the above issue is resolved, in this guide we will use `create-react-app@1` which does not require ejecting the configuration when testing your application in the development mode. You will have to, however, eject it anyway to [build your app for production](#note-building-for-production).

Install the CKEditor 5 WYSIWYG editor component for React and the build of your choice.

Assuming that you picked @ckeditor/ckeditor5-build-classic:

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>"
                    onInit={ editor => {
                        // You can store the "editor" and use when it is needed.
                        console.log( 'Editor is ready to use!', editor );
                    } }
                    onChange={ ( event, editor ) => {
                        const data = editor.getData();
                        console.log( { event, editor, data } );
                    } }
                    onBlur={ editor => {
                        console.log( 'Blur.', editor );
                    } }
                    onFocus={ editor => {
                        console.log( 'Focus.', editor );
                    } }
                />
            </div>
        );
    }
}

export default App;

Component properties

The <CKEditor> component supports the following properties:

  • editor (required) – The {@link module:core/editor/editor~Editor Editor} constructor to use.

  • data – The initial data for the created editor. See the {@link builds/guides/integration/basic-api#interacting-with-the-editor Basic API} guide.

  • config – The editor configuration. See the {@link builds/guides/integration/configuration Configuration} guide.

  • onChange – A function called when the editor's data has changed. See the {@link module:engine/model/document~Document#event:change:data editor.model.document#change:data} event.

    The callback receives two parameters:

    1. An {@link module:utils/eventinfo~EventInfo EventInfo} object,
    2. An {@link module:core/editor/editor~Editor Editor} instance.
  • onInit – A function called when the editor was initialized. It receives the initialized {@link module:core/editor/editor~Editor editor} as a parameter.

  • onBlur – A function called when the editor was blurred. It receives the blurred {@link module:core/editor/editor~Editor editor} as a parameter.

  • onFocus – A function called when the editor was focused. It receives the focused {@link module:core/editor/editor~Editor editor} as a parameter.

  • disabled – A boolean. The {@link module:core/editor/editor~Editor editor} is being switched to read-only mode if the property is set to true.

Customizing the builds

{@link builds/guides/overview 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 {@link builds/guides/integration/configuration#toolbar-setup toolbar} or {@link builds/guides/integration/configuration#removing-features remove some plugins}, in order to add plugins you need to rebuild the editor.

There are two main ways to do that.

  • {@link builds/guides/development/custom-builds 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 {@link builds/guides/integration/installing-plugins Installing plugins}.

  • {@link builds/guides/integration/advanced-setup Integrate the editor from source}.

    In this approach you will include CKEditor 5 built 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 the WYSIWYG editor, 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 work with create-react-app or use a custom configuration for you application but still employ 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 {@link framework/guides/document-editor Document editor}, you need to {@link module:editor-decoupled/decouplededitor~DecoupledEditor.create 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 built from source

Integrating the rich text editor from source allows you to use the full power of {@link framework/guides/overview 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 needs. If you use your custom webpack setup, please read more about {@link builds/guides/integration/advanced-setup#scenario-2-building-from-source including CKEditor 5 built from source}.

Install React CLI:

npm install -g create-react-app@1

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

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

Now you can eject the configuration:

npm run eject

The configuration needs to be ejected in order to be able to customize webpack configuration. To build CKEditor 5 from source you must load inline SVG images and handle CKEditor 5's CSS as well as correctly minify the ES6 source.

You can find more information about ejecting [here](https://github.com/facebook/create-react-app/blob/master/packages/react-scripts/template/README.md#npm-run-eject).

Changes required in webpack's production configuration

At this stage, if you tried to build your application with CKEditor 5 source included, you would get the following error:

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 touch the webpack.config.prod.js file only.

After ejecting, this file is placed in <project_root>/config/webpack.config.prod.js. You need to make the following changes:

  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
  4. Options: compress, mangle and output cannot be passed directly to UglifyJsWebpackPlugin. You need to wrap these options in uglifyOptions: { ... }.

In the end, the entire 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 in both webpack configurations

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.

First, 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

Finally, install the component, the specific editor and plugins you want to use:

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

Using CKEditor 5 source

Now you can use the <CKEditor> component together with {@link framework/guides/overview 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 and reporting issues

The source code of rich text editor component for React is available on GitHub in https://github.com/ckeditor/ckeditor5-react.