WordCountConfig
The configuration of the word count feature.
ClassicEditor
.create( {
wordCount: ... // Word count feature configuration.
} )
.then( ... )
.catch( ... );
See all editor options.
Properties
-
container : HTMLElement | undefinedmodule:word-count/wordcountconfig~WordCountConfig#containerAllows for providing the HTML element that the word count container will be appended to automatically.
const wordCountConfig = { container: document.getElementById( 'container-for-word-count' ); };Copy code -
displayCharacters : boolean | undefinedmodule:word-count/wordcountconfig~WordCountConfig#displayCharactersThis option allows for hiding the character counter. The element obtained through
wordCountContainerwill only preserve the words part. Character counter is displayed by default when this configuration option is not defined.const wordCountConfig = { displayCharacters: false };Copy codeThe configuration above will result in the following container:
<div class="ck ck-word-count"> <div class="ck-word-count__words">Words: 4</div> </div>Copy code -
displayWords : boolean | undefinedmodule:word-count/wordcountconfig~WordCountConfig#displayWordsThis option allows for hiding the word counter. The element obtained through
wordCountContainerwill only preserve the characters part. Word counter is displayed by default when this configuration option is not defined.const wordCountConfig = { displayWords: false };Copy codeThe configuration above will result in the following container:
<div class="ck ck-word-count"> <div class="ck-word-count__characters">Characters: 28</div> </div>Copy code -
onUpdate : ( data: object ) => void | undefinedmodule:word-count/wordcountconfig~WordCountConfig#onUpdateThis 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
wordsandcharacterskeys containing the number of detected words and characters in the document.const wordCountConfig = { onUpdate: function( stats ) { doSthWithWordNumber( stats.words ); doSthWithCharacterNumber( stats.characters ); } };Copy code