WordCountConfig (wordcount)

@ckeditor/ckeditor5-wordcount/src/wordcount

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

Properties

• container : HTMLElementmodule:wordcount/wordcount~WordCountConfig#container

  This option allows on providing an HTML element where word count container will be appended automatically.

  See source

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

• displayCharacters : Booleanmodule:wordcount/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
  }

  The mentioned configuration will result in the following container

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

• displayWords : Booleanmodule:wordcount/wordcount~WordCountConfig#displayWords

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

  See source

  const wordCountConfig = {
      displayWords: false
  }

  The mentioned configuration will result with the followed container:

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

• onUpdate : functionmodule:wordcount/wordcount~WordCountConfig#onUpdate

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

  See source

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