mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-11-25 12:29:06 +08:00
26 lines
1.1 KiB
Markdown
26 lines
1.1 KiB
Markdown
|
# CharacterCount
|
|||
|
|
[](https://www.npmjs.com/package/@tiptap/extension-character-count)
|
|||
|
|
[](https://npmcharts.com/compare/@tiptap/extension-character-count?minimal=true)
|
|||
|
|
|
|||
|
|
The `CharacterCount` extension limits the number of allowed character to a specific length. That’s it, that’s all.
|
|||
|
|
|
|||
|
|
## Installation
|
|||
|
|
```bash
|
|||
|
|
# with npm
|
|||
|
|
npm install @tiptap/extension-character-count
|
|||
|
|
|
|||
|
|
# with Yarn
|
|||
|
|
yarn add @tiptap/extension-character-count
|
|||
|
|
```
|
|||
|
|
|
|||
|
|
## Settings
|
|||
|
|
| Option | Type | Default | Description |
|
|||
|
|
| ------ | -------- | ------- | -------------------------------------------------------- |
|
|||
|
|
| limit | `Number` | `0` | The maximum number of characters that should be allowed. |
|
|||
|
|
|
|||
|
|
## Source code
|
|||
|
|
[packages/extension-character-count/](https://github.com/ueberdosis/tiptap-next/blob/main/packages/extension-character-count/)
|
|||
|
|
|
|||
|
|
## Usage
|
|||
|
|
<demo name="Extensions/CharacterCount" highlight="" />
|