remirror/remirror

View on GitHub
docs/extensions/count-extension.mdx

Summary

Maintainability
Test Coverage
---
hide_title: true
title: 'CountExtension'
---

# `CountExtension`

import Basic from '../../website/extension-examples/extension-count/basic';
import CharacterLimit from '../../website/extension-examples/extension-count/character-limit';
import WordCount from '../../website/extension-examples/extension-count/word-count';
import WordLimit from '../../website/extension-examples/extension-count/word-limit';

## Summary

Adds ability to count characters or words in your editor, and optionally highlight to a user when they have exceeded a specified limit.

## Usage

### Installation

This extension is **not** included in the main `remirror` package.

```ts
import { CountExtension } from '@remirror/extension-count';
```

The extension is provided by the `@remirror/extension-count` package.

### Examples

<Basic />

<CharacterLimit />

<WordCount />

<WordLimit />

## API

- [CountExtension](../api/extension-count)