CKEditor Ecosystem Documentation
Search
Home/CKEditor 5/API
Interface

WordCountConfig (word-count)

@ckeditor/ckeditor5-word-count/src/wordcountconfig

interface
See source

The configuration of the word count feature.

ClassicEditor
	.create( {
		wordCount: ... // Word count feature configuration.
	} )
	.then( ... )
	.catch( ... );

See all editor options.

Filtering

Properties

  • container : HTMLElement | undefined

    See source

    Allows for providing the HTML element that the word count container will be appended to automatically.

    const wordCountConfig = {
	container: document.getElementById( 'container-for-word-count' );
};

  • displayCharacters : boolean | undefined

    See source

    This option allows for hiding the character counter. The element obtained through wordCountContainer will only preserve the words part. Character counter is displayed by default when this configuration option is not defined.

    const wordCountConfig = {
	displayCharacters: false
};

    The configuration above will result in the following container:

    <div class="ck ck-word-count">
	<div class="ck-word-count__words">Words: 4</div>
</div>

  • displayWords : boolean | undefined

    See source

    This option allows for hiding the word counter. The element obtained through wordCountContainer will only preserve the characters part. Word counter is displayed by default when this configuration option is not defined.

    const wordCountConfig = {
	displayWords: false
};

    The configuration above will result in the following container:

    <div class="ck ck-word-count">
	<div class="ck-word-count__characters">Characters: 28</div>
</div>

  • onUpdate : ( object ) => void | undefined

    See source

    This configuration takes a function that is executed whenever the word count plugin updates its values. This function is called with one argument, which is an object with the words and characters keys containing the number of detected words and characters in the document.

    const wordCountConfig = {
	onUpdate: function( stats ) {
		doSthWithWordNumber( stats.words );
		doSthWithCharacterNumber( stats.characters );
	}
};