Contribute to this guideReport an issue

guideDocument editor

The document editor example showcases the document editor build designed for document editing with a customized UI representing the layout of a sheet of paper. It was created on top of the DecoupledEditor class and makes the best of what it offers: the freedom to choose the location of the crucial UI elements in the application.

In this tutorial you will learn how to create your own document editor with a customized user interface, step–by–step.

The Flavorful Tuscany Meetup

Welcome letter

Dear Guest,

We are delighted to welcome you to the annual Flavorful Tuscany Meetup and hope you will enjoy the programme as well as your stay at the Bilancino Hotel.

Please find below the full schedule of the event.

  • 9:30 AM - 11:30 AM Americano vs. Brewed - “know your coffee” session with Stefano Garau
  • 1:00 PM - 3:00 PM Pappardelle al pomodoro - live cooking session with Rita Fresco
  • 5:00 PM - 8:00 PM Tuscan vineyards at a glance - wine-tasting session with Frederico Riscoli

The annual Flavorful Tuscany meetups are always a culinary discovery. You get the best of Tuscan flavors during an intense one-day stay at one of the top hotels of the region. All the sessions are lead by top chefs passionate about their profession. I would certainly recommend to save the date in your calendar for this one!

Angelina Calvino, food journalist

Please arrive at the Bilancino Hotel reception desk at least half an hour earlier to make sure that the registration process goes as smoothly as possible.

We look forward to welcoming you to the event.

Victoria Valc

Event Manager

Bilancino Hotel

# The editor

The document editor build includes all the necessary features for the task. All you need to do is import it and create a new instance.

See the quick start guide to learn how to install the document editor build.

The document editor can be created using the existing data container in the DOM. It can also accept a raw data string and create the editable by itself. To get the output data, use the getData() method.

See the DecoupledEditor.create() to learn about different approaches to the initialization of the editor.

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

DecoupledEditor
    .create( document.querySelector( '.document-editor__editable' ), {
        cloudServices: {
            ....
        }
    } )
    .then( editor => {
        const toolbarContainer = document.querySelector( '.document-editor__toolbar' );

        toolbarContainer.appendChild( editor.ui.view.toolbar.element );

        window.editor = editor;
    } )
    .catch( err => {
        console.error( err );
    } );

You may have noticed that you have to make sure the editor UI is injected into your application after it fires the Editor#uiReady event. The toolbar element can be found under editor.ui.view.toolbar.element.

The document editor supports the Easy Image plugin provided by CKEditor Cloud Services out of the box. Please refer to the documentation to learn more.

# The user interface

The code you have just created will run the editor but still, the user interface is missing. Start off with a basic HTML structure to host the editor components (toolbar and editable).

# HTML

The following structure has two containers that correspond to the configuration you have just used. The editor will inject the toolbar and editable into respective containers as it starts.

<div class="document-editor">
    <div class="document-editor__toolbar"></div>
    <div class="document-editor__editable-container">
        <div class="document-editor__editable">
            <p>The initial editor data.</p>
        </div>
    </div>
</div>

The <div class="document-editor">...</<div> element is the outermost container of the document editor and, although not mandatory, it is recommended to keep things together.

Make sure the HTML structure is available in the DOM when the editor is created. To do so, put the editor bootstrap code somewhere later in HTML or use the DOMContentLoaded event to defer your JavaScript execution until the DOM is up and ready.

# Styles

Styles are what the document editor really needs to materialize. Begin with the styles of the main container:

.document-editor {
    border: 1px solid var(--ck-color-base-border);
    border-radius: var(--ck-border-radius);

    /* Set vertical boundaries for the document editor. */
    max-height: 700px;

    /* This element is a flex container for easier rendering. */
    display: flex;
    flex-flow: column nowrap;
    overflow: hidden;
}

Then, make the toolbar look like it floats over the “page”:

.document-editor__toolbar {
    /* Make sure the toolbar container is always above the editable. */
    z-index: 1;

    /* Create the illusion of the toolbar floating over the editable. */
    box-shadow: 0 0 5px hsla( 0,0%,0%,.2 );

    /* Use the CKEditor CSS variables to keep the UI consistent. */
    border-bottom: 1px solid var(--ck-color-toolbar-border);
}

/* Adjust the look of the toolbar inside the container. */
.document-editor__toolbar .ck-toolbar {
    border: 0;
    border-radius: 0;
}

The editable should look like a sheet of paper, centered in its scrollable container:

/* Make the editable container look like the inside of a native word processor application. */
.document-editor__editable-container {
    padding: calc( 2 * var(--ck-spacing-large) );
    background: var(--ck-color-base-foreground);

    /* Make it possible to scroll the "page" of the edited content. */
    overflow-y: scroll;
}

.document-editor__editable-container .ck-editor__editable {
    /* Set the dimensions of the "page". */
    width: 15.8cm;
    min-height: 21cm;

    /* Keep the "page" off the boundaries of the container. */
    padding: 1cm 2cm 2cm;

    border: 1px hsl( 0,0%,82.7% ) solid;
    border-radius: var(--ck-border-radius);
    background: white;

    /* The "page" should cast a slight shadow (3D illusion). */
    box-shadow: 0 0 5px hsla( 0,0%,0%,.1 );

    /* Center the "page". */
    margin: 0 auto;
}

All you need to do now is style the actual content of the editor. Start with defining some basic font styles:

/* Set the default font for the "page" of the content. */
.document-editor .ck-content,
.document-editor .ck-heading-dropdown .ck-list {
    font: 16px/1.6 "Helvetica Neue", Helvetica, Arial, sans-serif;
}

Then focus on headings and paragraphs. Note that what the users see in the headings dropdown should correspond to the actual edited content for the best user experience.

It is recommended to use the .ck-content CSS class to visually style the content of the editor (headings, paragraphs, lists, etc.).

/* Adjust the headings dropdown to host some larger heading styles. */
.document-editor .ck-heading-dropdown .ck-dropdown__panel .ck-list > .ck-list__item {
    line-height: calc( 1.2 * var(--ck-line-height-base) * var(--ck-font-size-base) );
    min-width: 8em;
}

/* Set the styles for "Heading 1". */
.document-editor .ck-content h2,
.document-editor .ck-heading-dropdown .ck-heading_heading1 {
    font-size: 2.18em;
}

.document-editor .ck-content h2 {
    line-height: 1.37em;
    padding-top: .342em;
    margin-bottom: .142em;
}

/* Set the styles for "Heading 2". */
.document-editor .ck-content h3,
.document-editor .ck-heading-dropdown .ck-heading_heading2 {
    font-size: 1.75em;
    color: hsl( 203, 100%, 50% );
}

.document-editor .ck-heading-dropdown .ck-heading_heading2.ck-list__item_active {
    color: var(--ck-color-list-item-text-active);
}

/* Set the styles for "Heading 2". */
.document-editor .ck-content h3 {
    line-height: 1.86em;
    padding-top: .171em;
    margin-bottom: .357em;
}

/* Set the styles for "Heading 3". */
.document-editor .ck-content h4,
.document-editor .ck-heading-dropdown .ck-heading_heading3 {
    font-size: 1.31em;
}

.document-editor .ck-content h4 {
    line-height: 1.24em;
    padding-top: .286em;
    margin-bottom: .952em;
}

/* Set the styles for "Paragraph". */
.document-editor .ck-content p,
.document-editor .ck-heading-dropdown .ck-heading_paragraph {
    font-size: 1em;
}

.document-editor .ck-content p {
    line-height: 1.63em;
    padding-top: .5em;
    margin-bottom: 1.13em;
}

A finishing touch that makes the block quotes more sophisticated and the styling is complete.

/* Make the block quoted text serif with some additional spacing. */
.document-editor .ck-content blockquote {
    font-family: Georgia, serif;
    margin-left: calc( 2 * var(--ck-spacing-large) );
    margin-right: calc( 2 * var(--ck-spacing-large) );
}

# Summary

The document editor is ready to use. Still, you may want to configure some features like highlight, font size or font family for the best editing experience.

Thanks to the DecoupledEditor used as a foundation, you can experiment and create custom user interface layouts quickly while preserving the feature set, accessibility support (e.g. keyboard navigation in the toolbar) and more.