mirror of
https://github.com/ueberdosis/tiptap.git
synced 2024-12-16 03:39:00 +08:00
1.7 KiB
1.7 KiB
description | icon |
---|---|
Limit the number of characters in your editor, or at least count them. | calculator-line |
CharacterCount
The CharacterCount
extension limits the number of allowed character to a specific length. That’s it, that’s all.
Installation
npm install @tiptap/extension-character-count
Settings
limit
The maximum number of characters that should be allowed.
Default: null
CharacterCount.configure({
limit: 240,
})
mode
The mode by which the size is calculated.
Default: 'textSize'
CharacterCount.configure({
mode: 'nodeSize',
})
Storage
characters()
Get the number of characters for the current document.
editor.storage.characterCount.characters()
// Get the size of a specific node.
editor.storage.characterCount.characters({ node: someCustomNode })
// Overwrite the default `mode`.
editor.storage.characterCount.characters({ mode: 'nodeSize' })
words()
Get the number of words for the current document.
editor.storage.characterCount.words()
// Get the number of words for a specific node.
editor.storage.characterCount.words({ node: someCustomNode })
Source code
packages/extension-character-count/