WordCountConfig (word-count)

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

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

Properties

• container : HTMLElementmodule:word-count/wordcount~WordCountConfig#container

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

  See source

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

  Copy

• displayCharacters : Booleanmodule:word-count/wordcount~WordCountConfig#displayCharacters

  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.

  See source

  const wordCountConfig = {
  	displayCharacters: false
  };
  

  Copy

  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>

  Copy

• displayWords : Booleanmodule:word-count/wordcount~WordCountConfig#displayWords

  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.

  See source

  const wordCountConfig = {
  	displayWords: false
  };
  

  Copy

  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>

  Copy

• onUpdate : functionmodule:word-count/wordcount~WordCountConfig#onUpdate

  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.

  See source

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

  Copy