@tiptap/extension-character-count 3.0.0-next.4 → 3.0.0-next.5
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/LICENSE.md +1 -1
- package/dist/index.cjs +7 -104
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +2 -57
- package/dist/index.d.ts +2 -57
- package/dist/index.js +4 -100
- package/dist/index.js.map +1 -1
- package/package.json +3 -5
- package/src/index.ts +2 -2
- package/src/character-count.ts +0 -189
package/LICENSE.md
CHANGED
package/dist/index.cjs
CHANGED
|
@@ -20,114 +20,17 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
|
|
|
20
20
|
// src/index.ts
|
|
21
21
|
var index_exports = {};
|
|
22
22
|
__export(index_exports, {
|
|
23
|
-
CharacterCount: () => CharacterCount,
|
|
23
|
+
CharacterCount: () => import_extensions2.CharacterCount,
|
|
24
|
+
CharacterCountOptions: () => import_extensions2.CharacterCountOptions,
|
|
24
25
|
default: () => index_default
|
|
25
26
|
});
|
|
26
27
|
module.exports = __toCommonJS(index_exports);
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
var
|
|
30
|
-
var import_state = require("@tiptap/pm/state");
|
|
31
|
-
var CharacterCount = import_core.Extension.create({
|
|
32
|
-
name: "characterCount",
|
|
33
|
-
addOptions() {
|
|
34
|
-
return {
|
|
35
|
-
limit: null,
|
|
36
|
-
mode: "textSize",
|
|
37
|
-
textCounter: (text) => text.length,
|
|
38
|
-
wordCounter: (text) => text.split(" ").filter((word) => word !== "").length
|
|
39
|
-
};
|
|
40
|
-
},
|
|
41
|
-
addStorage() {
|
|
42
|
-
return {
|
|
43
|
-
characters: () => 0,
|
|
44
|
-
words: () => 0
|
|
45
|
-
};
|
|
46
|
-
},
|
|
47
|
-
onBeforeCreate() {
|
|
48
|
-
this.storage.characters = (options) => {
|
|
49
|
-
const node = (options == null ? void 0 : options.node) || this.editor.state.doc;
|
|
50
|
-
const mode = (options == null ? void 0 : options.mode) || this.options.mode;
|
|
51
|
-
if (mode === "textSize") {
|
|
52
|
-
const text = node.textBetween(0, node.content.size, void 0, " ");
|
|
53
|
-
return this.options.textCounter(text);
|
|
54
|
-
}
|
|
55
|
-
return node.nodeSize;
|
|
56
|
-
};
|
|
57
|
-
this.storage.words = (options) => {
|
|
58
|
-
const node = (options == null ? void 0 : options.node) || this.editor.state.doc;
|
|
59
|
-
const text = node.textBetween(0, node.content.size, " ", " ");
|
|
60
|
-
return this.options.wordCounter(text);
|
|
61
|
-
};
|
|
62
|
-
},
|
|
63
|
-
addProseMirrorPlugins() {
|
|
64
|
-
let initialEvaluationDone = false;
|
|
65
|
-
return [
|
|
66
|
-
new import_state.Plugin({
|
|
67
|
-
key: new import_state.PluginKey("characterCount"),
|
|
68
|
-
appendTransaction: (transactions, oldState, newState) => {
|
|
69
|
-
if (initialEvaluationDone) {
|
|
70
|
-
return;
|
|
71
|
-
}
|
|
72
|
-
const limit = this.options.limit;
|
|
73
|
-
if (limit === null || limit === void 0 || limit === 0) {
|
|
74
|
-
initialEvaluationDone = true;
|
|
75
|
-
return;
|
|
76
|
-
}
|
|
77
|
-
const initialContentSize = this.storage.characters({ node: newState.doc });
|
|
78
|
-
if (initialContentSize > limit) {
|
|
79
|
-
const over = initialContentSize - limit;
|
|
80
|
-
const from = 0;
|
|
81
|
-
const to = over;
|
|
82
|
-
console.warn(
|
|
83
|
-
`[CharacterCount] Initial content exceeded limit of ${limit} characters. Content was automatically trimmed.`
|
|
84
|
-
);
|
|
85
|
-
const tr = newState.tr.deleteRange(from, to);
|
|
86
|
-
initialEvaluationDone = true;
|
|
87
|
-
return tr;
|
|
88
|
-
}
|
|
89
|
-
initialEvaluationDone = true;
|
|
90
|
-
},
|
|
91
|
-
filterTransaction: (transaction, state) => {
|
|
92
|
-
const limit = this.options.limit;
|
|
93
|
-
if (!transaction.docChanged || limit === 0 || limit === null || limit === void 0) {
|
|
94
|
-
return true;
|
|
95
|
-
}
|
|
96
|
-
const oldSize = this.storage.characters({ node: state.doc });
|
|
97
|
-
const newSize = this.storage.characters({ node: transaction.doc });
|
|
98
|
-
if (newSize <= limit) {
|
|
99
|
-
return true;
|
|
100
|
-
}
|
|
101
|
-
if (oldSize > limit && newSize > limit && newSize <= oldSize) {
|
|
102
|
-
return true;
|
|
103
|
-
}
|
|
104
|
-
if (oldSize > limit && newSize > limit && newSize > oldSize) {
|
|
105
|
-
return false;
|
|
106
|
-
}
|
|
107
|
-
const isPaste = transaction.getMeta("paste");
|
|
108
|
-
if (!isPaste) {
|
|
109
|
-
return false;
|
|
110
|
-
}
|
|
111
|
-
const pos = transaction.selection.$head.pos;
|
|
112
|
-
const over = newSize - limit;
|
|
113
|
-
const from = pos - over;
|
|
114
|
-
const to = pos;
|
|
115
|
-
transaction.deleteRange(from, to);
|
|
116
|
-
const updatedSize = this.storage.characters({ node: transaction.doc });
|
|
117
|
-
if (updatedSize > limit) {
|
|
118
|
-
return false;
|
|
119
|
-
}
|
|
120
|
-
return true;
|
|
121
|
-
}
|
|
122
|
-
})
|
|
123
|
-
];
|
|
124
|
-
}
|
|
125
|
-
});
|
|
126
|
-
|
|
127
|
-
// src/index.ts
|
|
128
|
-
var index_default = CharacterCount;
|
|
28
|
+
var import_extensions = require("@tiptap/extensions");
|
|
29
|
+
var import_extensions2 = require("@tiptap/extensions");
|
|
30
|
+
var index_default = import_extensions.CharacterCount;
|
|
129
31
|
// Annotate the CommonJS export names for ESM import in node:
|
|
130
32
|
0 && (module.exports = {
|
|
131
|
-
CharacterCount
|
|
33
|
+
CharacterCount,
|
|
34
|
+
CharacterCountOptions
|
|
132
35
|
});
|
|
133
36
|
//# sourceMappingURL=index.cjs.map
|
package/dist/index.cjs.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/index.ts"
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { CharacterCount } from '@tiptap/extensions'\n\nexport { CharacterCount, CharacterCountOptions } from '@tiptap/extensions'\n\nexport default CharacterCount\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA,wBAA+B;AAE/B,IAAAA,qBAAsD;AAEtD,IAAO,gBAAQ;","names":["import_extensions"]}
|
package/dist/index.d.cts
CHANGED
|
@@ -1,57 +1,2 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
interface CharacterCountOptions {
|
|
5
|
-
/**
|
|
6
|
-
* The maximum number of characters that should be allowed. Defaults to `0`.
|
|
7
|
-
* @default null
|
|
8
|
-
* @example 180
|
|
9
|
-
*/
|
|
10
|
-
limit: number | null | undefined;
|
|
11
|
-
/**
|
|
12
|
-
* The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.
|
|
13
|
-
* If set to `nodeSize`, the nodeSize of the document is used.
|
|
14
|
-
* @default 'textSize'
|
|
15
|
-
* @example 'textSize'
|
|
16
|
-
*/
|
|
17
|
-
mode: 'textSize' | 'nodeSize';
|
|
18
|
-
/**
|
|
19
|
-
* The text counter function to use. Defaults to a simple character count.
|
|
20
|
-
* @default (text) => text.length
|
|
21
|
-
* @example (text) => [...new Intl.Segmenter().segment(text)].length
|
|
22
|
-
*/
|
|
23
|
-
textCounter: (text: string) => number;
|
|
24
|
-
/**
|
|
25
|
-
* The word counter function to use. Defaults to a simple word count.
|
|
26
|
-
* @default (text) => text.split(' ').filter(word => word !== '').length
|
|
27
|
-
* @example (text) => text.split(/\s+/).filter(word => word !== '').length
|
|
28
|
-
*/
|
|
29
|
-
wordCounter: (text: string) => number;
|
|
30
|
-
}
|
|
31
|
-
interface CharacterCountStorage {
|
|
32
|
-
/**
|
|
33
|
-
* Get the number of characters for the current document.
|
|
34
|
-
* @param options The options for the character count. (optional)
|
|
35
|
-
* @param options.node The node to get the characters from. Defaults to the current document.
|
|
36
|
-
* @param options.mode The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.
|
|
37
|
-
*/
|
|
38
|
-
characters: (options?: {
|
|
39
|
-
node?: Node;
|
|
40
|
-
mode?: 'textSize' | 'nodeSize';
|
|
41
|
-
}) => number;
|
|
42
|
-
/**
|
|
43
|
-
* Get the number of words for the current document.
|
|
44
|
-
* @param options The options for the character count. (optional)
|
|
45
|
-
* @param options.node The node to get the words from. Defaults to the current document.
|
|
46
|
-
*/
|
|
47
|
-
words: (options?: {
|
|
48
|
-
node?: Node;
|
|
49
|
-
}) => number;
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* This extension allows you to count the characters and words of your document.
|
|
53
|
-
* @see https://tiptap.dev/api/extensions/character-count
|
|
54
|
-
*/
|
|
55
|
-
declare const CharacterCount: Extension<CharacterCountOptions, CharacterCountStorage>;
|
|
56
|
-
|
|
57
|
-
export { CharacterCount, type CharacterCountOptions, type CharacterCountStorage, CharacterCount as default };
|
|
1
|
+
import { CharacterCount } from '@tiptap/extensions';
|
|
2
|
+
export { CharacterCount, CharacterCountOptions, CharacterCount as default } from '@tiptap/extensions';
|
package/dist/index.d.ts
CHANGED
|
@@ -1,57 +1,2 @@
|
|
|
1
|
-
import {
|
|
2
|
-
|
|
3
|
-
|
|
4
|
-
interface CharacterCountOptions {
|
|
5
|
-
/**
|
|
6
|
-
* The maximum number of characters that should be allowed. Defaults to `0`.
|
|
7
|
-
* @default null
|
|
8
|
-
* @example 180
|
|
9
|
-
*/
|
|
10
|
-
limit: number | null | undefined;
|
|
11
|
-
/**
|
|
12
|
-
* The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.
|
|
13
|
-
* If set to `nodeSize`, the nodeSize of the document is used.
|
|
14
|
-
* @default 'textSize'
|
|
15
|
-
* @example 'textSize'
|
|
16
|
-
*/
|
|
17
|
-
mode: 'textSize' | 'nodeSize';
|
|
18
|
-
/**
|
|
19
|
-
* The text counter function to use. Defaults to a simple character count.
|
|
20
|
-
* @default (text) => text.length
|
|
21
|
-
* @example (text) => [...new Intl.Segmenter().segment(text)].length
|
|
22
|
-
*/
|
|
23
|
-
textCounter: (text: string) => number;
|
|
24
|
-
/**
|
|
25
|
-
* The word counter function to use. Defaults to a simple word count.
|
|
26
|
-
* @default (text) => text.split(' ').filter(word => word !== '').length
|
|
27
|
-
* @example (text) => text.split(/\s+/).filter(word => word !== '').length
|
|
28
|
-
*/
|
|
29
|
-
wordCounter: (text: string) => number;
|
|
30
|
-
}
|
|
31
|
-
interface CharacterCountStorage {
|
|
32
|
-
/**
|
|
33
|
-
* Get the number of characters for the current document.
|
|
34
|
-
* @param options The options for the character count. (optional)
|
|
35
|
-
* @param options.node The node to get the characters from. Defaults to the current document.
|
|
36
|
-
* @param options.mode The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.
|
|
37
|
-
*/
|
|
38
|
-
characters: (options?: {
|
|
39
|
-
node?: Node;
|
|
40
|
-
mode?: 'textSize' | 'nodeSize';
|
|
41
|
-
}) => number;
|
|
42
|
-
/**
|
|
43
|
-
* Get the number of words for the current document.
|
|
44
|
-
* @param options The options for the character count. (optional)
|
|
45
|
-
* @param options.node The node to get the words from. Defaults to the current document.
|
|
46
|
-
*/
|
|
47
|
-
words: (options?: {
|
|
48
|
-
node?: Node;
|
|
49
|
-
}) => number;
|
|
50
|
-
}
|
|
51
|
-
/**
|
|
52
|
-
* This extension allows you to count the characters and words of your document.
|
|
53
|
-
* @see https://tiptap.dev/api/extensions/character-count
|
|
54
|
-
*/
|
|
55
|
-
declare const CharacterCount: Extension<CharacterCountOptions, CharacterCountStorage>;
|
|
56
|
-
|
|
57
|
-
export { CharacterCount, type CharacterCountOptions, type CharacterCountStorage, CharacterCount as default };
|
|
1
|
+
import { CharacterCount } from '@tiptap/extensions';
|
|
2
|
+
export { CharacterCount, CharacterCountOptions, CharacterCount as default } from '@tiptap/extensions';
|
package/dist/index.js
CHANGED
|
@@ -1,106 +1,10 @@
|
|
|
1
|
-
// src/character-count.ts
|
|
2
|
-
import { Extension } from "@tiptap/core";
|
|
3
|
-
import { Plugin, PluginKey } from "@tiptap/pm/state";
|
|
4
|
-
var CharacterCount = Extension.create({
|
|
5
|
-
name: "characterCount",
|
|
6
|
-
addOptions() {
|
|
7
|
-
return {
|
|
8
|
-
limit: null,
|
|
9
|
-
mode: "textSize",
|
|
10
|
-
textCounter: (text) => text.length,
|
|
11
|
-
wordCounter: (text) => text.split(" ").filter((word) => word !== "").length
|
|
12
|
-
};
|
|
13
|
-
},
|
|
14
|
-
addStorage() {
|
|
15
|
-
return {
|
|
16
|
-
characters: () => 0,
|
|
17
|
-
words: () => 0
|
|
18
|
-
};
|
|
19
|
-
},
|
|
20
|
-
onBeforeCreate() {
|
|
21
|
-
this.storage.characters = (options) => {
|
|
22
|
-
const node = (options == null ? void 0 : options.node) || this.editor.state.doc;
|
|
23
|
-
const mode = (options == null ? void 0 : options.mode) || this.options.mode;
|
|
24
|
-
if (mode === "textSize") {
|
|
25
|
-
const text = node.textBetween(0, node.content.size, void 0, " ");
|
|
26
|
-
return this.options.textCounter(text);
|
|
27
|
-
}
|
|
28
|
-
return node.nodeSize;
|
|
29
|
-
};
|
|
30
|
-
this.storage.words = (options) => {
|
|
31
|
-
const node = (options == null ? void 0 : options.node) || this.editor.state.doc;
|
|
32
|
-
const text = node.textBetween(0, node.content.size, " ", " ");
|
|
33
|
-
return this.options.wordCounter(text);
|
|
34
|
-
};
|
|
35
|
-
},
|
|
36
|
-
addProseMirrorPlugins() {
|
|
37
|
-
let initialEvaluationDone = false;
|
|
38
|
-
return [
|
|
39
|
-
new Plugin({
|
|
40
|
-
key: new PluginKey("characterCount"),
|
|
41
|
-
appendTransaction: (transactions, oldState, newState) => {
|
|
42
|
-
if (initialEvaluationDone) {
|
|
43
|
-
return;
|
|
44
|
-
}
|
|
45
|
-
const limit = this.options.limit;
|
|
46
|
-
if (limit === null || limit === void 0 || limit === 0) {
|
|
47
|
-
initialEvaluationDone = true;
|
|
48
|
-
return;
|
|
49
|
-
}
|
|
50
|
-
const initialContentSize = this.storage.characters({ node: newState.doc });
|
|
51
|
-
if (initialContentSize > limit) {
|
|
52
|
-
const over = initialContentSize - limit;
|
|
53
|
-
const from = 0;
|
|
54
|
-
const to = over;
|
|
55
|
-
console.warn(
|
|
56
|
-
`[CharacterCount] Initial content exceeded limit of ${limit} characters. Content was automatically trimmed.`
|
|
57
|
-
);
|
|
58
|
-
const tr = newState.tr.deleteRange(from, to);
|
|
59
|
-
initialEvaluationDone = true;
|
|
60
|
-
return tr;
|
|
61
|
-
}
|
|
62
|
-
initialEvaluationDone = true;
|
|
63
|
-
},
|
|
64
|
-
filterTransaction: (transaction, state) => {
|
|
65
|
-
const limit = this.options.limit;
|
|
66
|
-
if (!transaction.docChanged || limit === 0 || limit === null || limit === void 0) {
|
|
67
|
-
return true;
|
|
68
|
-
}
|
|
69
|
-
const oldSize = this.storage.characters({ node: state.doc });
|
|
70
|
-
const newSize = this.storage.characters({ node: transaction.doc });
|
|
71
|
-
if (newSize <= limit) {
|
|
72
|
-
return true;
|
|
73
|
-
}
|
|
74
|
-
if (oldSize > limit && newSize > limit && newSize <= oldSize) {
|
|
75
|
-
return true;
|
|
76
|
-
}
|
|
77
|
-
if (oldSize > limit && newSize > limit && newSize > oldSize) {
|
|
78
|
-
return false;
|
|
79
|
-
}
|
|
80
|
-
const isPaste = transaction.getMeta("paste");
|
|
81
|
-
if (!isPaste) {
|
|
82
|
-
return false;
|
|
83
|
-
}
|
|
84
|
-
const pos = transaction.selection.$head.pos;
|
|
85
|
-
const over = newSize - limit;
|
|
86
|
-
const from = pos - over;
|
|
87
|
-
const to = pos;
|
|
88
|
-
transaction.deleteRange(from, to);
|
|
89
|
-
const updatedSize = this.storage.characters({ node: transaction.doc });
|
|
90
|
-
if (updatedSize > limit) {
|
|
91
|
-
return false;
|
|
92
|
-
}
|
|
93
|
-
return true;
|
|
94
|
-
}
|
|
95
|
-
})
|
|
96
|
-
];
|
|
97
|
-
}
|
|
98
|
-
});
|
|
99
|
-
|
|
100
1
|
// src/index.ts
|
|
2
|
+
import { CharacterCount } from "@tiptap/extensions";
|
|
3
|
+
import { CharacterCount as CharacterCount2, CharacterCountOptions } from "@tiptap/extensions";
|
|
101
4
|
var index_default = CharacterCount;
|
|
102
5
|
export {
|
|
103
|
-
CharacterCount,
|
|
6
|
+
CharacterCount2 as CharacterCount,
|
|
7
|
+
CharacterCountOptions,
|
|
104
8
|
index_default as default
|
|
105
9
|
};
|
|
106
10
|
//# sourceMappingURL=index.js.map
|
package/dist/index.js.map
CHANGED
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../src/
|
|
1
|
+
{"version":3,"sources":["../src/index.ts"],"sourcesContent":["import { CharacterCount } from '@tiptap/extensions'\n\nexport { CharacterCount, CharacterCountOptions } from '@tiptap/extensions'\n\nexport default CharacterCount\n"],"mappings":";AAAA,SAAS,sBAAsB;AAE/B,SAAS,kBAAAA,iBAAgB,6BAA6B;AAEtD,IAAO,gBAAQ;","names":["CharacterCount"]}
|
package/package.json
CHANGED
|
@@ -1,7 +1,7 @@
|
|
|
1
1
|
{
|
|
2
2
|
"name": "@tiptap/extension-character-count",
|
|
3
3
|
"description": "font family extension for tiptap",
|
|
4
|
-
"version": "3.0.0-next.
|
|
4
|
+
"version": "3.0.0-next.5",
|
|
5
5
|
"homepage": "https://tiptap.dev",
|
|
6
6
|
"keywords": [
|
|
7
7
|
"tiptap",
|
|
@@ -31,12 +31,10 @@
|
|
|
31
31
|
"dist"
|
|
32
32
|
],
|
|
33
33
|
"devDependencies": {
|
|
34
|
-
"@tiptap/
|
|
35
|
-
"@tiptap/pm": "^3.0.0-next.4"
|
|
34
|
+
"@tiptap/extensions": "^3.0.0-next.5"
|
|
36
35
|
},
|
|
37
36
|
"peerDependencies": {
|
|
38
|
-
"@tiptap/
|
|
39
|
-
"@tiptap/pm": "^3.0.0-next.1"
|
|
37
|
+
"@tiptap/extensions": "^3.0.0-next.3"
|
|
40
38
|
},
|
|
41
39
|
"repository": {
|
|
42
40
|
"type": "git",
|
package/src/index.ts
CHANGED
package/src/character-count.ts
DELETED
|
@@ -1,189 +0,0 @@
|
|
|
1
|
-
import { Extension } from '@tiptap/core'
|
|
2
|
-
import { Node as ProseMirrorNode } from '@tiptap/pm/model'
|
|
3
|
-
import { Plugin, PluginKey } from '@tiptap/pm/state'
|
|
4
|
-
|
|
5
|
-
export interface CharacterCountOptions {
|
|
6
|
-
/**
|
|
7
|
-
* The maximum number of characters that should be allowed. Defaults to `0`.
|
|
8
|
-
* @default null
|
|
9
|
-
* @example 180
|
|
10
|
-
*/
|
|
11
|
-
limit: number | null | undefined
|
|
12
|
-
/**
|
|
13
|
-
* The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.
|
|
14
|
-
* If set to `nodeSize`, the nodeSize of the document is used.
|
|
15
|
-
* @default 'textSize'
|
|
16
|
-
* @example 'textSize'
|
|
17
|
-
*/
|
|
18
|
-
mode: 'textSize' | 'nodeSize'
|
|
19
|
-
/**
|
|
20
|
-
* The text counter function to use. Defaults to a simple character count.
|
|
21
|
-
* @default (text) => text.length
|
|
22
|
-
* @example (text) => [...new Intl.Segmenter().segment(text)].length
|
|
23
|
-
*/
|
|
24
|
-
textCounter: (text: string) => number
|
|
25
|
-
/**
|
|
26
|
-
* The word counter function to use. Defaults to a simple word count.
|
|
27
|
-
* @default (text) => text.split(' ').filter(word => word !== '').length
|
|
28
|
-
* @example (text) => text.split(/\s+/).filter(word => word !== '').length
|
|
29
|
-
*/
|
|
30
|
-
wordCounter: (text: string) => number
|
|
31
|
-
}
|
|
32
|
-
|
|
33
|
-
export interface CharacterCountStorage {
|
|
34
|
-
/**
|
|
35
|
-
* Get the number of characters for the current document.
|
|
36
|
-
* @param options The options for the character count. (optional)
|
|
37
|
-
* @param options.node The node to get the characters from. Defaults to the current document.
|
|
38
|
-
* @param options.mode The mode by which the size is calculated. If set to `textSize`, the textContent of the document is used.
|
|
39
|
-
*/
|
|
40
|
-
characters: (options?: { node?: ProseMirrorNode; mode?: 'textSize' | 'nodeSize' }) => number
|
|
41
|
-
|
|
42
|
-
/**
|
|
43
|
-
* Get the number of words for the current document.
|
|
44
|
-
* @param options The options for the character count. (optional)
|
|
45
|
-
* @param options.node The node to get the words from. Defaults to the current document.
|
|
46
|
-
*/
|
|
47
|
-
words: (options?: { node?: ProseMirrorNode }) => number
|
|
48
|
-
}
|
|
49
|
-
|
|
50
|
-
/**
|
|
51
|
-
* This extension allows you to count the characters and words of your document.
|
|
52
|
-
* @see https://tiptap.dev/api/extensions/character-count
|
|
53
|
-
*/
|
|
54
|
-
export const CharacterCount = Extension.create<CharacterCountOptions, CharacterCountStorage>({
|
|
55
|
-
name: 'characterCount',
|
|
56
|
-
|
|
57
|
-
addOptions() {
|
|
58
|
-
return {
|
|
59
|
-
limit: null,
|
|
60
|
-
mode: 'textSize',
|
|
61
|
-
textCounter: text => text.length,
|
|
62
|
-
wordCounter: text => text.split(' ').filter(word => word !== '').length,
|
|
63
|
-
}
|
|
64
|
-
},
|
|
65
|
-
|
|
66
|
-
addStorage() {
|
|
67
|
-
return {
|
|
68
|
-
characters: () => 0,
|
|
69
|
-
words: () => 0,
|
|
70
|
-
}
|
|
71
|
-
},
|
|
72
|
-
|
|
73
|
-
onBeforeCreate() {
|
|
74
|
-
this.storage.characters = options => {
|
|
75
|
-
const node = options?.node || this.editor.state.doc
|
|
76
|
-
const mode = options?.mode || this.options.mode
|
|
77
|
-
|
|
78
|
-
if (mode === 'textSize') {
|
|
79
|
-
const text = node.textBetween(0, node.content.size, undefined, ' ')
|
|
80
|
-
|
|
81
|
-
return this.options.textCounter(text)
|
|
82
|
-
}
|
|
83
|
-
|
|
84
|
-
return node.nodeSize
|
|
85
|
-
}
|
|
86
|
-
|
|
87
|
-
this.storage.words = options => {
|
|
88
|
-
const node = options?.node || this.editor.state.doc
|
|
89
|
-
const text = node.textBetween(0, node.content.size, ' ', ' ')
|
|
90
|
-
|
|
91
|
-
return this.options.wordCounter(text)
|
|
92
|
-
}
|
|
93
|
-
},
|
|
94
|
-
|
|
95
|
-
addProseMirrorPlugins() {
|
|
96
|
-
let initialEvaluationDone = false
|
|
97
|
-
|
|
98
|
-
return [
|
|
99
|
-
new Plugin({
|
|
100
|
-
key: new PluginKey('characterCount'),
|
|
101
|
-
appendTransaction: (transactions, oldState, newState) => {
|
|
102
|
-
if (initialEvaluationDone) {
|
|
103
|
-
return
|
|
104
|
-
}
|
|
105
|
-
|
|
106
|
-
const limit = this.options.limit
|
|
107
|
-
|
|
108
|
-
if (limit === null || limit === undefined || limit === 0) {
|
|
109
|
-
initialEvaluationDone = true
|
|
110
|
-
return
|
|
111
|
-
}
|
|
112
|
-
|
|
113
|
-
const initialContentSize = this.storage.characters({ node: newState.doc })
|
|
114
|
-
|
|
115
|
-
if (initialContentSize > limit) {
|
|
116
|
-
const over = initialContentSize - limit
|
|
117
|
-
const from = 0
|
|
118
|
-
const to = over
|
|
119
|
-
|
|
120
|
-
console.warn(
|
|
121
|
-
`[CharacterCount] Initial content exceeded limit of ${limit} characters. Content was automatically trimmed.`,
|
|
122
|
-
)
|
|
123
|
-
const tr = newState.tr.deleteRange(from, to)
|
|
124
|
-
|
|
125
|
-
initialEvaluationDone = true
|
|
126
|
-
return tr
|
|
127
|
-
}
|
|
128
|
-
|
|
129
|
-
initialEvaluationDone = true
|
|
130
|
-
},
|
|
131
|
-
filterTransaction: (transaction, state) => {
|
|
132
|
-
const limit = this.options.limit
|
|
133
|
-
|
|
134
|
-
// Nothing has changed or no limit is defined. Ignore it.
|
|
135
|
-
if (!transaction.docChanged || limit === 0 || limit === null || limit === undefined) {
|
|
136
|
-
return true
|
|
137
|
-
}
|
|
138
|
-
|
|
139
|
-
const oldSize = this.storage.characters({ node: state.doc })
|
|
140
|
-
const newSize = this.storage.characters({ node: transaction.doc })
|
|
141
|
-
|
|
142
|
-
// Everything is in the limit. Good.
|
|
143
|
-
if (newSize <= limit) {
|
|
144
|
-
return true
|
|
145
|
-
}
|
|
146
|
-
|
|
147
|
-
// The limit has already been exceeded but will be reduced.
|
|
148
|
-
if (oldSize > limit && newSize > limit && newSize <= oldSize) {
|
|
149
|
-
return true
|
|
150
|
-
}
|
|
151
|
-
|
|
152
|
-
// The limit has already been exceeded and will be increased further.
|
|
153
|
-
if (oldSize > limit && newSize > limit && newSize > oldSize) {
|
|
154
|
-
return false
|
|
155
|
-
}
|
|
156
|
-
|
|
157
|
-
const isPaste = transaction.getMeta('paste')
|
|
158
|
-
|
|
159
|
-
// Block all exceeding transactions that were not pasted.
|
|
160
|
-
if (!isPaste) {
|
|
161
|
-
return false
|
|
162
|
-
}
|
|
163
|
-
|
|
164
|
-
// For pasted content, we try to remove the exceeding content.
|
|
165
|
-
const pos = transaction.selection.$head.pos
|
|
166
|
-
const over = newSize - limit
|
|
167
|
-
const from = pos - over
|
|
168
|
-
const to = pos
|
|
169
|
-
|
|
170
|
-
// It’s probably a bad idea to mutate transactions within `filterTransaction`
|
|
171
|
-
// but for now this is working fine.
|
|
172
|
-
transaction.deleteRange(from, to)
|
|
173
|
-
|
|
174
|
-
// In some situations, the limit will continue to be exceeded after trimming.
|
|
175
|
-
// This happens e.g. when truncating within a complex node (e.g. table)
|
|
176
|
-
// and ProseMirror has to close this node again.
|
|
177
|
-
// If this is the case, we prevent the transaction completely.
|
|
178
|
-
const updatedSize = this.storage.characters({ node: transaction.doc })
|
|
179
|
-
|
|
180
|
-
if (updatedSize > limit) {
|
|
181
|
-
return false
|
|
182
|
-
}
|
|
183
|
-
|
|
184
|
-
return true
|
|
185
|
-
},
|
|
186
|
-
}),
|
|
187
|
-
]
|
|
188
|
-
},
|
|
189
|
-
})
|