@ckeditor/ckeditor5-word-count

What is @ckeditor/ckeditor5-word-count?

@ckeditor/ckeditor5-word-count is a plugin for CKEditor 5 that provides word and character count functionality. It is useful for applications where tracking the length of the text is important, such as content management systems, blogging platforms, and educational tools.

What are @ckeditor/ckeditor5-word-count's main functionalities?

Basic Word Count

This code demonstrates how to integrate the WordCount plugin into a CKEditor 5 instance and access the current word count.

const WordCount = require('@ckeditor/ckeditor5-word-count/src/wordcount');

ClassicEditor
    .create(document.querySelector('#editor'), {
        plugins: [ WordCount, ... ],
        toolbar: [ 'wordCount', ... ]
    })
    .then(editor => {
        const wordCountPlugin = editor.plugins.get('WordCount');
        console.log(wordCountPlugin.words); // Outputs the current word count
    })
    .catch(error => {
        console.error(error);
    });

Character Count

This code demonstrates how to integrate the WordCount plugin into a CKEditor 5 instance and access the current character count.

const WordCount = require('@ckeditor/ckeditor5-word-count/src/wordcount');

ClassicEditor
    .create(document.querySelector('#editor'), {
        plugins: [ WordCount, ... ],
        toolbar: [ 'wordCount', ... ]
    })
    .then(editor => {
        const wordCountPlugin = editor.plugins.get('WordCount');
        console.log(wordCountPlugin.characters); // Outputs the current character count
    })
    .catch(error => {
        console.error(error);
    });

Customizing Word Count Display

This code demonstrates how to customize the display of the word count by specifying a container element where the word count will be displayed.

const WordCount = require('@ckeditor/ckeditor5-word-count/src/wordcount');

ClassicEditor
    .create(document.querySelector('#editor'), {
        plugins: [ WordCount, ... ],
        toolbar: [ 'wordCount', ... ],
        wordCount: {
            container: document.querySelector('#word-count-container')
        }
    })
    .then(editor => {
        const wordCountPlugin = editor.plugins.get('WordCount');
        console.log(wordCountPlugin.words); // Outputs the current word count
    })
    .catch(error => {
        console.error(error);
    });

Other packages similar to @ckeditor/ckeditor5-word-count

text-statistics

text-statistics is another package that provides various text statistics including word count, character count, and readability scores. It is more comprehensive in terms of the types of statistics it offers compared to @ckeditor/ckeditor5-word-count, but it does not provide direct integration with CKEditor 5.

wordcount

wordcount is a simple package that provides word and character count functionality. It is lightweight and easy to use but does not offer the same level of integration with CKEditor 5 as @ckeditor/ckeditor5-word-count.

README

CKEditor 5 word and character count feature

This package implements word count and character count support for CKEditor 5.

Demo

Check out the demo in the word count and character count feature guide.

Documentation

See the @ckeditor/ckeditor5-word-count package page in CKEditor 5 documentation.

Installation

npm install ckeditor5

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 or https://ckeditor.com/legal/ckeditor-oss-license.

Changelog

43.0.0 (August 7, 2024)

We are happy to announce the release of CKEditor 5 v43.0.0.

Release highlights

Merge fields

The new merge fields feature is a game-changer for creating document templates and other kinds of personalized or dynamic content. Thanks to this feature, you can insert placeholders into your content, indicating where actual values should go. These places are marked in the final content in a distinctive way, making it easy to later process the template and fill it with the actual values. The feature supports a preview mode too - you can define preview data sets, and see how the content will look like when real values are used directly in the editor. The plugin is highly customizable to fit various applications and scenarios. Finally, merge fields are fully integrated with our Export to Word, Export to PDF, and Import from Word features, both when they are used from the editor and via REST API.

We are extremely happy to share with you this highly demanded feature, and we cannot wait to listen to your feedback!

Make sure to visit our builder or documentation to learn more about the feature.

Export to Word V2 as the default version

The V2 version of the export to Word feature introduced significant improvements, optimizations, and fixes. This update enhances the overall performance, making the export process faster and more reliable, especially for large documents. Key improvements include better handling of table borders, automatic detection of Word styles from CSS, and support for more text-related CSS properties, ensuring your documents maintain their intended formatting.

Starting this version, the V2 configuration becomes the default in the ExportWord plugin. Make sure to migrate your configuration if you are using it.

Improved sidebar accessibility and navigation

We have introduced multiple enhancements to make the sidebar more accessible. Among other improvements, you can now use the <kbd>Shift</kbd>+<kbd>Ctrl</kbd>+<kbd>E</kbd> keystroke to move focus from the editor marker to the active annotation. When your comment reply is ready, you can quickly submit it using the new <kbd>Ctrl</kbd>+<kbd>Enter</kbd> shortcut. Also, navigation from one annotation to another is now possible by using arrow keys.

The full lists of keyboard supported actions can be reviewed in our Accessibility support guide.

Important bug fixes and improvements

This release brings notable bug fixes and improvements to enhance your editing experience.

• Several improvements have been made to typing in the editor, especially for Android IME and Safari. On Android, issues like duplicated characters and reverse writing effects have been resolved. In Safari, the reverse typing effect after focus change has been fixed.
• A couple of UI improvements:
  • We replaced the visual indication of the selected option in dropdowns (blue background) with the checkbox marks to better indicate selected options, aligning visual cues across the toolbar and menu bar.
  • All editor types now support the menu bar.
  • Additionally, the special characters UI has been moved from a dropdown to a dialog. This unifies the action between the menu bar and toolbar, and also gives content creators quicker access to the always-on-top dialog.
• We have improved the drawing of page break line algorithm to address the pagination feature issues. We also improved the performance of the plugin.

React and Vue integrations updates

We have released new major versions of the React and Vue integrations. In both of them, we have migrated to JavaScript modules (ESM) and rewritten large parts of the codebases to support the latest versions of these frameworks and to follow the latest recommendations for writing the components.

We strongly recommend that you follow the release highlights to update to the latest versions:

• Release highlights for React integration.
• Release highlights for Vue integration.