# ckeditor5-iswordcount

> CKEditor 5 word count feature

Latest version **0.0.6** (published 2019-06-24) · MIT license · 0 weekly downloads

## Install

```sh
npm install ckeditor5-iswordcount
pnpm add ckeditor5-iswordcount
yarn add ckeditor5-iswordcount
bun add ckeditor5-iswordcount
```

## Health

**Score 15/100 (F)** — status: abandoned.

Positive: no vulnerabilities.

Warnings: low downloads; no types; no esm support; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.0.6 |
| Published | 2019-06-24 |
| First published | 2019-05-30 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 17.2 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 2 |
| Maintainers | isatria |
| Keywords | ckeditor, ckeditor5, ckeditor 5, ckeditor 5 feature, ckeditor 5 plugin, ckeditor 5 plugin word count |

## Links

- npm: https://www.npmjs.com/package/ckeditor5-iswordcount
- Repository: https://github.com/isatria/ckeditor5-iswordcount
- Homepage: https://github.com/isatria/ckeditor5-iswordcount#readme
- Issues: https://github.com/isatria/ckeditor5-iswordcount/issues
- npm.io page: https://npm.io/package/ckeditor5-iswordcount

## Alternatives

- [ext-list](https://npm.io/package/ext-list.md) — 6.3M weekly downloads
- [@lexical/selection](https://npm.io/package/@lexical/selection.md) — 3.8M weekly downloads
- [@lexical/text](https://npm.io/package/@lexical/text.md) — 3.6M weekly downloads
- [@lexical/clipboard](https://npm.io/package/@lexical/clipboard.md) — 3.0M weekly downloads
- [@tiptap/extension-mention](https://npm.io/package/@tiptap/extension-mention.md) — 3.0M weekly downloads

## Recent versions

- 0.0.6 (latest) — 2019-06-24
- 0.0.5 — 2019-06-24
- 0.0.4 — 2019-05-31
- 0.0.3 — 2019-05-31
- 0.0.2 — 2019-05-31
- 0.0.1 — 2019-05-30

## README

# ckeditor5-iswordcount [![Tweet](https://img.shields.io/twitter/url/http/shields.io.svg?style=social)](https://twitter.com/intent/tweet?text=Check%20out%20ckeditor5-iswordcount%20on%20GitHub&url=https://github.com/isatria/ckeditor5-iswordcount)

[![npm version](https://badge.fury.io/js/ckeditor5-iswordcount.svg)](https://www.npmjs.com/package/ckeditor5-iswordcount)
[![npm download](https://img.shields.io/npm/dt/ckeditor5-iswordcount.svg)](https://www.npmjs.com/package/ckeditor5-iswordcount)
[![npm license](https://img.shields.io/npm/l/ckeditor5-iswordcount.svg)](https://www.npmjs.com/package/ckeditor5-iswordcount)

This package implements characters count support for CKEditor 5.

![alt text](https://i.ibb.co/2K7L2pD/Screenshot-2019-05-31-at-11-51-37-PM.png)

This code is a code refactor from [Word Count & Char Count Plugin](https://ckeditor.com/cke4/addon/wordcount) for CKEditor4. This plugin is far from perfect so it is expected to understand the limitations of the features.

## **Feature**
 
- [x] Char Count
- [ ] Word Count
- [ ] Paragraph Count

## **Installation**

To add this feature to your editor, install the _ckeditor5-iswordcount_ package:

```javascript
npm i ckeditor5-iswordcount
```

And add it to your plugin list and toolbar configuration:

```javascript
import ISWordCount from 'ckeditor5-iswordcount';

ClassicEditor
    .create( document.querySelector( '#editor' ), {
        plugins: [ ISWordCount, ... ],
        toolbar: [ 'iswordcount', ... ]
        iswordcount: { maxCharCount: 10, maxHandler: (charCount, maxCharCount) => alert('Reach maximum limit!') }
    } )
    .then( ... )
    .catch( ... );
```

## **External links**

- [ckeditor5-build-inline-alignment on npm](https://www.npmjs.com/package/ckeditor5-build-inline-alignment)
- [ckeditor5-build-inline-alignment on Github](https://github.com/isatria/ckeditor5-build-inline-alignment)

## **License**

**ckeditor5-iswordcount** 5 is an Open Source plugin

---
_Source: https://npm.io/package/ckeditor5-iswordcount · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._