@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.1.0 (September 5, 2024)

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

Release highlights

This release includes important bug fixes and enhancements for the editor:

• Block merge fields: In contrast to regular, inline merge fields, the block merge fields are designed to represent complex, block-level structures, such as a dynamically generated table, a row of products, or a personalized call-to-action segment. Block merge fields are supposed to be replaced by arbitrary HTML data when the document template is post-processed or exported to a PDF or Word file.

• Nested dropdown menus: this release introduces a new UI component: nested dropdown menus. They can be used by feature developers to easily provide an advanced user interface where UI elements are organized into a nested menu structure.

• Customizable accessible label: You can now configure the label for the accessible editable area through the editor settings, ensuring it fits your system’s needs.

• Improved table and cell border controls: It is now easier to manage both table and cell borders. The table user interface now clearly indicates the default border settings, allowing you to set “no borders” (None) for tables and cells without any additional configuration.

  ⚠️ In some cases this update may lead to data changes in the tables’ HTML markup when the editor loads them. However, visually nothing will change, and the experience will be the same.

The full list of enhancements can be found below.