@ckeditor/ckeditor5-word-count
Advanced tools
@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.
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);
});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 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.
This package implements word count and character count support for CKEditor 5.
Check out the demo in the word count and character count feature guide.
See the @ckeditor/ckeditor5-word-count package page in CKEditor 5 documentation.
npm install ckeditor5
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.
43.3.0 (October 29, 2024)
We are happy to announce the release of CKEditor 5 v43.3.0.
We have improved how the editor handles the document structure by making it more reliable and efficient to access specific elements and verify their positions.
Node and NodeList elements now cache index and offset values, reducing the need for recalculations and significantly boosting overall performance during model operations.Position#isValid() method is also utilized to better validate selection ranges, ensuring more consistent behavior in various editing scenarios.We’re committed to ongoing performance enhancements, so you can expect even faster, smoother experience in future updates.
A new configuration option has been added to include a watermark when exporting documents to Word, providing additional flexibility in document branding and protection.
getChildAtOffset() method for model.Element and model.DocumentFragment. (commit)Position#isValid() method to check whether the position exists in the current model tree. (commit)RevisionTracker#getRevisionDocumentData() and RevisionTracker#getRevisionRootsAttributes() methods to the public scope of the editor API. You can use them to retrieve document data saved with the revision.FocusTracker extendable with other FocusTracker instances to allow logical focus tracking across separate DOM sub-trees (see #17277). (commit)sources downcast. (commit)LinkConfig#addTargetToExternalLinks: true is set. Closes https://github.com/ckeditor/ckeditor5/issues/17252. (commit)BalloonToolbar while the user hovers a nested menu. Closes #17277. (commit)Node and NodeList to improve performance. (commit)ckeditor5-link package. Closes #17304. (commit)Dialog plugin. Closes #17290. (commit)config.ui.viewportOffset. Closes #17290. (commit)Check out the Versioning policy guide for more information.
<details> <summary>Released packages (summary)</summary>Releases containing new features:
Other releases:
To see all releases, visit the release page.
FAQs
Word and character count feature for CKEditor 5.
The npm package @ckeditor/ckeditor5-word-count receives a total of 278,612 weekly downloads. As such, @ckeditor/ckeditor5-word-count popularity was classified as popular.
We found that @ckeditor/ckeditor5-word-count demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 0 open source maintainers collaborating on the project.
Did you know?
Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.
Security News
Deno 2.2 enhances Node.js compatibility, improves dependency management, adds OpenTelemetry support, and expands linting and task automation for developers.
Security News
React's CRA deprecation announcement sparked community criticism over framework recommendations, leading to quick updates acknowledging build tools like Vite as valid alternatives.
Security News
Ransomware payment rates hit an all-time low in 2024 as law enforcement crackdowns, stronger defenses, and shifting policies make attacks riskier and less profitable.