@ckeditor/ckeditor5-word-count 36.0.0 → 37.0.0-alpha.0

package/build/word-count.js

@@ -2,4 +2,4 @@
 /*!
  * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
  * For licensing, see LICENSE.md.
- */(()=>{var t={704:(t,e,r)=>{t.exports=r(79)("./src/core.js")},273:(t,e,r)=>{t.exports=r(79)("./src/ui.js")},209:(t,e,r)=>{t.exports=r(79)("./src/utils.js")},79:t=>{"use strict";t.exports=CKEditor5.dll}},e={};function r(o){var n=e[o];if(void 0!==n)return n.exports;var i=e[o]={exports:{}};return t[o](i,i.exports,r),i.exports}r.d=(t,e)=>{for(var o in e)r.o(e,o)&&!r.o(t,o)&&Object.defineProperty(t,o,{enumerable:!0,get:e[o]})},r.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e),r.r=t=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})};var o={};(()=>{"use strict";r.r(o),r.d(o,{WordCount:()=>z});var t=r(704),e=r(273),n=r(209);function i(t){if(t.is("$text")||t.is("$textProxy"))return t.data;const e=t;let r="",o=null;for(const t of e.getChildren()){const e=i(t);o&&o.is("element")&&(r+="\n"),r+=e,o=t}return r}const s=function(t){var e=typeof t;return null!=t&&("object"==e||"function"==e)};const c="object"==typeof global&&global&&global.Object===Object&&global;var a="object"==typeof self&&self&&self.Object===Object&&self;const u=c||a||Function("return this")();const d=function(){return u.Date.now()};var l=/\s/;const f=function(t){for(var e=t.length;e--&&l.test(t.charAt(e)););return e};var h=/^\s+/;const p=function(t){return t?t.slice(0,f(t)+1).replace(h,""):t};const g=u.Symbol;var v=Object.prototype,b=v.hasOwnProperty,w=v.toString,y=g?g.toStringTag:void 0;const _=function(t){var e=b.call(t,y),r=t[y];try{t[y]=void 0;var o=!0}catch(t){}var n=w.call(t);return o&&(e?t[y]=r:delete t[y]),n};var m=Object.prototype.toString;const j=function(t){return m.call(t)};var O=g?g.toStringTag:void 0;const x=function(t){return null==t?void 0===t?"[object Undefined]":"[object Null]":O&&O in Object(t)?_(t):j(t)};const C=function(t){return null!=t&&"object"==typeof t};const S=function(t){return"symbol"==typeof t||C(t)&&"[object Symbol]"==x(t)};var T=/^[-+]0x[0-9a-f]+$/i,E=/^0b[01]+$/i,W=/^0o[0-7]+$/i,N=parseInt;const P=function(t){if("number"==typeof t)return t;if(S(t))return NaN;if(s(t)){var e="function"==typeof t.valueOf?t.valueOf():t;t=s(e)?e+"":e}if("string"!=typeof t)return 0===t?t:+t;t=p(t);var r=E.test(t);return r||W.test(t)?N(t.slice(2),r?2:8):T.test(t)?NaN:+t};var R=Math.max,V=Math.min;const L=function(t,e,r){var o,n,i,c,a,u,l=0,f=!1,h=!1,p=!0;if("function"!=typeof t)throw new TypeError("Expected a function");function g(e){var r=o,i=n;return o=n=void 0,l=e,c=t.apply(i,r)}function v(t){return l=t,a=setTimeout(w,e),f?g(t):c}function b(t){var r=t-u;return void 0===u||r>=e||r<0||h&&t-l>=i}function w(){var t=d();if(b(t))return y(t);a=setTimeout(w,function(t){var r=e-(t-u);return h?V(r,i-(t-l)):r}(t))}function y(t){return a=void 0,p&&o?g(t):(o=n=void 0,c)}function _(){var t=d(),r=b(t);if(o=arguments,n=this,u=t,r){if(void 0===a)return v(u);if(h)return clearTimeout(a),a=setTimeout(w,e),g(u)}return void 0===a&&(a=setTimeout(w,e)),c}return e=P(e)||0,s(r)&&(f=!!r.leading,i=(h="maxWait"in r)?R(P(r.maxWait)||0,e):i,p="trailing"in r?!!r.trailing:p),_.cancel=function(){void 0!==a&&clearTimeout(a),l=0,o=u=n=a=void 0},_.flush=function(){return void 0===a?c:y(d())},_};const A=function(t,e,r){var o=!0,n=!0;if("function"!=typeof t)throw new TypeError("Expected a function");return s(r)&&(o="leading"in r?!!r.leading:o,n="trailing"in r?!!r.trailing:n),L(t,e,{leading:o,maxWait:e,trailing:n})};const M=function(t,e){return function(r){return t(e(r))}}(Object.getPrototypeOf,Object);var I=Function.prototype,K=Object.prototype,$=I.toString,k=K.hasOwnProperty,U=$.call(Object);const D=function(t){if(!C(t)||"[object Object]"!=x(t))return!1;var e=M(t);if(null===e)return!0;var r=k.call(e,"constructor")&&e.constructor;return"function"==typeof r&&r instanceof r&&$.call(r)==U};const F=function(t){return C(t)&&1===t.nodeType&&!D(t)};class z extends t.Plugin{constructor(t){super(t),this.set("characters",0),this.set("words",0),Object.defineProperties(this,{characters:{get(){return this.characters=this._getCharacters()}},words:{get(){return this.words=this._getWords()}}}),this.set("_wordsLabel",void 0),this.set("_charactersLabel",void 0),this._config=t.config.get("wordCount")||{},this._outputView=void 0,this._wordsMatchRegExp=n.env.features.isRegExpUnicodePropertySupported?new RegExp("([\\p{L}\\p{N}]+\\S?)+","gu"):/([a-zA-Z0-9À-ž]+\S?)+/gu}static get pluginName(){return"WordCount"}init(){this.editor.model.document.on("change:data",A(this._refreshStats.bind(this),250)),"function"==typeof this._config.onUpdate&&this.on("update",((t,e)=>{this._config.onUpdate(e)})),F(this._config.container)&&this._config.container.appendChild(this.wordCountContainer)}destroy(){this._outputView&&(this._outputView.element.remove(),this._outputView.destroy()),super.destroy()}get wordCountContainer(){const t=this.editor,r=t.t,o=t.config.get("wordCount.displayWords"),n=t.config.get("wordCount.displayCharacters"),i=e.Template.bind(this,this),s=[];return this._outputView||(this._outputView=new e.View,(o||void 0===o)&&(this.bind("_wordsLabel").to(this,"words",(t=>r("Words: %0",t))),s.push({tag:"div",children:[{text:[i.to("_wordsLabel")]}],attributes:{class:"ck-word-count__words"}})),(n||void 0===n)&&(this.bind("_charactersLabel").to(this,"characters",(t=>r("Characters: %0",t))),s.push({tag:"div",children:[{text:[i.to("_charactersLabel")]}],attributes:{class:"ck-word-count__characters"}})),this._outputView.setTemplate({tag:"div",attributes:{class:["ck","ck-word-count"]},children:s}),this._outputView.render()),this._outputView.element}_getCharacters(){return i(this.editor.model.document.getRoot()).replace(/\n/g,"").length}_getWords(){return(i(this.editor.model.document.getRoot()).match(this._wordsMatchRegExp)||[]).length}_refreshStats(){const t=this.words=this._getWords(),e=this.characters=this._getCharacters();this.fire("update",{words:t,characters:e})}}})(),(window.CKEditor5=window.CKEditor5||{}).wordCount=o})();
+ */(()=>{var t={704:(t,e,r)=>{t.exports=r(79)("./src/core.js")},273:(t,e,r)=>{t.exports=r(79)("./src/ui.js")},209:(t,e,r)=>{t.exports=r(79)("./src/utils.js")},79:t=>{"use strict";t.exports=CKEditor5.dll}},e={};function r(o){var n=e[o];if(void 0!==n)return n.exports;var i=e[o]={exports:{}};return t[o](i,i.exports,r),i.exports}r.d=(t,e)=>{for(var o in e)r.o(e,o)&&!r.o(t,o)&&Object.defineProperty(t,o,{enumerable:!0,get:e[o]})},r.o=(t,e)=>Object.prototype.hasOwnProperty.call(t,e),r.r=t=>{"undefined"!=typeof Symbol&&Symbol.toStringTag&&Object.defineProperty(t,Symbol.toStringTag,{value:"Module"}),Object.defineProperty(t,"__esModule",{value:!0})};var o={};(()=>{"use strict";r.r(o),r.d(o,{WordCount:()=>Q});var t=r(704),e=r(273),n=r(209);function i(t){if(t.is("$text")||t.is("$textProxy"))return t.data;const e=t;let r="",o=null;for(const t of e.getChildren()){const e=i(t);o&&o.is("element")&&(r+="\n"),r+=e,o=t}return r}const s=function(t){var e=typeof t;return null!=t&&("object"==e||"function"==e)};const c="object"==typeof global&&global&&global.Object===Object&&global;var a="object"==typeof self&&self&&self.Object===Object&&self;const u=c||a||Function("return this")();const d=function(){return u.Date.now()};var l=/\s/;const f=function(t){for(var e=t.length;e--&&l.test(t.charAt(e)););return e};var h=/^\s+/;const p=function(t){return t?t.slice(0,f(t)+1).replace(h,""):t};const g=u.Symbol;var v=Object.prototype,b=v.hasOwnProperty,w=v.toString,y=g?g.toStringTag:void 0;const _=function(t){var e=b.call(t,y),r=t[y];try{t[y]=void 0;var o=!0}catch(t){}var n=w.call(t);return o&&(e?t[y]=r:delete t[y]),n};var m=Object.prototype.toString;const j=function(t){return m.call(t)};var O="[object Null]",x="[object Undefined]",C=g?g.toStringTag:void 0;const S=function(t){return null==t?void 0===t?x:O:C&&C in Object(t)?_(t):j(t)};const T=function(t){return null!=t&&"object"==typeof t};var E="[object Symbol]";const W=function(t){return"symbol"==typeof t||T(t)&&S(t)==E};var P=NaN,R=/^[-+]0x[0-9a-f]+$/i,V=/^0b[01]+$/i,L=/^0o[0-7]+$/i,N=parseInt;const A=function(t){if("number"==typeof t)return t;if(W(t))return P;if(s(t)){var e="function"==typeof t.valueOf?t.valueOf():t;t=s(e)?e+"":e}if("string"!=typeof t)return 0===t?t:+t;t=p(t);var r=V.test(t);return r||L.test(t)?N(t.slice(2),r?2:8):R.test(t)?P:+t};var M="Expected a function",I=Math.max,K=Math.min;const $=function(t,e,r){var o,n,i,c,a,u,l=0,f=!1,h=!1,p=!0;if("function"!=typeof t)throw new TypeError(M);function g(e){var r=o,i=n;return o=n=void 0,l=e,c=t.apply(i,r)}function v(t){var r=t-u;return void 0===u||r>=e||r<0||h&&t-l>=i}function b(){var t=d();if(v(t))return w(t);a=setTimeout(b,function(t){var r=e-(t-u);return h?K(r,i-(t-l)):r}(t))}function w(t){return a=void 0,p&&o?g(t):(o=n=void 0,c)}function y(){var t=d(),r=v(t);if(o=arguments,n=this,u=t,r){if(void 0===a)return function(t){return l=t,a=setTimeout(b,e),f?g(t):c}(u);if(h)return clearTimeout(a),a=setTimeout(b,e),g(u)}return void 0===a&&(a=setTimeout(b,e)),c}return e=A(e)||0,s(r)&&(f=!!r.leading,i=(h="maxWait"in r)?I(A(r.maxWait)||0,e):i,p="trailing"in r?!!r.trailing:p),y.cancel=function(){void 0!==a&&clearTimeout(a),l=0,o=u=n=a=void 0},y.flush=function(){return void 0===a?c:w(d())},y};var k="Expected a function";const U=function(t,e,r){var o=!0,n=!0;if("function"!=typeof t)throw new TypeError(k);return s(r)&&(o="leading"in r?!!r.leading:o,n="trailing"in r?!!r.trailing:n),$(t,e,{leading:o,maxWait:e,trailing:n})};const D=function(t,e){return function(r){return t(e(r))}}(Object.getPrototypeOf,Object);var F="[object Object]",z=Function.prototype,Z=Object.prototype,q=z.toString,B=Z.hasOwnProperty,G=q.call(Object);const H=function(t){if(!T(t)||S(t)!=F)return!1;var e=D(t);if(null===e)return!0;var r=B.call(e,"constructor")&&e.constructor;return"function"==typeof r&&r instanceof r&&q.call(r)==G};const J=function(t){return T(t)&&1===t.nodeType&&!H(t)};class Q extends t.Plugin{constructor(t){super(t),this.set("characters",0),this.set("words",0),Object.defineProperties(this,{characters:{get(){return this.characters=this._getCharacters()}},words:{get(){return this.words=this._getWords()}}}),this.set("_wordsLabel",void 0),this.set("_charactersLabel",void 0),this._config=t.config.get("wordCount")||{},this._outputView=void 0,this._wordsMatchRegExp=n.env.features.isRegExpUnicodePropertySupported?new RegExp("([\\p{L}\\p{N}]+\\S?)+","gu"):/([a-zA-Z0-9À-ž]+\S?)+/gu}static get pluginName(){return"WordCount"}init(){this.editor.model.document.on("change:data",U(this._refreshStats.bind(this),250)),"function"==typeof this._config.onUpdate&&this.on("update",((t,e)=>{this._config.onUpdate(e)})),J(this._config.container)&&this._config.container.appendChild(this.wordCountContainer)}destroy(){this._outputView&&(this._outputView.element.remove(),this._outputView.destroy()),super.destroy()}get wordCountContainer(){const t=this.editor,r=t.t,o=t.config.get("wordCount.displayWords"),n=t.config.get("wordCount.displayCharacters"),i=e.Template.bind(this,this),s=[];return this._outputView||(this._outputView=new e.View,(o||void 0===o)&&(this.bind("_wordsLabel").to(this,"words",(t=>r("Words: %0",t))),s.push({tag:"div",children:[{text:[i.to("_wordsLabel")]}],attributes:{class:"ck-word-count__words"}})),(n||void 0===n)&&(this.bind("_charactersLabel").to(this,"characters",(t=>r("Characters: %0",t))),s.push({tag:"div",children:[{text:[i.to("_charactersLabel")]}],attributes:{class:"ck-word-count__characters"}})),this._outputView.setTemplate({tag:"div",attributes:{class:["ck","ck-word-count"]},children:s}),this._outputView.render()),this._outputView.element}_getCharacters(){return i(this.editor.model.document.getRoot()).replace(/\n/g,"").length}_getWords(){return(i(this.editor.model.document.getRoot()).match(this._wordsMatchRegExp)||[]).length}_refreshStats(){const t=this.words=this._getWords(),e=this.characters=this._getCharacters();this.fire("update",{words:t,characters:e})}}})(),(window.CKEditor5=window.CKEditor5||{}).wordCount=o})();

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@ckeditor/ckeditor5-word-count",
-  "version": "36.0.0",
+  "version": "37.0.0-alpha.0",
   "description": "Word and character count feature for CKEditor 5.",
   "keywords": [
     "ckeditor",
@@ -13,23 +13,23 @@
   "main": "src/index.js",
   "dependencies": {
     "lodash-es": "^4.17.15",
-    "ckeditor5": "^36.0.0"
+    "ckeditor5": "^37.0.0-alpha.0"
   },
   "devDependencies": {
-    "@ckeditor/ckeditor5-basic-styles": "^36.0.0",
-    "@ckeditor/ckeditor5-block-quote": "^36.0.0",
-    "@ckeditor/ckeditor5-core": "^36.0.0",
-    "@ckeditor/ckeditor5-dev-utils": "^32.0.0",
-    "@ckeditor/ckeditor5-editor-classic": "^36.0.0",
-    "@ckeditor/ckeditor5-engine": "^36.0.0",
-    "@ckeditor/ckeditor5-enter": "^36.0.0",
-    "@ckeditor/ckeditor5-image": "^36.0.0",
-    "@ckeditor/ckeditor5-link": "^36.0.0",
-    "@ckeditor/ckeditor5-list": "^36.0.0",
-    "@ckeditor/ckeditor5-paragraph": "^36.0.0",
-    "@ckeditor/ckeditor5-table": "^36.0.0",
-    "@ckeditor/ckeditor5-theme-lark": "^36.0.0",
-    "@ckeditor/ckeditor5-utils": "^36.0.0",
+    "@ckeditor/ckeditor5-basic-styles": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-block-quote": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-core": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-dev-utils": "^34.0.0",
+    "@ckeditor/ckeditor5-editor-classic": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-engine": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-enter": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-image": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-link": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-list": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-paragraph": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-table": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-theme-lark": "^37.0.0-alpha.0",
+    "@ckeditor/ckeditor5-utils": "^37.0.0-alpha.0",
     "typescript": "^4.8.4",
     "webpack": "^5.58.1",
     "webpack-cli": "^4.9.0"
@@ -60,5 +60,6 @@
     "dll:build": "webpack",
     "build": "tsc -p ./tsconfig.release.json",
     "postversion": "npm run build"
-  }
+  },
+  "types": "src/index.d.ts"
 }

package/src/index.d.ts

@@ -0,0 +1,8 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module word-count
+ */
+export { default as WordCount, type WordCountUpdateEvent } from './wordcount';

package/src/utils.d.ts

@@ -0,0 +1,14 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+/**
+ * @module word-count/utils
+ */
+import type { Item } from 'ckeditor5/src/engine';
+/**
+ * Returns a plain text representation of an element and its children.
+ *
+ * @returns Plain text representing the model's data.
+ */
+export declare function modelElementToPlainText(item: Item): string;

package/src/wordcount.d.ts

@@ -0,0 +1,233 @@
+/**
+ * @license Copyright (c) 2003-2023, CKSource Holding sp. z o.o. All rights reserved.
+ * For licensing, see LICENSE.md or https://ckeditor.com/legal/ckeditor-oss-license
+ */
+import { Plugin, type Editor } from 'ckeditor5/src/core';
+/**
+ * The word count plugin.
+ *
+ * This plugin calculates all words and characters in all {@link module:engine/model/text~Text text nodes} available in the model.
+ * It also provides an HTML element that updates its state whenever the editor content is changed.
+ *
+ * The model's data is first converted to plain text using {@link module:word-count/utils~modelElementToPlainText}.
+ * The number of words and characters in your text are determined based on the created plain text. Please keep in mind
+ * that every block in the editor is separated with a newline character, which is included in the calculation.
+ *
+ * Here are some examples of how the word and character calculations are made:
+ *
+ * ```html
+ * <paragraph>foo</paragraph>
+ * <paragraph>bar</paragraph>
+ * // Words: 2, Characters: 7
+ *
+ * <paragraph><$text bold="true">foo</$text>bar</paragraph>
+ * // Words: 1, Characters: 6
+ *
+ * <paragraph>*&^%)</paragraph>
+ * // Words: 0, Characters: 5
+ *
+ * <paragraph>foo(bar)</paragraph>
+ * //Words: 1, Characters: 8
+ *
+ * <paragraph>12345</paragraph>
+ * // Words: 1, Characters: 5
+ * ```
+ */
+export default class WordCount extends Plugin {
+    /**
+     * The number of characters in the editor.
+     *
+     * @observable
+     * @readonly
+     */
+    characters: number;
+    /**
+     * The number of words in the editor.
+     *
+     * @observable
+     * @readonly
+     */
+    words: number;
+    /**
+     * The label used to display the words value in the {@link #wordCountContainer output container}.
+     *
+     * @observable
+     * @private
+     * @readonly
+     */
+    _wordsLabel: string | undefined;
+    /**
+     * The label used to display the characters value in the {@link #wordCountContainer output container}.
+     *
+     * @observable
+     * @private
+     * @readonly
+     */
+    _charactersLabel: string | undefined;
+    /**
+     * The configuration of this plugin.
+     */
+    private _config;
+    /**
+     * The reference to a {@link module:ui/view~View view object} that contains the self-updating HTML container.
+     */
+    private _outputView;
+    /**
+     * A regular expression used to recognize words in the editor's content.
+     */
+    private readonly _wordsMatchRegExp;
+    /**
+     * @inheritDoc
+     */
+    constructor(editor: Editor);
+    /**
+     * @inheritDoc
+     */
+    static get pluginName(): 'WordCount';
+    /**
+     * @inheritDoc
+     */
+    init(): void;
+    /**
+     * @inheritDoc
+     */
+    destroy(): void;
+    /**
+     * Creates a self-updating HTML element. Repeated executions return the same element.
+     * The returned element has the following HTML structure:
+     *
+     * ```html
+     * <div class="ck ck-word-count">
+     * 	<div class="ck-word-count__words">Words: 4</div>
+     * 	<div class="ck-word-count__characters">Characters: 28</div>
+     * </div>
+     * ```
+     */
+    get wordCountContainer(): HTMLElement;
+    /**
+     * Determines the number of characters in the current editor's model.
+     */
+    private _getCharacters;
+    /**
+     * Determines the number of words in the current editor's model.
+     */
+    private _getWords;
+    /**
+     * Determines the number of words and characters in the current editor's model and assigns it to {@link #characters} and {@link #words}.
+     * It also fires the {@link #event:update}.
+     *
+     * @fires update
+     */
+    private _refreshStats;
+}
+/**
+ * An event fired after {@link #words} and {@link #characters} are updated.
+ *
+ * @eventName update
+ */
+export type WordCountUpdateEvent = {
+    name: 'update';
+    args: [{
+        words: number;
+        characters: number;
+    }];
+};
+/**
+ * The configuration of the word count feature.
+ *
+ * ```ts
+ * ClassicEditor
+ * 	.create( {
+ * 		wordCount: ... // Word count feature configuration.
+ * 	} )
+ * 	.then( ... )
+ * 	.catch( ... );
+ * ```
+ *
+ * See {@link module:core/editor/editorconfig~EditorConfig all editor options}.
+ */
+export interface WordCountConfig {
+    /**
+     * This option allows for hiding the word counter. The element obtained through
+     * {@link module:word-count/wordcount~WordCount#wordCountContainer} will only preserve
+     * the characters part. Word counter is displayed by default when this configuration option is not defined.
+     *
+     * ```ts
+     * const wordCountConfig = {
+     * 	displayWords: false
+     * };
+     * ```
+     *
+     * The configuration above will result in the following container:
+     *
+     * ```html
+     * <div class="ck ck-word-count">
+     * 	<div class="ck-word-count__characters">Characters: 28</div>
+     * </div>
+     * ```
+     */
+    displayWords?: boolean;
+    /**
+     * This option allows for hiding the character counter. The element obtained through
+     * {@link module:word-count/wordcount~WordCount#wordCountContainer} will only preserve
+     * the words part. Character counter is displayed by default when this configuration option is not defined.
+     *
+     * ```ts
+     * const wordCountConfig = {
+     * 	displayCharacters: false
+     * };
+     * ```
+     *
+     * The configuration above will result in the following container:
+     *
+     * ```html
+     * <div class="ck ck-word-count">
+     * 	<div class="ck-word-count__words">Words: 4</div>
+     * </div>
+     * ```
+     */
+    displayCharacters?: boolean;
+    /**
+     * 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.
+     *
+     * ```ts
+     * const wordCountConfig = {
+     * 	onUpdate: function( stats ) {
+     * 		doSthWithWordNumber( stats.words );
+     * 		doSthWithCharacterNumber( stats.characters );
+     * 	}
+     * };
+     * ```
+     */
+    onUpdate?: (data: {
+        words: number;
+        characters: number;
+    }) => void;
+    /**
+     * Allows for providing the HTML element that the
+     * {@link module:word-count/wordcount~WordCount#wordCountContainer word count container} will be appended to automatically.
+     *
+     * ```ts
+     * const wordCountConfig = {
+     * 	container: document.getElementById( 'container-for-word-count' );
+     * };
+     * ```
+     */
+    container?: HTMLElement;
+}
+declare module '@ckeditor/ckeditor5-core' {
+    interface PluginsMap {
+        [WordCount.pluginName]: WordCount;
+    }
+    interface EditorConfig {
+        /**
+         * The configuration of the word count feature.
+         * It is introduced by the {@link module:word-count/wordcount~WordCount} feature.
+         *
+         * Read more in {@link module:word-count/wordcount~WordCountConfig}.
+         */
+        wordCount?: WordCountConfig;
+    }
+}