guideExport to Word

The ExportWord feature allows you to generate a .docx file directly from the CKEditor 5 WYSIWYG editor content.

When enabled, this feature sends the content of your editor together with the styles that are used to display it to the CKEditor Cloud Services HTML to DOCX converter service. The service then generates a Word document that can be downloaded by the user. This allows you to easily export your content to the Microsoft Word format.

This is a premium feature. Please contact us if you would like to purchase a license. Let us know if you have any feedback or questions!

You can also sign up for the CKEditor Premium Features 30-day free trial.

If this feature is used without authentication, the resulting document will be watermarked.

The complementary pagination feature allows you to see where page breaks would be after the document is exported to Word. Thanks to the live preview, the user is able to fine-tune the structure of the output document when editing it. In addition to this, the pagination feature shows you the page count and allows to easily navigate between the document pages.

# Demo

The demo below allows you to generate a Word file based on the editor content. Craft the document content in the WYSIWYG editor, then click the “Export to Word” toolbar button to save it as a Word file.

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 attached the full schedule of the event.

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 at Bilancino Hotel

 

 

 

The Flavorful Tuscany Meetup Schedule

Saturday, July 14
9:30 AM - 11:30 AM

Americano vs. Brewed - “know your coffee” with: 

  • Giulia Bianchi
  • Stefano Garau
  • Giuseppe Russo
1:00 PM - 3:00 PM

Pappardelle al pomodoro - live cooking 1

Incorporate the freshest ingredients 
with Rita Fresco

5:00 PM - 8:00 PM Tuscan vineyards at a glance - wine-tasting 
with Frederico Riscoli

1 Registration for the live cooking session is required as seats are limited.

 

# How it works

The export to Microsoft Word feature collects the HTML generated with the editor.getData() method and the default editor content styles combined with the styles provided by you in the configuration. It then sends them to the CKEditor Cloud Services HTML to DOCX converter service. The service generates a Word file and returns it to the user’s browser so they can save it in the Word format on their disk.

# Before you start

This is a premium feature and you can purchase a license here or contact us for a tailor-made offer. Export to Word then needs to be configured to run without the watermark.

After you purchase a license, follow the steps below, as explained in the Export to Word quick start guide:

# Installation

To add the export to Word feature to your editor, install the @ckeditor/ckeditor5-export-word package:

npm install --save @ckeditor/ckeditor5-export-word

Then add the ExportWord plugin to your plugin list and configure it:

import ExportWord from '@ckeditor/ckeditor5-export-word/src/exportword';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        cloudServices: {
            tokenUrl: 'https://example.com/cs-token-endpoint',
        }
        plugins: [ ExportWord, ... ],
        toolbar: [
            'exportWord', '|',
            ...
        ],
        exportWord: {
            fileName: 'my-file.docx',
            converterOptions: {
                format: 'A4', // Default value, you don't need to specify it explicitly for A4.
                margin_top: '20mm',
                margin_bottom: '20mm',
                margin_right: '12mm',
                margin_left: '12mm'
            }
        }
    } )
    .then( ... )
    .catch( ... );

Read more about installing plugins.

# Configuration

For more technical details, please check the plugin configuration API.

# Default configuration

This is the default configuration of the Word export feature for CKEditor 5.

{
    exportWord: {
        fileName: 'document.docx',
        converterUrl: 'https://docx-converter.cke-cs.com/v1/convert',
        stylesheets: [ 'EDITOR_STYLES' ],
        converterOptions: {
            format: 'A4',
            margin_top: '1in',
            margin_bottom: '1in',
            margin_right: '1in',
            margin_left: '1in',
            header: undefined,
            footer: undefined,
            comments: undefined,
            suggestions: undefined
        }
    }
}

# Plugin options

For some use cases the default configuration will suffice. As you can see in the example above, you can improve how your Word file will look by adjusting the Word export plugin configuration.

# HTML to Word converter features

# Styling a document

By default, Export to Word plugin takes editor content styles and sends them to the CKEditor Cloud Services HTML to DOCX Converter. You can also add your own styles by providing the paths to the external CSS files.

    // ...
    exportWord: {
        fileName: 'document.docx',
        converterUrl: 'https://docx-converter.cke-cs.com/v1/convert',
        stylesheets: [
            'EDITOR_STYLES',
            'path/to/my-styles.css'
        ],
        // ...
    }
    // ...

# Supported CSS properties

DOCX Converter supports proper CSS inheritance with a set of whitelisted properties which can be used to style document content.

CSS properties like:

  • color
  • background-color
  • font-size
  • font-family
  • text-align

can be applied to the following elements: h1, h2, h3, h4, h5, h6, p, span, td, th, strong, i, u, s, sub, sup, mark.

You can also position images using float CSS property, supporting left, right, and none values.

You can use any CSS selector to style the above elements, including classes, attributes, and * selector.

# Setting the page format

Consistency is an important factor. To make sure that the editor content and the generated Word file look exactly the same, you need to match their format settings. You can modify your existing stylesheet or use a new one, for example, format.css. By default the CKEditor Cloud Services HTML to DOCX converter is set to A4 format, but you may change this setting in your configuration.

Assuming that you want to create a document in the US Letter format, with the standard margins (19mm for each side), here is the example code you can use:

import ClassicEditor from '@ckeditor/ckeditor5-build-classic/src/ckeditor';
import ExportWord from '@ckeditor/ckeditor5-export-pdf/src/exportword';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ ExportWord, ... ],
        toolbar: [
            'exportWord', '|',
            // ...
        ],
        exportWord: {
            stylesheets: [
                'EDITOR_STYLES',
                // Add an external stylesheet after the 'EDITOR_STYLES' token.
                './styles/format.css'
            ],
            fileName: 'my-document.docx',
            converterOptions: {
                // Document format settings with proper margins.
                format: 'Letter',
                margin_top: '19mm',
                margin_bottom: '19mm',
                margin_right: '19mm',
                margin_left: '19mm',
            }
        }
    } )
    .then( ... )
    .catch( ... );

This example focuses only on preparing the editable to match the converter settings. Please keep in mind that as a result, the appearance of your editor may change. Depending on your editor type and implementation or even some inherited global styles like box-sizing, applying new padding values may change the size of the editor on your website.

For the purpose of this example, box-sizing: border-box was implemented to make sure that the editor’s width will not change.

Now set the corresponding editor styles:

/* format.css */

/* Styles for the editable. */
.ck.ck-content.ck-editor__editable {
    /* US Letter size. */
    width: 215.9mm;
    /* Padding is your document's margin. */
    padding: 19mm;
    /* You don't want to change the size of the editor by applying the new padding values. */
    box-sizing: border-box;
    /* ... */
}

With these settings, the content in the generated Word file should have the same US Letter format layout as it has in the editor.

The converter allows you to set the document’s header and footer in a similar way as you do this in your Microsoft Word or Google Docs files.

// Let's keep the CSS string as a variable to avoid unnecessary string duplication.
const templateCSS = '.styled { font-weight: bold; text-align: center; }'

const converterOptions = {
    header: [
        // Header template for all headers (without the `type` property).
        { html: '<div class="styled">Default header content</div>', css: templateCSS },
        // Header template only for the first page of the document.
        { html: '<div class="styled">First document page header content</div>', css: templateCSS, type: 'first' },
        // Header template for every even page of the document.
        { html: '<div class="styled">Every even page header content</div>', css: templateCSS, type: 'even' },
        // Header template for every odd page of the document.
        { html: '<div class="styled">Every odd page header content</div>', css: templateCSS, type: 'odd' }
    ],
    footer: [
        // Footer template for all footers (without the `type` property).
        { html: '<div class="styled">Default footer content</div>', css: templateCSS },
        // Footer template only for the first page of the document.
        { html: '<div class="styled">First document page footer content</div>', css: templateCSS, type: 'first' },
        // Footer template for every even page of the document.
        { html: '<div class="styled">Every even page footer content</div>', css: templateCSS, type: 'even' },
        // Footer template for every odd page of the document.
        { html: '<div class="styled">Every odd page footer content</div>', css: templateCSS, type: 'odd' }
    ],
}

As you can see, the header and footer options take an array of objects that define templates for the particular type of page. If you want to have consistent templates no matter the page, you can define only the default headers/footers template (NOTE: This setting misses the type property on purpose).

Regarding CSS, header and footer can be styled using the same supported properties as used for styling the whole document.

For more details, refer to the CKEditor Cloud Services HTML to DOCX converter’s documentation.

# Comments and suggestions

When your editor has collaboration features (like comments and track changes) enabled, the Export to Word feature will take care of setting the configuration needed by the CKEditor Cloud Services HTML to DOCX converter. But if for some reason you need to pass your own data, you can do this via the REST API converter options.

Note: Currently formatting suggestions are not supported. Only insertions and deletions will work correctly with the CKEditor Cloud Services HTML to DOCX converter.

# Other

  • By default, the generated Word file is encoded with UTF-8.

# Known issues

Not all CKEditor 5 plugins and features are compatible with export to Word at the moment. Here is a list of known issues:

# Unsupported plugins

  • Media embed
  • MathType – Not fully supported yet. Right now the plugin parses the data but not the formatting. Feel free to contact us if you are interested in this feature.

# Unsupported features

The complementary pagination feature provides live preview of the document’s page breaks, ensuring the output document looks correct.

If you would like to export your content to a portable, universal format, using the export to PDF feature will allow you to generate PDF files out of your editor-created content.

# Common API

The ExportWord plugin registers:

  • The 'exportWord' button.

  • The 'exportWord' command implemented by ExportWordCommand.

    The command can be executed using the editor.execute() method:

    // Start generating a Word file based on the editor content and plugin configuration.
    editor.execute( 'exportWord' );