@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.

Installation

This plugin is part of the ckeditor5 package. Install the whole package to use it.

npm install ckeditor5

Create free account

If you want to check full CKEditor 5 capabilities, sign up for a free non-commitment 14-day trial.

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.

License

Licensed under a dual-license model, this software is available under:

• the GNU General Public License Version 2 or later,
• or commercial license terms from CKSource Holding sp. z o.o.

For more information, see: https://ckeditor.com/legal/ckeditor-licensing-options.

Changelog

44.0.0 (December 2, 2024)

Release Highlights

We are excited to introduce CKEditor 5 v44.0.0, a release packed with high impact updates designed to enhance your editing experience and simplify access to our premium offers. Here's what’s new:

🚀 Self-service plans: Simplified access to premium features

We are introducing flexible self-service plans that put you in control with full transparency. Now, you can:

• Choose the plan that fits your needs, pay only for what you use, and get started instantly with a commitment-free trial.
• Seamlessly manage your license keys, track usage, and more in the new Customer Portal.

💡 Important for current users:

If you are upgrading to v44.0.0+, ensure a smooth transition by updating your license keys in the editor, as we implemented a new format of the key. To get the new key, visit the Customer Portal. You can also refer to our license key and activation guide for help with logging in to the portal.

📣 The open-source licensing remains unchanged. However, config.licenseKey is now a required property in the editor configuration. Use 'GPL' for installations under the GPL terms. Read more in the update guide.

🔖 Bookmarks: Organize your content with ease

Say hello to Bookmarks, a long-awaited feature that simplifies content navigation within the editor. With this release, you can:

• Add anchors as reference points within text.
• Link to the newly created bookmarks in the editor to navigate to specific locations within complex documents, such as contracts or technical manuals.

📍 Future updates to Bookmarks and the linking experience are planned for the upcoming releases. Follow progress and share your feedback on GitHub.

⚡ Performance improvements: Faster table rendering

The current release includes another stride towards improving the performance aspect of the editor, this time focusing on how tables are handled in the content. Implemented optimizations have made table rendering 3x faster, with the average load time of a document with a very long, complex tables dropping from around 4.5 seconds to just 1.5 seconds.