mirror/tiptap
1
0
Fork 0
mirror of https://github.com/ueberdosis/tiptap.git synced 2025-06-07 17:43:49 +08:00
Code Issues Actions 4 Packages Projects Releases Wiki Activity

feat(character-count): add options for configuring counting (#5674)

Browse Source
This commit is contained in:
이호연 2024-09-30 23:38:29 +09:00 committed by GitHub
parent 45bac80328
commit 93bc93353b
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 21 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

5
.changeset/calm-bottles-shout.md Normal file
View File

@ -0,0 +1,5 @@
---
"@tiptap/extension-character-count": minor
---
Make counter function accessible from outside character-count extension

19
packages/extension-character-count/src/character-count.ts
View File

@ -16,6 +16,18 @@ export interface CharacterCountOptions {
* @example 'textSize' * @example 'textSize'
*/ */
mode: 'textSize' | 'nodeSize' mode: 'textSize' | 'nodeSize'
/**
* The text counter function to use. Defaults to a simple character count.
* @default (text) => text.length
* @example (text) => [...new Intl.Segmenter().segment(text)].length
*/
textCounter: (text: string) => number
/**
* The word counter function to use. Defaults to a simple word count.
* @default (text) => text.split(' ').filter(word => word !== '').length
* @example (text) => text.split(/\s+/).filter(word => word !== '').length
*/
wordCounter: (text: string) => number
} }
export interface CharacterCountStorage { export interface CharacterCountStorage {
@ -46,6 +58,8 @@ export const CharacterCount = Extension.create<CharacterCountOptions, CharacterC
return { return {
limit: null, limit: null,
mode: 'textSize', mode: 'textSize',
textCounter: text => text.length,
wordCounter: text => text.split(' ').filter(word => word !== '').length,
} }
}, },
@ -64,7 +78,7 @@ export const CharacterCount = Extension.create<CharacterCountOptions, CharacterC
if (mode === 'textSize') { if (mode === 'textSize') {
const text = node.textBetween(0, node.content.size, undefined, ' ') const text = node.textBetween(0, node.content.size, undefined, ' ')
return text.length return this.options.textCounter(text)
} }
return node.nodeSize return node.nodeSize
@ -73,9 +87,8 @@ export const CharacterCount = Extension.create<CharacterCountOptions, CharacterC
this.storage.words = options => { this.storage.words = options => {
const node = options?.node || this.editor.state.doc const node = options?.node || this.editor.state.doc
const text = node.textBetween(0, node.content.size, ' ', ' ') const text = node.textBetween(0, node.content.size, ' ', ' ')
const words = text.split(' ').filter(word => word !== '')
return words.length return this.options.wordCounter(text)
} }
}, },