@tiptap/extension-highlight 2.6.2 → 3.0.0-next.1
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/dist/index.cjs +110 -91
- package/dist/index.cjs.map +1 -1
- package/dist/{packages/extension-highlight/src/highlight.d.ts → index.d.cts} +7 -4
- package/dist/index.d.ts +58 -0
- package/dist/index.js +88 -86
- package/dist/index.js.map +1 -1
- package/package.json +6 -8
- package/dist/index.umd.js +0 -101
- package/dist/index.umd.js.map +0 -1
- package/dist/packages/core/src/CommandManager.d.ts +0 -20
- package/dist/packages/core/src/Editor.d.ts +0 -163
- package/dist/packages/core/src/EventEmitter.d.ts +0 -11
- package/dist/packages/core/src/Extension.d.ts +0 -344
- package/dist/packages/core/src/ExtensionManager.d.ts +0 -55
- package/dist/packages/core/src/InputRule.d.ts +0 -42
- package/dist/packages/core/src/Mark.d.ts +0 -452
- package/dist/packages/core/src/Node.d.ts +0 -612
- package/dist/packages/core/src/NodePos.d.ts +0 -44
- package/dist/packages/core/src/NodeView.d.ts +0 -31
- package/dist/packages/core/src/PasteRule.d.ts +0 -50
- package/dist/packages/core/src/Tracker.d.ts +0 -11
- package/dist/packages/core/src/commands/blur.d.ts +0 -13
- package/dist/packages/core/src/commands/clearContent.d.ts +0 -14
- package/dist/packages/core/src/commands/clearNodes.d.ts +0 -13
- package/dist/packages/core/src/commands/command.d.ts +0 -18
- package/dist/packages/core/src/commands/createParagraphNear.d.ts +0 -13
- package/dist/packages/core/src/commands/cut.d.ts +0 -20
- package/dist/packages/core/src/commands/deleteCurrentNode.d.ts +0 -13
- package/dist/packages/core/src/commands/deleteNode.d.ts +0 -15
- package/dist/packages/core/src/commands/deleteRange.d.ts +0 -14
- package/dist/packages/core/src/commands/deleteSelection.d.ts +0 -13
- package/dist/packages/core/src/commands/enter.d.ts +0 -13
- package/dist/packages/core/src/commands/exitCode.d.ts +0 -13
- package/dist/packages/core/src/commands/extendMarkRange.d.ts +0 -25
- package/dist/packages/core/src/commands/first.d.ts +0 -14
- package/dist/packages/core/src/commands/focus.d.ts +0 -27
- package/dist/packages/core/src/commands/forEach.d.ts +0 -14
- package/dist/packages/core/src/commands/index.d.ts +0 -55
- package/dist/packages/core/src/commands/insertContent.d.ts +0 -34
- package/dist/packages/core/src/commands/insertContentAt.d.ts +0 -47
- package/dist/packages/core/src/commands/join.d.ts +0 -41
- package/dist/packages/core/src/commands/joinItemBackward.d.ts +0 -13
- package/dist/packages/core/src/commands/joinItemForward.d.ts +0 -13
- package/dist/packages/core/src/commands/joinTextblockBackward.d.ts +0 -12
- package/dist/packages/core/src/commands/joinTextblockForward.d.ts +0 -12
- package/dist/packages/core/src/commands/keyboardShortcut.d.ts +0 -14
- package/dist/packages/core/src/commands/lift.d.ts +0 -17
- package/dist/packages/core/src/commands/liftEmptyBlock.d.ts +0 -13
- package/dist/packages/core/src/commands/liftListItem.d.ts +0 -15
- package/dist/packages/core/src/commands/newlineInCode.d.ts +0 -13
- package/dist/packages/core/src/commands/resetAttributes.d.ts +0 -16
- package/dist/packages/core/src/commands/scrollIntoView.d.ts +0 -13
- package/dist/packages/core/src/commands/selectAll.d.ts +0 -13
- package/dist/packages/core/src/commands/selectNodeBackward.d.ts +0 -13
- package/dist/packages/core/src/commands/selectNodeForward.d.ts +0 -13
- package/dist/packages/core/src/commands/selectParentNode.d.ts +0 -13
- package/dist/packages/core/src/commands/selectTextblockEnd.d.ts +0 -13
- package/dist/packages/core/src/commands/selectTextblockStart.d.ts +0 -13
- package/dist/packages/core/src/commands/setContent.d.ts +0 -40
- package/dist/packages/core/src/commands/setMark.d.ts +0 -15
- package/dist/packages/core/src/commands/setMeta.d.ts +0 -16
- package/dist/packages/core/src/commands/setNode.d.ts +0 -16
- package/dist/packages/core/src/commands/setNodeSelection.d.ts +0 -14
- package/dist/packages/core/src/commands/setTextSelection.d.ts +0 -14
- package/dist/packages/core/src/commands/sinkListItem.d.ts +0 -15
- package/dist/packages/core/src/commands/splitBlock.d.ts +0 -17
- package/dist/packages/core/src/commands/splitListItem.d.ts +0 -16
- package/dist/packages/core/src/commands/toggleList.d.ts +0 -18
- package/dist/packages/core/src/commands/toggleMark.d.ts +0 -30
- package/dist/packages/core/src/commands/toggleNode.d.ts +0 -17
- package/dist/packages/core/src/commands/toggleWrap.d.ts +0 -16
- package/dist/packages/core/src/commands/undoInputRule.d.ts +0 -13
- package/dist/packages/core/src/commands/unsetAllMarks.d.ts +0 -13
- package/dist/packages/core/src/commands/unsetMark.d.ts +0 -25
- package/dist/packages/core/src/commands/updateAttributes.d.ts +0 -24
- package/dist/packages/core/src/commands/wrapIn.d.ts +0 -16
- package/dist/packages/core/src/commands/wrapInList.d.ts +0 -16
- package/dist/packages/core/src/extensions/clipboardTextSerializer.d.ts +0 -5
- package/dist/packages/core/src/extensions/commands.d.ts +0 -3
- package/dist/packages/core/src/extensions/editable.d.ts +0 -2
- package/dist/packages/core/src/extensions/focusEvents.d.ts +0 -2
- package/dist/packages/core/src/extensions/index.d.ts +0 -6
- package/dist/packages/core/src/extensions/keymap.d.ts +0 -2
- package/dist/packages/core/src/extensions/tabindex.d.ts +0 -2
- package/dist/packages/core/src/helpers/combineTransactionSteps.d.ts +0 -10
- package/dist/packages/core/src/helpers/createChainableState.d.ts +0 -10
- package/dist/packages/core/src/helpers/createDocument.d.ts +0 -12
- package/dist/packages/core/src/helpers/createNodeFromContent.d.ts +0 -15
- package/dist/packages/core/src/helpers/defaultBlockAt.d.ts +0 -7
- package/dist/packages/core/src/helpers/findChildren.d.ts +0 -9
- package/dist/packages/core/src/helpers/findChildrenInRange.d.ts +0 -10
- package/dist/packages/core/src/helpers/findParentNode.d.ts +0 -16
- package/dist/packages/core/src/helpers/findParentNodeClosestToPos.d.ts +0 -17
- package/dist/packages/core/src/helpers/generateHTML.d.ts +0 -8
- package/dist/packages/core/src/helpers/generateJSON.d.ts +0 -8
- package/dist/packages/core/src/helpers/generateText.d.ts +0 -12
- package/dist/packages/core/src/helpers/getAttributes.d.ts +0 -9
- package/dist/packages/core/src/helpers/getAttributesFromExtensions.d.ts +0 -6
- package/dist/packages/core/src/helpers/getChangedRanges.d.ts +0 -11
- package/dist/packages/core/src/helpers/getDebugJSON.d.ts +0 -8
- package/dist/packages/core/src/helpers/getExtensionField.d.ts +0 -9
- package/dist/packages/core/src/helpers/getHTMLFromFragment.d.ts +0 -2
- package/dist/packages/core/src/helpers/getMarkAttributes.d.ts +0 -3
- package/dist/packages/core/src/helpers/getMarkRange.d.ts +0 -3
- package/dist/packages/core/src/helpers/getMarkType.d.ts +0 -2
- package/dist/packages/core/src/helpers/getMarksBetween.d.ts +0 -3
- package/dist/packages/core/src/helpers/getNodeAtPosition.d.ts +0 -11
- package/dist/packages/core/src/helpers/getNodeAttributes.d.ts +0 -3
- package/dist/packages/core/src/helpers/getNodeType.d.ts +0 -2
- package/dist/packages/core/src/helpers/getRenderedAttributes.d.ts +0 -3
- package/dist/packages/core/src/helpers/getSchema.d.ts +0 -4
- package/dist/packages/core/src/helpers/getSchemaByResolvedExtensions.d.ts +0 -10
- package/dist/packages/core/src/helpers/getSchemaTypeByName.d.ts +0 -8
- package/dist/packages/core/src/helpers/getSchemaTypeNameByName.d.ts +0 -8
- package/dist/packages/core/src/helpers/getSplittedAttributes.d.ts +0 -9
- package/dist/packages/core/src/helpers/getText.d.ts +0 -15
- package/dist/packages/core/src/helpers/getTextBetween.d.ts +0 -14
- package/dist/packages/core/src/helpers/getTextContentFromNodes.d.ts +0 -8
- package/dist/packages/core/src/helpers/getTextSerializersFromSchema.d.ts +0 -8
- package/dist/packages/core/src/helpers/index.d.ts +0 -50
- package/dist/packages/core/src/helpers/injectExtensionAttributesToParseRule.d.ts +0 -9
- package/dist/packages/core/src/helpers/isActive.d.ts +0 -2
- package/dist/packages/core/src/helpers/isAtEndOfNode.d.ts +0 -2
- package/dist/packages/core/src/helpers/isAtStartOfNode.d.ts +0 -2
- package/dist/packages/core/src/helpers/isExtensionRulesEnabled.d.ts +0 -2
- package/dist/packages/core/src/helpers/isList.d.ts +0 -2
- package/dist/packages/core/src/helpers/isMarkActive.d.ts +0 -3
- package/dist/packages/core/src/helpers/isNodeActive.d.ts +0 -3
- package/dist/packages/core/src/helpers/isNodeEmpty.d.ts +0 -14
- package/dist/packages/core/src/helpers/isNodeSelection.d.ts +0 -2
- package/dist/packages/core/src/helpers/isTextSelection.d.ts +0 -2
- package/dist/packages/core/src/helpers/posToDOMRect.d.ts +0 -2
- package/dist/packages/core/src/helpers/resolveFocusPosition.d.ts +0 -4
- package/dist/packages/core/src/helpers/selectionToInsertionEnd.d.ts +0 -2
- package/dist/packages/core/src/helpers/splitExtensions.d.ts +0 -9
- package/dist/packages/core/src/index.d.ts +0 -24
- package/dist/packages/core/src/inputRules/index.d.ts +0 -5
- package/dist/packages/core/src/inputRules/markInputRule.d.ts +0 -13
- package/dist/packages/core/src/inputRules/nodeInputRule.d.ts +0 -23
- package/dist/packages/core/src/inputRules/textInputRule.d.ts +0 -10
- package/dist/packages/core/src/inputRules/textblockTypeInputRule.d.ts +0 -15
- package/dist/packages/core/src/inputRules/wrappingInputRule.d.ts +0 -28
- package/dist/packages/core/src/pasteRules/index.d.ts +0 -3
- package/dist/packages/core/src/pasteRules/markPasteRule.d.ts +0 -13
- package/dist/packages/core/src/pasteRules/nodePasteRule.d.ts +0 -14
- package/dist/packages/core/src/pasteRules/textPasteRule.d.ts +0 -10
- package/dist/packages/core/src/style.d.ts +0 -1
- package/dist/packages/core/src/types.d.ts +0 -253
- package/dist/packages/core/src/utilities/callOrReturn.d.ts +0 -9
- package/dist/packages/core/src/utilities/createStyleTag.d.ts +0 -1
- package/dist/packages/core/src/utilities/deleteProps.d.ts +0 -6
- package/dist/packages/core/src/utilities/elementFromString.d.ts +0 -1
- package/dist/packages/core/src/utilities/escapeForRegEx.d.ts +0 -1
- package/dist/packages/core/src/utilities/findDuplicates.d.ts +0 -1
- package/dist/packages/core/src/utilities/fromString.d.ts +0 -1
- package/dist/packages/core/src/utilities/index.d.ts +0 -20
- package/dist/packages/core/src/utilities/isAndroid.d.ts +0 -1
- package/dist/packages/core/src/utilities/isEmptyObject.d.ts +0 -1
- package/dist/packages/core/src/utilities/isFunction.d.ts +0 -1
- package/dist/packages/core/src/utilities/isMacOS.d.ts +0 -1
- package/dist/packages/core/src/utilities/isNumber.d.ts +0 -1
- package/dist/packages/core/src/utilities/isPlainObject.d.ts +0 -1
- package/dist/packages/core/src/utilities/isRegExp.d.ts +0 -1
- package/dist/packages/core/src/utilities/isString.d.ts +0 -1
- package/dist/packages/core/src/utilities/isiOS.d.ts +0 -1
- package/dist/packages/core/src/utilities/mergeAttributes.d.ts +0 -1
- package/dist/packages/core/src/utilities/mergeDeep.d.ts +0 -1
- package/dist/packages/core/src/utilities/minMax.d.ts +0 -1
- package/dist/packages/core/src/utilities/objectIncludes.d.ts +0 -8
- package/dist/packages/core/src/utilities/removeDuplicates.d.ts +0 -8
- package/dist/packages/extension-highlight/src/index.d.ts +0 -3
package/dist/index.umd.js
DELETED
|
@@ -1,101 +0,0 @@
|
|
|
1
|
-
(function (global, factory) {
|
|
2
|
-
typeof exports === 'object' && typeof module !== 'undefined' ? factory(exports, require('@tiptap/core')) :
|
|
3
|
-
typeof define === 'function' && define.amd ? define(['exports', '@tiptap/core'], factory) :
|
|
4
|
-
(global = typeof globalThis !== 'undefined' ? globalThis : global || self, factory(global["@tiptap/extension-highlight"] = {}, global.core));
|
|
5
|
-
})(this, (function (exports, core) { 'use strict';
|
|
6
|
-
|
|
7
|
-
/**
|
|
8
|
-
* Matches a highlight to a ==highlight== on input.
|
|
9
|
-
*/
|
|
10
|
-
const inputRegex = /(?:^|\s)(==(?!\s+==)((?:[^=]+))==(?!\s+==))$/;
|
|
11
|
-
/**
|
|
12
|
-
* Matches a highlight to a ==highlight== on paste.
|
|
13
|
-
*/
|
|
14
|
-
const pasteRegex = /(?:^|\s)(==(?!\s+==)((?:[^=]+))==(?!\s+==))/g;
|
|
15
|
-
/**
|
|
16
|
-
* This extension allows you to highlight text.
|
|
17
|
-
* @see https://www.tiptap.dev/api/marks/highlight
|
|
18
|
-
*/
|
|
19
|
-
const Highlight = core.Mark.create({
|
|
20
|
-
name: 'highlight',
|
|
21
|
-
addOptions() {
|
|
22
|
-
return {
|
|
23
|
-
multicolor: false,
|
|
24
|
-
HTMLAttributes: {},
|
|
25
|
-
};
|
|
26
|
-
},
|
|
27
|
-
addAttributes() {
|
|
28
|
-
if (!this.options.multicolor) {
|
|
29
|
-
return {};
|
|
30
|
-
}
|
|
31
|
-
return {
|
|
32
|
-
color: {
|
|
33
|
-
default: null,
|
|
34
|
-
parseHTML: element => element.getAttribute('data-color') || element.style.backgroundColor,
|
|
35
|
-
renderHTML: attributes => {
|
|
36
|
-
if (!attributes.color) {
|
|
37
|
-
return {};
|
|
38
|
-
}
|
|
39
|
-
return {
|
|
40
|
-
'data-color': attributes.color,
|
|
41
|
-
style: `background-color: ${attributes.color}; color: inherit`,
|
|
42
|
-
};
|
|
43
|
-
},
|
|
44
|
-
},
|
|
45
|
-
};
|
|
46
|
-
},
|
|
47
|
-
parseHTML() {
|
|
48
|
-
return [
|
|
49
|
-
{
|
|
50
|
-
tag: 'mark',
|
|
51
|
-
},
|
|
52
|
-
];
|
|
53
|
-
},
|
|
54
|
-
renderHTML({ HTMLAttributes }) {
|
|
55
|
-
return ['mark', core.mergeAttributes(this.options.HTMLAttributes, HTMLAttributes), 0];
|
|
56
|
-
},
|
|
57
|
-
addCommands() {
|
|
58
|
-
return {
|
|
59
|
-
setHighlight: attributes => ({ commands }) => {
|
|
60
|
-
return commands.setMark(this.name, attributes);
|
|
61
|
-
},
|
|
62
|
-
toggleHighlight: attributes => ({ commands }) => {
|
|
63
|
-
return commands.toggleMark(this.name, attributes);
|
|
64
|
-
},
|
|
65
|
-
unsetHighlight: () => ({ commands }) => {
|
|
66
|
-
return commands.unsetMark(this.name);
|
|
67
|
-
},
|
|
68
|
-
};
|
|
69
|
-
},
|
|
70
|
-
addKeyboardShortcuts() {
|
|
71
|
-
return {
|
|
72
|
-
'Mod-Shift-h': () => this.editor.commands.toggleHighlight(),
|
|
73
|
-
};
|
|
74
|
-
},
|
|
75
|
-
addInputRules() {
|
|
76
|
-
return [
|
|
77
|
-
core.markInputRule({
|
|
78
|
-
find: inputRegex,
|
|
79
|
-
type: this.type,
|
|
80
|
-
}),
|
|
81
|
-
];
|
|
82
|
-
},
|
|
83
|
-
addPasteRules() {
|
|
84
|
-
return [
|
|
85
|
-
core.markPasteRule({
|
|
86
|
-
find: pasteRegex,
|
|
87
|
-
type: this.type,
|
|
88
|
-
}),
|
|
89
|
-
];
|
|
90
|
-
},
|
|
91
|
-
});
|
|
92
|
-
|
|
93
|
-
exports.Highlight = Highlight;
|
|
94
|
-
exports.default = Highlight;
|
|
95
|
-
exports.inputRegex = inputRegex;
|
|
96
|
-
exports.pasteRegex = pasteRegex;
|
|
97
|
-
|
|
98
|
-
Object.defineProperty(exports, '__esModule', { value: true });
|
|
99
|
-
|
|
100
|
-
}));
|
|
101
|
-
//# sourceMappingURL=index.umd.js.map
|
package/dist/index.umd.js.map
DELETED
|
@@ -1 +0,0 @@
|
|
|
1
|
-
{"version":3,"file":"index.umd.js","sources":["../src/highlight.ts"],"sourcesContent":["import {\n Mark,\n markInputRule,\n markPasteRule,\n mergeAttributes,\n} from '@tiptap/core'\n\nexport interface HighlightOptions {\n /**\n * Allow multiple highlight colors\n * @default false\n * @example true\n */\n multicolor: boolean,\n\n /**\n * HTML attributes to add to the highlight element.\n * @default {}\n * @example { class: 'foo' }\n */\n HTMLAttributes: Record<string, any>,\n}\n\ndeclare module '@tiptap/core' {\n interface Commands<ReturnType> {\n highlight: {\n /**\n * Set a highlight mark\n * @param attributes The highlight attributes\n * @example editor.commands.setHighlight({ color: 'red' })\n */\n setHighlight: (attributes?: { color: string }) => ReturnType,\n /**\n * Toggle a highlight mark\n * @param attributes The highlight attributes\n * @example editor.commands.toggleHighlight({ color: 'red' })\n */\n toggleHighlight: (attributes?: { color: string }) => ReturnType,\n /**\n * Unset a highlight mark\n * @example editor.commands.unsetHighlight()\n */\n unsetHighlight: () => ReturnType,\n }\n }\n}\n\n/**\n * Matches a highlight to a ==highlight== on input.\n */\nexport const inputRegex = /(?:^|\\s)(==(?!\\s+==)((?:[^=]+))==(?!\\s+==))$/\n\n/**\n * Matches a highlight to a ==highlight== on paste.\n */\nexport const pasteRegex = /(?:^|\\s)(==(?!\\s+==)((?:[^=]+))==(?!\\s+==))/g\n\n/**\n * This extension allows you to highlight text.\n * @see https://www.tiptap.dev/api/marks/highlight\n */\nexport const Highlight = Mark.create<HighlightOptions>({\n name: 'highlight',\n\n addOptions() {\n return {\n multicolor: false,\n HTMLAttributes: {},\n }\n },\n\n addAttributes() {\n if (!this.options.multicolor) {\n return {}\n }\n\n return {\n color: {\n default: null,\n parseHTML: element => element.getAttribute('data-color') || element.style.backgroundColor,\n renderHTML: attributes => {\n if (!attributes.color) {\n return {}\n }\n\n return {\n 'data-color': attributes.color,\n style: `background-color: ${attributes.color}; color: inherit`,\n }\n },\n },\n }\n },\n\n parseHTML() {\n return [\n {\n tag: 'mark',\n },\n ]\n },\n\n renderHTML({ HTMLAttributes }) {\n return ['mark', mergeAttributes(this.options.HTMLAttributes, HTMLAttributes), 0]\n },\n\n addCommands() {\n return {\n setHighlight: attributes => ({ commands }) => {\n return commands.setMark(this.name, attributes)\n },\n toggleHighlight: attributes => ({ commands }) => {\n return commands.toggleMark(this.name, attributes)\n },\n unsetHighlight: () => ({ commands }) => {\n return commands.unsetMark(this.name)\n },\n }\n },\n\n addKeyboardShortcuts() {\n return {\n 'Mod-Shift-h': () => this.editor.commands.toggleHighlight(),\n }\n },\n\n addInputRules() {\n return [\n markInputRule({\n find: inputRegex,\n type: this.type,\n }),\n ]\n },\n\n addPasteRules() {\n return [\n markPasteRule({\n find: pasteRegex,\n type: this.type,\n }),\n ]\n },\n})\n"],"names":["Mark","mergeAttributes","markInputRule","markPasteRule"],"mappings":";;;;;;EA+CA;;EAEG;AACI,QAAM,UAAU,GAAG,+CAA8C;EAExE;;EAEG;AACI,QAAM,UAAU,GAAG,+CAA8C;EAExE;;;EAGG;AACU,QAAA,SAAS,GAAGA,SAAI,CAAC,MAAM,CAAmB;EACrD,IAAA,IAAI,EAAE,WAAW;MAEjB,UAAU,GAAA;UACR,OAAO;EACL,YAAA,UAAU,EAAE,KAAK;EACjB,YAAA,cAAc,EAAE,EAAE;WACnB,CAAA;OACF;MAED,aAAa,GAAA;EACX,QAAA,IAAI,CAAC,IAAI,CAAC,OAAO,CAAC,UAAU,EAAE;EAC5B,YAAA,OAAO,EAAE,CAAA;WACV;UAED,OAAO;EACL,YAAA,KAAK,EAAE;EACL,gBAAA,OAAO,EAAE,IAAI;EACb,gBAAA,SAAS,EAAE,OAAO,IAAI,OAAO,CAAC,YAAY,CAAC,YAAY,CAAC,IAAI,OAAO,CAAC,KAAK,CAAC,eAAe;kBACzF,UAAU,EAAE,UAAU,IAAG;EACvB,oBAAA,IAAI,CAAC,UAAU,CAAC,KAAK,EAAE;EACrB,wBAAA,OAAO,EAAE,CAAA;uBACV;sBAED,OAAO;0BACL,YAAY,EAAE,UAAU,CAAC,KAAK;EAC9B,wBAAA,KAAK,EAAE,CAAA,kBAAA,EAAqB,UAAU,CAAC,KAAK,CAAkB,gBAAA,CAAA;uBAC/D,CAAA;mBACF;EACF,aAAA;WACF,CAAA;OACF;MAED,SAAS,GAAA;UACP,OAAO;EACL,YAAA;EACE,gBAAA,GAAG,EAAE,MAAM;EACZ,aAAA;WACF,CAAA;OACF;MAED,UAAU,CAAC,EAAE,cAAc,EAAE,EAAA;EAC3B,QAAA,OAAO,CAAC,MAAM,EAAEC,oBAAe,CAAC,IAAI,CAAC,OAAO,CAAC,cAAc,EAAE,cAAc,CAAC,EAAE,CAAC,CAAC,CAAA;OACjF;MAED,WAAW,GAAA;UACT,OAAO;cACL,YAAY,EAAE,UAAU,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAI;kBAC3C,OAAO,QAAQ,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;eAC/C;cACD,eAAe,EAAE,UAAU,IAAI,CAAC,EAAE,QAAQ,EAAE,KAAI;kBAC9C,OAAO,QAAQ,CAAC,UAAU,CAAC,IAAI,CAAC,IAAI,EAAE,UAAU,CAAC,CAAA;eAClD;cACD,cAAc,EAAE,MAAM,CAAC,EAAE,QAAQ,EAAE,KAAI;kBACrC,OAAO,QAAQ,CAAC,SAAS,CAAC,IAAI,CAAC,IAAI,CAAC,CAAA;eACrC;WACF,CAAA;OACF;MAED,oBAAoB,GAAA;UAClB,OAAO;cACL,aAAa,EAAE,MAAM,IAAI,CAAC,MAAM,CAAC,QAAQ,CAAC,eAAe,EAAE;WAC5D,CAAA;OACF;MAED,aAAa,GAAA;UACX,OAAO;EACL,YAAAC,kBAAa,CAAC;EACZ,gBAAA,IAAI,EAAE,UAAU;kBAChB,IAAI,EAAE,IAAI,CAAC,IAAI;eAChB,CAAC;WACH,CAAA;OACF;MAED,aAAa,GAAA;UACX,OAAO;EACL,YAAAC,kBAAa,CAAC;EACZ,gBAAA,IAAI,EAAE,UAAU;kBAChB,IAAI,EAAE,IAAI,CAAC,IAAI;eAChB,CAAC;WACH,CAAA;OACF;EACF,CAAA;;;;;;;;;;;;;"}
|
|
@@ -1,20 +0,0 @@
|
|
|
1
|
-
import { EditorState, Transaction } from '@tiptap/pm/state';
|
|
2
|
-
import { Editor } from './Editor.js';
|
|
3
|
-
import { AnyCommands, CanCommands, ChainedCommands, CommandProps, SingleCommands } from './types.js';
|
|
4
|
-
export declare class CommandManager {
|
|
5
|
-
editor: Editor;
|
|
6
|
-
rawCommands: AnyCommands;
|
|
7
|
-
customState?: EditorState;
|
|
8
|
-
constructor(props: {
|
|
9
|
-
editor: Editor;
|
|
10
|
-
state?: EditorState;
|
|
11
|
-
});
|
|
12
|
-
get hasCustomState(): boolean;
|
|
13
|
-
get state(): EditorState;
|
|
14
|
-
get commands(): SingleCommands;
|
|
15
|
-
get chain(): () => ChainedCommands;
|
|
16
|
-
get can(): () => CanCommands;
|
|
17
|
-
createChain(startTr?: Transaction, shouldDispatch?: boolean): ChainedCommands;
|
|
18
|
-
createCan(startTr?: Transaction): CanCommands;
|
|
19
|
-
buildProps(tr: Transaction, shouldDispatch?: boolean): CommandProps;
|
|
20
|
-
}
|
|
@@ -1,163 +0,0 @@
|
|
|
1
|
-
import { MarkType, NodeType, Schema } from '@tiptap/pm/model';
|
|
2
|
-
import { EditorState, Plugin, PluginKey, Transaction } from '@tiptap/pm/state';
|
|
3
|
-
import { EditorView } from '@tiptap/pm/view';
|
|
4
|
-
import { EventEmitter } from './EventEmitter.js';
|
|
5
|
-
import { ExtensionManager } from './ExtensionManager.js';
|
|
6
|
-
import { NodePos } from './NodePos.js';
|
|
7
|
-
import { CanCommands, ChainedCommands, EditorEvents, EditorOptions, JSONContent, SingleCommands, TextSerializer } from './types.js';
|
|
8
|
-
export * as extensions from './extensions/index.js';
|
|
9
|
-
export interface TiptapEditorHTMLElement extends HTMLElement {
|
|
10
|
-
editor?: Editor;
|
|
11
|
-
}
|
|
12
|
-
export declare class Editor extends EventEmitter<EditorEvents> {
|
|
13
|
-
private commandManager;
|
|
14
|
-
extensionManager: ExtensionManager;
|
|
15
|
-
private css;
|
|
16
|
-
schema: Schema;
|
|
17
|
-
view: EditorView;
|
|
18
|
-
isFocused: boolean;
|
|
19
|
-
/**
|
|
20
|
-
* The editor is considered initialized after the `create` event has been emitted.
|
|
21
|
-
*/
|
|
22
|
-
isInitialized: boolean;
|
|
23
|
-
extensionStorage: Record<string, any>;
|
|
24
|
-
options: EditorOptions;
|
|
25
|
-
constructor(options?: Partial<EditorOptions>);
|
|
26
|
-
/**
|
|
27
|
-
* Returns the editor storage.
|
|
28
|
-
*/
|
|
29
|
-
get storage(): Record<string, any>;
|
|
30
|
-
/**
|
|
31
|
-
* An object of all registered commands.
|
|
32
|
-
*/
|
|
33
|
-
get commands(): SingleCommands;
|
|
34
|
-
/**
|
|
35
|
-
* Create a command chain to call multiple commands at once.
|
|
36
|
-
*/
|
|
37
|
-
chain(): ChainedCommands;
|
|
38
|
-
/**
|
|
39
|
-
* Check if a command or a command chain can be executed. Without executing it.
|
|
40
|
-
*/
|
|
41
|
-
can(): CanCommands;
|
|
42
|
-
/**
|
|
43
|
-
* Inject CSS styles.
|
|
44
|
-
*/
|
|
45
|
-
private injectCSS;
|
|
46
|
-
/**
|
|
47
|
-
* Update editor options.
|
|
48
|
-
*
|
|
49
|
-
* @param options A list of options
|
|
50
|
-
*/
|
|
51
|
-
setOptions(options?: Partial<EditorOptions>): void;
|
|
52
|
-
/**
|
|
53
|
-
* Update editable state of the editor.
|
|
54
|
-
*/
|
|
55
|
-
setEditable(editable: boolean, emitUpdate?: boolean): void;
|
|
56
|
-
/**
|
|
57
|
-
* Returns whether the editor is editable.
|
|
58
|
-
*/
|
|
59
|
-
get isEditable(): boolean;
|
|
60
|
-
/**
|
|
61
|
-
* Returns the editor state.
|
|
62
|
-
*/
|
|
63
|
-
get state(): EditorState;
|
|
64
|
-
/**
|
|
65
|
-
* Register a ProseMirror plugin.
|
|
66
|
-
*
|
|
67
|
-
* @param plugin A ProseMirror plugin
|
|
68
|
-
* @param handlePlugins Control how to merge the plugin into the existing plugins.
|
|
69
|
-
*/
|
|
70
|
-
registerPlugin(plugin: Plugin, handlePlugins?: (newPlugin: Plugin, plugins: Plugin[]) => Plugin[]): void;
|
|
71
|
-
/**
|
|
72
|
-
* Unregister a ProseMirror plugin.
|
|
73
|
-
*
|
|
74
|
-
* @param nameOrPluginKey The plugins name
|
|
75
|
-
*/
|
|
76
|
-
unregisterPlugin(nameOrPluginKey: string | PluginKey): void;
|
|
77
|
-
/**
|
|
78
|
-
* Creates an extension manager.
|
|
79
|
-
*/
|
|
80
|
-
private createExtensionManager;
|
|
81
|
-
/**
|
|
82
|
-
* Creates an command manager.
|
|
83
|
-
*/
|
|
84
|
-
private createCommandManager;
|
|
85
|
-
/**
|
|
86
|
-
* Creates a ProseMirror schema.
|
|
87
|
-
*/
|
|
88
|
-
private createSchema;
|
|
89
|
-
/**
|
|
90
|
-
* Creates a ProseMirror view.
|
|
91
|
-
*/
|
|
92
|
-
private createView;
|
|
93
|
-
/**
|
|
94
|
-
* Creates all node views.
|
|
95
|
-
*/
|
|
96
|
-
createNodeViews(): void;
|
|
97
|
-
/**
|
|
98
|
-
* Prepend class name to element.
|
|
99
|
-
*/
|
|
100
|
-
prependClass(): void;
|
|
101
|
-
isCapturingTransaction: boolean;
|
|
102
|
-
private capturedTransaction;
|
|
103
|
-
captureTransaction(fn: Function): Transaction | null;
|
|
104
|
-
/**
|
|
105
|
-
* The callback over which to send transactions (state updates) produced by the view.
|
|
106
|
-
*
|
|
107
|
-
* @param transaction An editor state transaction
|
|
108
|
-
*/
|
|
109
|
-
private dispatchTransaction;
|
|
110
|
-
/**
|
|
111
|
-
* Get attributes of the currently selected node or mark.
|
|
112
|
-
*/
|
|
113
|
-
getAttributes(nameOrType: string | NodeType | MarkType): Record<string, any>;
|
|
114
|
-
/**
|
|
115
|
-
* Returns if the currently selected node or mark is active.
|
|
116
|
-
*
|
|
117
|
-
* @param name Name of the node or mark
|
|
118
|
-
* @param attributes Attributes of the node or mark
|
|
119
|
-
*/
|
|
120
|
-
isActive(name: string, attributes?: {}): boolean;
|
|
121
|
-
isActive(attributes: {}): boolean;
|
|
122
|
-
/**
|
|
123
|
-
* Get the document as JSON.
|
|
124
|
-
*/
|
|
125
|
-
getJSON(): JSONContent;
|
|
126
|
-
/**
|
|
127
|
-
* Get the document as HTML.
|
|
128
|
-
*/
|
|
129
|
-
getHTML(): string;
|
|
130
|
-
/**
|
|
131
|
-
* Get the document as text.
|
|
132
|
-
*/
|
|
133
|
-
getText(options?: {
|
|
134
|
-
blockSeparator?: string;
|
|
135
|
-
textSerializers?: Record<string, TextSerializer>;
|
|
136
|
-
}): string;
|
|
137
|
-
/**
|
|
138
|
-
* Check if there is no content.
|
|
139
|
-
*/
|
|
140
|
-
get isEmpty(): boolean;
|
|
141
|
-
/**
|
|
142
|
-
* Get the number of characters for the current document.
|
|
143
|
-
*
|
|
144
|
-
* @deprecated
|
|
145
|
-
*/
|
|
146
|
-
getCharacterCount(): number;
|
|
147
|
-
/**
|
|
148
|
-
* Destroy the editor.
|
|
149
|
-
*/
|
|
150
|
-
destroy(): void;
|
|
151
|
-
/**
|
|
152
|
-
* Check if the editor is already destroyed.
|
|
153
|
-
*/
|
|
154
|
-
get isDestroyed(): boolean;
|
|
155
|
-
$node(selector: string, attributes?: {
|
|
156
|
-
[key: string]: any;
|
|
157
|
-
}): NodePos | null;
|
|
158
|
-
$nodes(selector: string, attributes?: {
|
|
159
|
-
[key: string]: any;
|
|
160
|
-
}): NodePos[] | null;
|
|
161
|
-
$pos(pos: number): NodePos;
|
|
162
|
-
get $doc(): NodePos;
|
|
163
|
-
}
|
|
@@ -1,11 +0,0 @@
|
|
|
1
|
-
type StringKeyOf<T> = Extract<keyof T, string>;
|
|
2
|
-
type CallbackType<T extends Record<string, any>, EventName extends StringKeyOf<T>> = T[EventName] extends any[] ? T[EventName] : [T[EventName]];
|
|
3
|
-
type CallbackFunction<T extends Record<string, any>, EventName extends StringKeyOf<T>> = (...props: CallbackType<T, EventName>) => any;
|
|
4
|
-
export declare class EventEmitter<T extends Record<string, any>> {
|
|
5
|
-
private callbacks;
|
|
6
|
-
on<EventName extends StringKeyOf<T>>(event: EventName, fn: CallbackFunction<T, EventName>): this;
|
|
7
|
-
emit<EventName extends StringKeyOf<T>>(event: EventName, ...args: CallbackType<T, EventName>): this;
|
|
8
|
-
off<EventName extends StringKeyOf<T>>(event: EventName, fn?: CallbackFunction<T, EventName>): this;
|
|
9
|
-
removeAllListeners(): void;
|
|
10
|
-
}
|
|
11
|
-
export {};
|
|
@@ -1,344 +0,0 @@
|
|
|
1
|
-
import { Plugin, Transaction } from '@tiptap/pm/state';
|
|
2
|
-
import { Editor } from './Editor.js';
|
|
3
|
-
import { ExtensionConfig } from './index.js';
|
|
4
|
-
import { InputRule } from './InputRule.js';
|
|
5
|
-
import { Mark } from './Mark.js';
|
|
6
|
-
import { Node } from './Node.js';
|
|
7
|
-
import { PasteRule } from './PasteRule.js';
|
|
8
|
-
import { Extensions, GlobalAttributes, KeyboardShortcutCommand, ParentConfig, RawCommands } from './types.js';
|
|
9
|
-
declare module '@tiptap/core' {
|
|
10
|
-
interface ExtensionConfig<Options = any, Storage = any> {
|
|
11
|
-
[key: string]: any;
|
|
12
|
-
/**
|
|
13
|
-
* The extension name - this must be unique.
|
|
14
|
-
* It will be used to identify the extension.
|
|
15
|
-
*
|
|
16
|
-
* @example 'myExtension'
|
|
17
|
-
*/
|
|
18
|
-
name: string;
|
|
19
|
-
/**
|
|
20
|
-
* The priority of your extension. The higher, the earlier it will be called
|
|
21
|
-
* and will take precedence over other extensions with a lower priority.
|
|
22
|
-
* @default 100
|
|
23
|
-
* @example 101
|
|
24
|
-
*/
|
|
25
|
-
priority?: number;
|
|
26
|
-
/**
|
|
27
|
-
* The default options for this extension.
|
|
28
|
-
* @example
|
|
29
|
-
* defaultOptions: {
|
|
30
|
-
* myOption: 'foo',
|
|
31
|
-
* myOtherOption: 10,
|
|
32
|
-
* }
|
|
33
|
-
*/
|
|
34
|
-
defaultOptions?: Options;
|
|
35
|
-
/**
|
|
36
|
-
* This method will add options to this extension
|
|
37
|
-
* @see https://tiptap.dev/docs/editor/guide/custom-extensions#settings
|
|
38
|
-
* @example
|
|
39
|
-
* addOptions() {
|
|
40
|
-
* return {
|
|
41
|
-
* myOption: 'foo',
|
|
42
|
-
* myOtherOption: 10,
|
|
43
|
-
* }
|
|
44
|
-
*/
|
|
45
|
-
addOptions?: (this: {
|
|
46
|
-
name: string;
|
|
47
|
-
parent: Exclude<ParentConfig<ExtensionConfig<Options, Storage>>['addOptions'], undefined>;
|
|
48
|
-
}) => Options;
|
|
49
|
-
/**
|
|
50
|
-
* The default storage this extension can save data to.
|
|
51
|
-
* @see https://tiptap.dev/docs/editor/guide/custom-extensions#storage
|
|
52
|
-
* @example
|
|
53
|
-
* defaultStorage: {
|
|
54
|
-
* prefetchedUsers: [],
|
|
55
|
-
* loading: false,
|
|
56
|
-
* }
|
|
57
|
-
*/
|
|
58
|
-
addStorage?: (this: {
|
|
59
|
-
name: string;
|
|
60
|
-
options: Options;
|
|
61
|
-
parent: Exclude<ParentConfig<ExtensionConfig<Options, Storage>>['addStorage'], undefined>;
|
|
62
|
-
}) => Storage;
|
|
63
|
-
/**
|
|
64
|
-
* This function adds globalAttributes to specific nodes.
|
|
65
|
-
* @see https://tiptap.dev/docs/editor/guide/custom-extensions#global-attributes
|
|
66
|
-
* @example
|
|
67
|
-
* addGlobalAttributes() {
|
|
68
|
-
* return [
|
|
69
|
-
* {
|
|
70
|
-
// Extend the following extensions
|
|
71
|
-
* types: [
|
|
72
|
-
* 'heading',
|
|
73
|
-
* 'paragraph',
|
|
74
|
-
* ],
|
|
75
|
-
* // … with those attributes
|
|
76
|
-
* attributes: {
|
|
77
|
-
* textAlign: {
|
|
78
|
-
* default: 'left',
|
|
79
|
-
* renderHTML: attributes => ({
|
|
80
|
-
* style: `text-align: ${attributes.textAlign}`,
|
|
81
|
-
* }),
|
|
82
|
-
* parseHTML: element => element.style.textAlign || 'left',
|
|
83
|
-
* },
|
|
84
|
-
* },
|
|
85
|
-
* },
|
|
86
|
-
* ]
|
|
87
|
-
* }
|
|
88
|
-
*/
|
|
89
|
-
addGlobalAttributes?: (this: {
|
|
90
|
-
name: string;
|
|
91
|
-
options: Options;
|
|
92
|
-
storage: Storage;
|
|
93
|
-
extensions: (Node | Mark)[];
|
|
94
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['addGlobalAttributes'];
|
|
95
|
-
}) => GlobalAttributes;
|
|
96
|
-
/**
|
|
97
|
-
* This function adds commands to the editor
|
|
98
|
-
* @see https://tiptap.dev/docs/editor/guide/custom-extensions#commands
|
|
99
|
-
* @example
|
|
100
|
-
* addCommands() {
|
|
101
|
-
* return {
|
|
102
|
-
* myCommand: () => ({ chain }) => chain().setMark('type', 'foo').run(),
|
|
103
|
-
* }
|
|
104
|
-
* }
|
|
105
|
-
*/
|
|
106
|
-
addCommands?: (this: {
|
|
107
|
-
name: string;
|
|
108
|
-
options: Options;
|
|
109
|
-
storage: Storage;
|
|
110
|
-
editor: Editor;
|
|
111
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['addCommands'];
|
|
112
|
-
}) => Partial<RawCommands>;
|
|
113
|
-
/**
|
|
114
|
-
* This function registers keyboard shortcuts.
|
|
115
|
-
* @see https://tiptap.dev/docs/editor/guide/custom-extensions#keyboard-shortcuts
|
|
116
|
-
* @example
|
|
117
|
-
* addKeyboardShortcuts() {
|
|
118
|
-
* return {
|
|
119
|
-
* 'Mod-l': () => this.editor.commands.toggleBulletList(),
|
|
120
|
-
* }
|
|
121
|
-
* },
|
|
122
|
-
*/
|
|
123
|
-
addKeyboardShortcuts?: (this: {
|
|
124
|
-
name: string;
|
|
125
|
-
options: Options;
|
|
126
|
-
storage: Storage;
|
|
127
|
-
editor: Editor;
|
|
128
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['addKeyboardShortcuts'];
|
|
129
|
-
}) => {
|
|
130
|
-
[key: string]: KeyboardShortcutCommand;
|
|
131
|
-
};
|
|
132
|
-
/**
|
|
133
|
-
* This function adds input rules to the editor.
|
|
134
|
-
* @see https://tiptap.dev/docs/editor/guide/custom-extensions#input-rules
|
|
135
|
-
* @example
|
|
136
|
-
* addInputRules() {
|
|
137
|
-
* return [
|
|
138
|
-
* markInputRule({
|
|
139
|
-
* find: inputRegex,
|
|
140
|
-
* type: this.type,
|
|
141
|
-
* }),
|
|
142
|
-
* ]
|
|
143
|
-
* },
|
|
144
|
-
*/
|
|
145
|
-
addInputRules?: (this: {
|
|
146
|
-
name: string;
|
|
147
|
-
options: Options;
|
|
148
|
-
storage: Storage;
|
|
149
|
-
editor: Editor;
|
|
150
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['addInputRules'];
|
|
151
|
-
}) => InputRule[];
|
|
152
|
-
/**
|
|
153
|
-
* This function adds paste rules to the editor.
|
|
154
|
-
* @see https://tiptap.dev/docs/editor/guide/custom-extensions#paste-rules
|
|
155
|
-
* @example
|
|
156
|
-
* addPasteRules() {
|
|
157
|
-
* return [
|
|
158
|
-
* markPasteRule({
|
|
159
|
-
* find: pasteRegex,
|
|
160
|
-
* type: this.type,
|
|
161
|
-
* }),
|
|
162
|
-
* ]
|
|
163
|
-
* },
|
|
164
|
-
*/
|
|
165
|
-
addPasteRules?: (this: {
|
|
166
|
-
name: string;
|
|
167
|
-
options: Options;
|
|
168
|
-
storage: Storage;
|
|
169
|
-
editor: Editor;
|
|
170
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['addPasteRules'];
|
|
171
|
-
}) => PasteRule[];
|
|
172
|
-
/**
|
|
173
|
-
* This function adds Prosemirror plugins to the editor
|
|
174
|
-
* @see https://tiptap.dev/docs/editor/guide/custom-extensions#prosemirror-plugins
|
|
175
|
-
* @example
|
|
176
|
-
* addProseMirrorPlugins() {
|
|
177
|
-
* return [
|
|
178
|
-
* customPlugin(),
|
|
179
|
-
* ]
|
|
180
|
-
* }
|
|
181
|
-
*/
|
|
182
|
-
addProseMirrorPlugins?: (this: {
|
|
183
|
-
name: string;
|
|
184
|
-
options: Options;
|
|
185
|
-
storage: Storage;
|
|
186
|
-
editor: Editor;
|
|
187
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['addProseMirrorPlugins'];
|
|
188
|
-
}) => Plugin[];
|
|
189
|
-
/**
|
|
190
|
-
* This function adds additional extensions to the editor. This is useful for
|
|
191
|
-
* building extension kits.
|
|
192
|
-
* @example
|
|
193
|
-
* addExtensions() {
|
|
194
|
-
* return [
|
|
195
|
-
* BulletList,
|
|
196
|
-
* OrderedList,
|
|
197
|
-
* ListItem
|
|
198
|
-
* ]
|
|
199
|
-
* }
|
|
200
|
-
*/
|
|
201
|
-
addExtensions?: (this: {
|
|
202
|
-
name: string;
|
|
203
|
-
options: Options;
|
|
204
|
-
storage: Storage;
|
|
205
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['addExtensions'];
|
|
206
|
-
}) => Extensions;
|
|
207
|
-
/**
|
|
208
|
-
* This function extends the schema of the node.
|
|
209
|
-
* @example
|
|
210
|
-
* extendNodeSchema() {
|
|
211
|
-
* return {
|
|
212
|
-
* group: 'inline',
|
|
213
|
-
* selectable: false,
|
|
214
|
-
* }
|
|
215
|
-
* }
|
|
216
|
-
*/
|
|
217
|
-
extendNodeSchema?: ((this: {
|
|
218
|
-
name: string;
|
|
219
|
-
options: Options;
|
|
220
|
-
storage: Storage;
|
|
221
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['extendNodeSchema'];
|
|
222
|
-
}, extension: Node) => Record<string, any>) | null;
|
|
223
|
-
/**
|
|
224
|
-
* This function extends the schema of the mark.
|
|
225
|
-
* @example
|
|
226
|
-
* extendMarkSchema() {
|
|
227
|
-
* return {
|
|
228
|
-
* group: 'inline',
|
|
229
|
-
* selectable: false,
|
|
230
|
-
* }
|
|
231
|
-
* }
|
|
232
|
-
*/
|
|
233
|
-
extendMarkSchema?: ((this: {
|
|
234
|
-
name: string;
|
|
235
|
-
options: Options;
|
|
236
|
-
storage: Storage;
|
|
237
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['extendMarkSchema'];
|
|
238
|
-
}, extension: Mark) => Record<string, any>) | null;
|
|
239
|
-
/**
|
|
240
|
-
* The editor is not ready yet.
|
|
241
|
-
*/
|
|
242
|
-
onBeforeCreate?: ((this: {
|
|
243
|
-
name: string;
|
|
244
|
-
options: Options;
|
|
245
|
-
storage: Storage;
|
|
246
|
-
editor: Editor;
|
|
247
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['onBeforeCreate'];
|
|
248
|
-
}) => void) | null;
|
|
249
|
-
/**
|
|
250
|
-
* The editor is ready.
|
|
251
|
-
*/
|
|
252
|
-
onCreate?: ((this: {
|
|
253
|
-
name: string;
|
|
254
|
-
options: Options;
|
|
255
|
-
storage: Storage;
|
|
256
|
-
editor: Editor;
|
|
257
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['onCreate'];
|
|
258
|
-
}) => void) | null;
|
|
259
|
-
/**
|
|
260
|
-
* The content has changed.
|
|
261
|
-
*/
|
|
262
|
-
onUpdate?: ((this: {
|
|
263
|
-
name: string;
|
|
264
|
-
options: Options;
|
|
265
|
-
storage: Storage;
|
|
266
|
-
editor: Editor;
|
|
267
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['onUpdate'];
|
|
268
|
-
}) => void) | null;
|
|
269
|
-
/**
|
|
270
|
-
* The selection has changed.
|
|
271
|
-
*/
|
|
272
|
-
onSelectionUpdate?: ((this: {
|
|
273
|
-
name: string;
|
|
274
|
-
options: Options;
|
|
275
|
-
storage: Storage;
|
|
276
|
-
editor: Editor;
|
|
277
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['onSelectionUpdate'];
|
|
278
|
-
}) => void) | null;
|
|
279
|
-
/**
|
|
280
|
-
* The editor state has changed.
|
|
281
|
-
*/
|
|
282
|
-
onTransaction?: ((this: {
|
|
283
|
-
name: string;
|
|
284
|
-
options: Options;
|
|
285
|
-
storage: Storage;
|
|
286
|
-
editor: Editor;
|
|
287
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['onTransaction'];
|
|
288
|
-
}, props: {
|
|
289
|
-
editor: Editor;
|
|
290
|
-
transaction: Transaction;
|
|
291
|
-
}) => void) | null;
|
|
292
|
-
/**
|
|
293
|
-
* The editor is focused.
|
|
294
|
-
*/
|
|
295
|
-
onFocus?: ((this: {
|
|
296
|
-
name: string;
|
|
297
|
-
options: Options;
|
|
298
|
-
storage: Storage;
|
|
299
|
-
editor: Editor;
|
|
300
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['onFocus'];
|
|
301
|
-
}, props: {
|
|
302
|
-
event: FocusEvent;
|
|
303
|
-
}) => void) | null;
|
|
304
|
-
/**
|
|
305
|
-
* The editor isn’t focused anymore.
|
|
306
|
-
*/
|
|
307
|
-
onBlur?: ((this: {
|
|
308
|
-
name: string;
|
|
309
|
-
options: Options;
|
|
310
|
-
storage: Storage;
|
|
311
|
-
editor: Editor;
|
|
312
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['onBlur'];
|
|
313
|
-
}, props: {
|
|
314
|
-
event: FocusEvent;
|
|
315
|
-
}) => void) | null;
|
|
316
|
-
/**
|
|
317
|
-
* The editor is destroyed.
|
|
318
|
-
*/
|
|
319
|
-
onDestroy?: ((this: {
|
|
320
|
-
name: string;
|
|
321
|
-
options: Options;
|
|
322
|
-
storage: Storage;
|
|
323
|
-
editor: Editor;
|
|
324
|
-
parent: ParentConfig<ExtensionConfig<Options, Storage>>['onDestroy'];
|
|
325
|
-
}) => void) | null;
|
|
326
|
-
}
|
|
327
|
-
}
|
|
328
|
-
/**
|
|
329
|
-
* The Extension class is the base class for all extensions.
|
|
330
|
-
* @see https://tiptap.dev/api/extensions#create-a-new-extension
|
|
331
|
-
*/
|
|
332
|
-
export declare class Extension<Options = any, Storage = any> {
|
|
333
|
-
type: string;
|
|
334
|
-
name: string;
|
|
335
|
-
parent: Extension | null;
|
|
336
|
-
child: Extension | null;
|
|
337
|
-
options: Options;
|
|
338
|
-
storage: Storage;
|
|
339
|
-
config: ExtensionConfig;
|
|
340
|
-
constructor(config?: Partial<ExtensionConfig<Options, Storage>>);
|
|
341
|
-
static create<O = any, S = any>(config?: Partial<ExtensionConfig<O, S>>): Extension<O, S>;
|
|
342
|
-
configure(options?: Partial<Options>): Extension<Options, Storage>;
|
|
343
|
-
extend<ExtendedOptions = Options, ExtendedStorage = Storage>(extendedConfig?: Partial<ExtensionConfig<ExtendedOptions, ExtendedStorage>>): Extension<ExtendedOptions, ExtendedStorage>;
|
|
344
|
-
}
|