@tiptap/extensions 3.23.5 → 3.23.6

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.
@@ -20,6 +20,7 @@ var __toCommonJS = (mod) => __copyProps(__defProp({}, "__esModule", { value: tru
20
20
  // src/placeholder/index.ts
21
21
  var index_exports = {};
22
22
  __export(index_exports, {
23
+ PLUGIN_KEY: () => PLUGIN_KEY,
23
24
  Placeholder: () => Placeholder,
24
25
  preparePlaceholderAttribute: () => preparePlaceholderAttribute
25
26
  });
@@ -28,11 +29,118 @@ module.exports = __toCommonJS(index_exports);
28
29
  // src/placeholder/placeholder.ts
29
30
  var import_core = require("@tiptap/core");
30
31
  var import_state = require("@tiptap/pm/state");
32
+ var import_view2 = require("@tiptap/pm/view");
33
+
34
+ // src/placeholder/utils/createPlaceholderDecoration.ts
31
35
  var import_view = require("@tiptap/pm/view");
36
+ function createPlaceholderDecoration(options) {
37
+ const {
38
+ editor,
39
+ placeholder,
40
+ dataAttribute,
41
+ pos,
42
+ node,
43
+ isEmptyDoc,
44
+ hasAnchor,
45
+ classes: { emptyNode, emptyEditor }
46
+ } = options;
47
+ const classes = [emptyNode];
48
+ if (isEmptyDoc) {
49
+ classes.push(emptyEditor);
50
+ }
51
+ return import_view.Decoration.node(pos, pos + node.nodeSize, {
52
+ class: classes.join(" "),
53
+ [dataAttribute]: typeof placeholder === "function" ? placeholder({
54
+ editor,
55
+ node,
56
+ pos,
57
+ hasAnchor
58
+ }) : placeholder
59
+ });
60
+ }
61
+
62
+ // src/placeholder/utils/findScrollParent.ts
63
+ function isScrollable(el) {
64
+ const style = getComputedStyle(el);
65
+ const overflow = `${style.overflow} ${style.overflowY} ${style.overflowX}`;
66
+ return /auto|scroll|overlay/.test(overflow);
67
+ }
68
+ function findScrollParent(element) {
69
+ let el = element;
70
+ while (el) {
71
+ if (isScrollable(el)) {
72
+ return el;
73
+ }
74
+ const parent = el.parentElement;
75
+ if (!parent) {
76
+ const root = el.getRootNode();
77
+ if (root instanceof ShadowRoot) {
78
+ el = root.host;
79
+ continue;
80
+ }
81
+ return window;
82
+ }
83
+ el = parent;
84
+ }
85
+ return window;
86
+ }
87
+
88
+ // src/placeholder/utils/getViewportBoundaryPositions.ts
89
+ function getContainerRect(container) {
90
+ if (container === window) {
91
+ return { top: 0, bottom: window.innerHeight };
92
+ }
93
+ return container.getBoundingClientRect();
94
+ }
95
+ function getViewportBoundaryPositions({
96
+ doc,
97
+ view,
98
+ scrollContainer
99
+ }) {
100
+ const editorRect = view.dom.getBoundingClientRect();
101
+ const containerRect = scrollContainer ? getContainerRect(scrollContainer) : { top: 0, bottom: window.innerHeight };
102
+ const visibleTop = Math.max(editorRect.top, containerRect.top);
103
+ const visibleBottom = Math.min(editorRect.bottom, containerRect.bottom);
104
+ if (visibleTop >= visibleBottom) {
105
+ return { top: 0, bottom: doc.content.size };
106
+ }
107
+ const isRTL = getComputedStyle(view.dom).direction === "rtl";
108
+ const x = isRTL ? Math.max(editorRect.right - 2, editorRect.left + 2) : editorRect.left + 2;
109
+ const topPos = view.posAtCoords({ left: x, top: visibleTop + 2 });
110
+ const bottomPos = view.posAtCoords({ left: x, top: visibleBottom - 2 });
111
+ return {
112
+ top: topPos ? topPos.pos : 0,
113
+ bottom: bottomPos ? bottomPos.pos : doc.content.size
114
+ };
115
+ }
116
+
117
+ // src/placeholder/utils/throttle.ts
118
+ function throttle(fn, delay) {
119
+ let timer = null;
120
+ const call = ((...args) => {
121
+ if (timer) {
122
+ return;
123
+ }
124
+ fn(...args);
125
+ timer = setTimeout(() => {
126
+ timer = null;
127
+ }, delay);
128
+ });
129
+ const cancel = () => {
130
+ if (timer) {
131
+ clearTimeout(timer);
132
+ timer = null;
133
+ }
134
+ };
135
+ return { call, cancel };
136
+ }
137
+
138
+ // src/placeholder/placeholder.ts
32
139
  var DEFAULT_DATA_ATTRIBUTE = "placeholder";
33
140
  function preparePlaceholderAttribute(attr) {
34
141
  return attr.replace(/\s+/g, "-").replace(/[^a-zA-Z0-9-]/g, "").replace(/^[0-9-]+/, "").replace(/^-+/, "").toLowerCase();
35
142
  }
143
+ var PLUGIN_KEY = new import_state.PluginKey("tiptap__placeholder");
36
144
  var Placeholder = import_core.Extension.create({
37
145
  name: "placeholder",
38
146
  addOptions() {
@@ -50,41 +158,125 @@ var Placeholder = import_core.Extension.create({
50
158
  const dataAttribute = this.options.dataAttribute ? `data-${preparePlaceholderAttribute(this.options.dataAttribute)}` : `data-${DEFAULT_DATA_ATTRIBUTE}`;
51
159
  return [
52
160
  new import_state.Plugin({
53
- key: new import_state.PluginKey("placeholder"),
161
+ state: {
162
+ init() {
163
+ return {
164
+ // null means "no viewport info yet" — decoration callback falls
165
+ // back to full document scan until the scroll handler fires.
166
+ topPos: null,
167
+ bottomPos: null
168
+ };
169
+ },
170
+ apply(tr, prev) {
171
+ const meta = tr.getMeta(PLUGIN_KEY);
172
+ if (meta == null ? void 0 : meta.positions) {
173
+ return {
174
+ topPos: meta.positions.top,
175
+ bottomPos: meta.positions.bottom
176
+ };
177
+ }
178
+ if (!tr.docChanged) {
179
+ return prev;
180
+ }
181
+ return {
182
+ topPos: prev.topPos !== null ? tr.mapping.map(prev.topPos) : null,
183
+ bottomPos: prev.bottomPos !== null ? tr.mapping.map(prev.bottomPos) : null
184
+ };
185
+ }
186
+ },
187
+ key: PLUGIN_KEY,
188
+ view(view) {
189
+ const scrollContainer = findScrollParent(view.dom);
190
+ const computeAndDispatch = () => {
191
+ const positions = getViewportBoundaryPositions({
192
+ view,
193
+ doc: view.state.doc,
194
+ scrollContainer
195
+ });
196
+ const prev = PLUGIN_KEY.getState(view.state);
197
+ if (prev.topPos === positions.top && prev.bottomPos === positions.bottom) {
198
+ return;
199
+ }
200
+ const tr = view.state.tr.setMeta(PLUGIN_KEY, { positions }).setMeta("tiptap__viewportUpdate", true);
201
+ view.dispatch(tr);
202
+ };
203
+ const { call: throttledUpdate, cancel: cancelThrottle } = throttle(computeAndDispatch, 250);
204
+ const scrollParent = scrollContainer;
205
+ scrollParent.addEventListener("scroll", throttledUpdate, { passive: true });
206
+ computeAndDispatch();
207
+ return {
208
+ update(_, prevState) {
209
+ if (view.state.doc.content.size !== prevState.doc.content.size) {
210
+ computeAndDispatch();
211
+ }
212
+ },
213
+ destroy: () => {
214
+ cancelThrottle();
215
+ scrollParent.removeEventListener("scroll", throttledUpdate);
216
+ }
217
+ };
218
+ },
54
219
  props: {
55
220
  decorations: ({ doc, selection }) => {
221
+ var _a, _b;
56
222
  const active = this.editor.isEditable || !this.options.showOnlyWhenEditable;
57
- const { anchor } = selection;
58
- const decorations = [];
59
223
  if (!active) {
60
224
  return null;
61
225
  }
226
+ const { anchor } = selection;
227
+ const decorations = [];
62
228
  const isEmptyDoc = this.editor.isEmpty;
63
- doc.descendants((node, pos) => {
64
- const hasAnchor = anchor >= pos && anchor <= pos + node.nodeSize;
65
- const isEmpty = !node.isLeaf && (0, import_core.isNodeEmpty)(node);
66
- if (!node.type.isTextblock) {
67
- return this.options.includeChildren;
229
+ const useResolvedPath = this.options.showOnlyCurrent && !this.options.includeChildren;
230
+ if (useResolvedPath) {
231
+ const resolved = doc.resolve(anchor);
232
+ if (resolved.depth > 0) {
233
+ const node = resolved.node(1);
234
+ const nodeStart = resolved.before(1);
235
+ if (node.type.isTextblock && (0, import_core.isNodeEmpty)(node)) {
236
+ const hasAnchor = anchor >= nodeStart && anchor <= nodeStart + node.nodeSize;
237
+ const decoration = createPlaceholderDecoration({
238
+ node,
239
+ dataAttribute,
240
+ hasAnchor,
241
+ placeholder: this.options.placeholder,
242
+ classes: {
243
+ emptyEditor: this.options.emptyEditorClass,
244
+ emptyNode: this.options.emptyNodeClass
245
+ },
246
+ editor: this.editor,
247
+ isEmptyDoc,
248
+ pos: resolved.before(1)
249
+ });
250
+ decorations.push(decoration);
251
+ }
68
252
  }
69
- if ((hasAnchor || !this.options.showOnlyCurrent) && isEmpty) {
70
- const classes = [this.options.emptyNodeClass];
71
- if (isEmptyDoc) {
72
- classes.push(this.options.emptyEditorClass);
253
+ } else {
254
+ const pluginState = PLUGIN_KEY.getState(this.editor.state);
255
+ const from = (_a = pluginState.topPos) != null ? _a : 0;
256
+ const to = (_b = pluginState.bottomPos) != null ? _b : doc.content.size;
257
+ doc.nodesBetween(from, to, (node, pos) => {
258
+ const hasAnchor = anchor >= pos && anchor <= pos + node.nodeSize;
259
+ const isEmpty = !node.isLeaf && (0, import_core.isNodeEmpty)(node);
260
+ if (!node.type.isTextblock) {
261
+ return this.options.includeChildren;
73
262
  }
74
- const decoration = import_view.Decoration.node(pos, pos + node.nodeSize, {
75
- class: classes.join(" "),
76
- [dataAttribute]: typeof this.options.placeholder === "function" ? this.options.placeholder({
263
+ if ((hasAnchor || !this.options.showOnlyCurrent) && isEmpty) {
264
+ const decoration = createPlaceholderDecoration({
265
+ classes: { emptyEditor: this.options.emptyEditorClass, emptyNode: this.options.emptyNodeClass },
77
266
  editor: this.editor,
267
+ isEmptyDoc,
268
+ dataAttribute,
269
+ hasAnchor,
270
+ placeholder: this.options.placeholder,
78
271
  node,
79
- pos,
80
- hasAnchor
81
- }) : this.options.placeholder
82
- });
83
- decorations.push(decoration);
84
- }
85
- return this.options.includeChildren;
86
- });
87
- return import_view.DecorationSet.create(doc, decorations);
272
+ pos
273
+ });
274
+ decorations.push(decoration);
275
+ }
276
+ return this.options.includeChildren;
277
+ });
278
+ }
279
+ return import_view2.DecorationSet.create(doc, decorations);
88
280
  }
89
281
  }
90
282
  })
@@ -93,6 +285,7 @@ var Placeholder = import_core.Extension.create({
93
285
  });
94
286
  // Annotate the CommonJS export names for ESM import in node:
95
287
  0 && (module.exports = {
288
+ PLUGIN_KEY,
96
289
  Placeholder,
97
290
  preparePlaceholderAttribute
98
291
  });
@@ -1 +1 @@
1
- {"version":3,"sources":["../../src/placeholder/index.ts","../../src/placeholder/placeholder.ts"],"sourcesContent":["export * from './placeholder.js'\n","import type { Editor } from '@tiptap/core'\nimport { Extension, isNodeEmpty } from '@tiptap/core'\nimport type { Node as ProsemirrorNode } from '@tiptap/pm/model'\nimport { Plugin, PluginKey } from '@tiptap/pm/state'\nimport { Decoration, DecorationSet } from '@tiptap/pm/view'\n\n/**\n * The default data attribute label\n */\nconst DEFAULT_DATA_ATTRIBUTE = 'placeholder'\n\n/**\n * Prepares the placeholder attribute by ensuring it is properly formatted.\n * @param attr - The placeholder attribute string.\n * @returns The prepared placeholder attribute string.\n */\nexport function preparePlaceholderAttribute(attr: string): string {\n return (\n attr\n // replace whitespace with dashes\n .replace(/\\s+/g, '-')\n // replace non-alphanumeric characters\n // or special chars like $, %, &, etc.\n // but not dashes\n .replace(/[^a-zA-Z0-9-]/g, '')\n // and replace any numeric character at the start\n .replace(/^[0-9-]+/, '')\n // and finally replace any stray, leading dashes\n .replace(/^-+/, '')\n .toLowerCase()\n )\n}\n\nexport interface PlaceholderOptions {\n /**\n * **The class name for the empty editor**\n * @default 'is-editor-empty'\n */\n emptyEditorClass: string\n\n /**\n * **The class name for empty nodes**\n * @default 'is-empty'\n */\n emptyNodeClass: string\n\n /**\n * **The data-attribute used for the placeholder label**\n * Will be prepended with `data-` and converted to kebab-case and cleaned of special characters.\n * @default 'placeholder'\n */\n dataAttribute: string\n\n /**\n * **The placeholder content**\n *\n * You can use a function to return a dynamic placeholder or a string.\n * @default 'Write something …'\n */\n placeholder:\n | ((PlaceholderProps: { editor: Editor; node: ProsemirrorNode; pos: number; hasAnchor: boolean }) => string)\n | string\n\n /**\n * **Checks if the placeholder should be only shown when the editor is editable.**\n *\n * If true, the placeholder will only be shown when the editor is editable.\n * If false, the placeholder will always be shown.\n * @default true\n */\n showOnlyWhenEditable: boolean\n\n /**\n * **Checks if the placeholder should be only shown when the current node is empty.**\n *\n * If true, the placeholder will only be shown when the current node is empty.\n * If false, the placeholder will be shown when any node is empty.\n * @default true\n */\n showOnlyCurrent: boolean\n\n /**\n * **Controls if the placeholder should be shown for all descendents.**\n *\n * If true, the placeholder will be shown for all descendents.\n * If false, the placeholder will only be shown for the current node.\n * @default false\n */\n includeChildren: boolean\n}\n\n/**\n * This extension allows you to add a placeholder to your editor.\n * A placeholder is a text that appears when the editor or a node is empty.\n * @see https://www.tiptap.dev/api/extensions/placeholder\n */\nexport const Placeholder = Extension.create<PlaceholderOptions>({\n name: 'placeholder',\n\n addOptions() {\n return {\n emptyEditorClass: 'is-editor-empty',\n emptyNodeClass: 'is-empty',\n dataAttribute: DEFAULT_DATA_ATTRIBUTE,\n placeholder: 'Write something …',\n showOnlyWhenEditable: true,\n showOnlyCurrent: true,\n includeChildren: false,\n }\n },\n\n addProseMirrorPlugins() {\n const dataAttribute = this.options.dataAttribute\n ? `data-${preparePlaceholderAttribute(this.options.dataAttribute)}`\n : `data-${DEFAULT_DATA_ATTRIBUTE}`\n\n return [\n new Plugin({\n key: new PluginKey('placeholder'),\n props: {\n decorations: ({ doc, selection }) => {\n const active = this.editor.isEditable || !this.options.showOnlyWhenEditable\n const { anchor } = selection\n const decorations: Decoration[] = []\n\n if (!active) {\n return null\n }\n\n const isEmptyDoc = this.editor.isEmpty\n\n doc.descendants((node, pos) => {\n const hasAnchor = anchor >= pos && anchor <= pos + node.nodeSize\n const isEmpty = !node.isLeaf && isNodeEmpty(node)\n\n if (!node.type.isTextblock) {\n return this.options.includeChildren\n }\n\n if ((hasAnchor || !this.options.showOnlyCurrent) && isEmpty) {\n const classes = [this.options.emptyNodeClass]\n\n if (isEmptyDoc) {\n classes.push(this.options.emptyEditorClass)\n }\n\n const decoration = Decoration.node(pos, pos + node.nodeSize, {\n class: classes.join(' '),\n [dataAttribute]:\n typeof this.options.placeholder === 'function'\n ? this.options.placeholder({\n editor: this.editor,\n node,\n pos,\n hasAnchor,\n })\n : this.options.placeholder,\n })\n\n decorations.push(decoration)\n }\n\n return this.options.includeChildren\n })\n\n return DecorationSet.create(doc, decorations)\n },\n },\n }),\n ]\n },\n})\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACCA,kBAAuC;AAEvC,mBAAkC;AAClC,kBAA0C;AAK1C,IAAM,yBAAyB;AAOxB,SAAS,4BAA4B,MAAsB;AAChE,SACE,KAEG,QAAQ,QAAQ,GAAG,EAInB,QAAQ,kBAAkB,EAAE,EAE5B,QAAQ,YAAY,EAAE,EAEtB,QAAQ,OAAO,EAAE,EACjB,YAAY;AAEnB;AAiEO,IAAM,cAAc,sBAAU,OAA2B;AAAA,EAC9D,MAAM;AAAA,EAEN,aAAa;AACX,WAAO;AAAA,MACL,kBAAkB;AAAA,MAClB,gBAAgB;AAAA,MAChB,eAAe;AAAA,MACf,aAAa;AAAA,MACb,sBAAsB;AAAA,MACtB,iBAAiB;AAAA,MACjB,iBAAiB;AAAA,IACnB;AAAA,EACF;AAAA,EAEA,wBAAwB;AACtB,UAAM,gBAAgB,KAAK,QAAQ,gBAC/B,QAAQ,4BAA4B,KAAK,QAAQ,aAAa,CAAC,KAC/D,QAAQ,sBAAsB;AAElC,WAAO;AAAA,MACL,IAAI,oBAAO;AAAA,QACT,KAAK,IAAI,uBAAU,aAAa;AAAA,QAChC,OAAO;AAAA,UACL,aAAa,CAAC,EAAE,KAAK,UAAU,MAAM;AACnC,kBAAM,SAAS,KAAK,OAAO,cAAc,CAAC,KAAK,QAAQ;AACvD,kBAAM,EAAE,OAAO,IAAI;AACnB,kBAAM,cAA4B,CAAC;AAEnC,gBAAI,CAAC,QAAQ;AACX,qBAAO;AAAA,YACT;AAEA,kBAAM,aAAa,KAAK,OAAO;AAE/B,gBAAI,YAAY,CAAC,MAAM,QAAQ;AAC7B,oBAAM,YAAY,UAAU,OAAO,UAAU,MAAM,KAAK;AACxD,oBAAM,UAAU,CAAC,KAAK,cAAU,yBAAY,IAAI;AAEhD,kBAAI,CAAC,KAAK,KAAK,aAAa;AAC1B,uBAAO,KAAK,QAAQ;AAAA,cACtB;AAEA,mBAAK,aAAa,CAAC,KAAK,QAAQ,oBAAoB,SAAS;AAC3D,sBAAM,UAAU,CAAC,KAAK,QAAQ,cAAc;AAE5C,oBAAI,YAAY;AACd,0BAAQ,KAAK,KAAK,QAAQ,gBAAgB;AAAA,gBAC5C;AAEA,sBAAM,aAAa,uBAAW,KAAK,KAAK,MAAM,KAAK,UAAU;AAAA,kBAC3D,OAAO,QAAQ,KAAK,GAAG;AAAA,kBACvB,CAAC,aAAa,GACZ,OAAO,KAAK,QAAQ,gBAAgB,aAChC,KAAK,QAAQ,YAAY;AAAA,oBACvB,QAAQ,KAAK;AAAA,oBACb;AAAA,oBACA;AAAA,oBACA;AAAA,kBACF,CAAC,IACD,KAAK,QAAQ;AAAA,gBACrB,CAAC;AAED,4BAAY,KAAK,UAAU;AAAA,cAC7B;AAEA,qBAAO,KAAK,QAAQ;AAAA,YACtB,CAAC;AAED,mBAAO,0BAAc,OAAO,KAAK,WAAW;AAAA,UAC9C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF,CAAC;","names":[]}
1
+ {"version":3,"sources":["../../src/placeholder/index.ts","../../src/placeholder/placeholder.ts","../../src/placeholder/utils/createPlaceholderDecoration.ts","../../src/placeholder/utils/findScrollParent.ts","../../src/placeholder/utils/getViewportBoundaryPositions.ts","../../src/placeholder/utils/throttle.ts"],"sourcesContent":["export * from './placeholder.js'\nexport * from './types.js'\n","import { Extension, isNodeEmpty } from '@tiptap/core'\nimport { Plugin, PluginKey } from '@tiptap/pm/state'\nimport type { Decoration } from '@tiptap/pm/view'\nimport { DecorationSet } from '@tiptap/pm/view'\n\nimport type { PlaceholderOptions } from './types.js'\nimport { createPlaceholderDecoration } from './utils/createPlaceholderDecoration.js'\nimport { findScrollParent } from './utils/findScrollParent.js'\nimport { getViewportBoundaryPositions } from './utils/getViewportBoundaryPositions.js'\nimport { throttle } from './utils/throttle.js'\n\n/**\n * The default data attribute label\n */\nconst DEFAULT_DATA_ATTRIBUTE = 'placeholder'\n\n/**\n * Prepares the placeholder attribute by ensuring it is properly formatted.\n * @param attr - The placeholder attribute string.\n * @returns The prepared placeholder attribute string.\n */\nexport function preparePlaceholderAttribute(attr: string): string {\n return (\n attr\n // replace whitespace with dashes\n .replace(/\\s+/g, '-')\n // replace non-alphanumeric characters\n // or special chars like $, %, &, etc.\n // but not dashes\n .replace(/[^a-zA-Z0-9-]/g, '')\n // and replace any numeric character at the start\n .replace(/^[0-9-]+/, '')\n // and finally replace any stray, leading dashes\n .replace(/^-+/, '')\n .toLowerCase()\n )\n}\n\nexport const PLUGIN_KEY = new PluginKey('tiptap__placeholder')\n\n/**\n * This extension allows you to add a placeholder to your editor.\n * A placeholder is a text that appears when the editor or a node is empty.\n * @see https://www.tiptap.dev/api/extensions/placeholder\n */\nexport const Placeholder = Extension.create<PlaceholderOptions>({\n name: 'placeholder',\n\n addOptions() {\n return {\n emptyEditorClass: 'is-editor-empty',\n emptyNodeClass: 'is-empty',\n dataAttribute: DEFAULT_DATA_ATTRIBUTE,\n placeholder: 'Write something …',\n showOnlyWhenEditable: true,\n showOnlyCurrent: true,\n includeChildren: false,\n }\n },\n\n addProseMirrorPlugins() {\n const dataAttribute = this.options.dataAttribute\n ? `data-${preparePlaceholderAttribute(this.options.dataAttribute)}`\n : `data-${DEFAULT_DATA_ATTRIBUTE}`\n\n return [\n new Plugin({\n state: {\n init() {\n return {\n // null means \"no viewport info yet\" — decoration callback falls\n // back to full document scan until the scroll handler fires.\n topPos: null as number | null,\n bottomPos: null as number | null,\n }\n },\n apply(tr, prev) {\n const meta = tr.getMeta(PLUGIN_KEY) as { positions?: { top: number; bottom: number } } | undefined\n\n if (meta?.positions) {\n return {\n topPos: meta.positions.top,\n bottomPos: meta.positions.bottom,\n }\n }\n\n if (!tr.docChanged) {\n return prev\n }\n\n // Preserve last known viewport positions across transactions.\n // Without this, every keystroke resets back to a full document\n // scan, defeating the viewport optimisation.\n // Only map when we have actual positions — null means \"no viewport\n // info yet\" and should stay null to fall back to full doc scan.\n return {\n topPos: prev.topPos !== null ? tr.mapping.map(prev.topPos) : null,\n bottomPos: prev.bottomPos !== null ? tr.mapping.map(prev.bottomPos) : null,\n }\n },\n },\n key: PLUGIN_KEY,\n view(view) {\n const scrollContainer = findScrollParent(view.dom)\n\n const computeAndDispatch = () => {\n const positions = getViewportBoundaryPositions({\n view,\n doc: view.state.doc,\n scrollContainer,\n })\n\n const prev = PLUGIN_KEY.getState(view.state)\n if (prev.topPos === positions.top && prev.bottomPos === positions.bottom) {\n return\n }\n\n const tr = view.state.tr\n .setMeta(PLUGIN_KEY, { positions })\n // Flag this transaction so the update() method can detect\n // it and avoid re-entrant computation.\n .setMeta('tiptap__viewportUpdate', true)\n view.dispatch(tr)\n }\n\n const { call: throttledUpdate, cancel: cancelThrottle } = throttle(computeAndDispatch, 250)\n const scrollParent = scrollContainer\n\n scrollParent.addEventListener('scroll', throttledUpdate, { passive: true })\n\n // Fire once to populate initial viewport (bypass throttle)\n computeAndDispatch()\n\n return {\n update(_, prevState) {\n // Skip re-entry: the dispatch inside computeAndDispatch would\n // trigger this update again, but the doc didn't change so the\n // size guard catches that. The meta flag is an extra safeguard.\n if (view.state.doc.content.size !== prevState.doc.content.size) {\n computeAndDispatch()\n }\n },\n destroy: () => {\n cancelThrottle()\n scrollParent.removeEventListener('scroll', throttledUpdate)\n },\n }\n },\n props: {\n decorations: ({ doc, selection }) => {\n const active = this.editor.isEditable || !this.options.showOnlyWhenEditable\n\n if (!active) {\n return null\n }\n\n const { anchor } = selection\n const decorations: Decoration[] = []\n const isEmptyDoc = this.editor.isEmpty\n\n const useResolvedPath = this.options.showOnlyCurrent && !this.options.includeChildren\n\n if (useResolvedPath) {\n const resolved = doc.resolve(anchor)\n\n if (resolved.depth > 0) {\n const node = resolved.node(1)\n const nodeStart = resolved.before(1)\n\n if (node.type.isTextblock && isNodeEmpty(node)) {\n const hasAnchor = anchor >= nodeStart && anchor <= nodeStart + node.nodeSize\n const decoration = createPlaceholderDecoration({\n node,\n dataAttribute,\n hasAnchor,\n placeholder: this.options.placeholder,\n classes: {\n emptyEditor: this.options.emptyEditorClass,\n emptyNode: this.options.emptyNodeClass,\n },\n editor: this.editor,\n isEmptyDoc,\n pos: resolved.before(1),\n })\n\n decorations.push(decoration)\n }\n }\n } else {\n const pluginState = PLUGIN_KEY.getState(this.editor.state)\n const from = pluginState.topPos ?? 0\n const to = pluginState.bottomPos ?? doc.content.size\n\n doc.nodesBetween(from, to, (node, pos) => {\n const hasAnchor = anchor >= pos && anchor <= pos + node.nodeSize\n const isEmpty = !node.isLeaf && isNodeEmpty(node)\n\n if (!node.type.isTextblock) {\n return this.options.includeChildren\n }\n\n if ((hasAnchor || !this.options.showOnlyCurrent) && isEmpty) {\n const decoration = createPlaceholderDecoration({\n classes: { emptyEditor: this.options.emptyEditorClass, emptyNode: this.options.emptyNodeClass },\n editor: this.editor,\n isEmptyDoc,\n dataAttribute,\n hasAnchor,\n placeholder: this.options.placeholder,\n node,\n pos,\n })\n decorations.push(decoration)\n }\n\n return this.options.includeChildren\n })\n }\n\n return DecorationSet.create(doc, decorations)\n },\n },\n }),\n ]\n },\n})\n","import type { Editor } from '@tiptap/core'\nimport type { Node } from '@tiptap/pm/model'\nimport { Decoration } from '@tiptap/pm/view'\n\nimport type { PlaceholderOptions } from '../types.js'\n\n/**\n * Creates a ProseMirror node decoration that applies a placeholder\n * CSS class and data attribute to an empty node.\n * @param options.editor - The editor instance\n * @param options.pos - The position of the node in the document\n * @param options.node - The ProseMirror node\n * @param options.isEmptyDoc - Whether the entire document is empty\n * @param options.hasAnchor - Whether the selection anchor is within the node\n * @param options.dataAttribute - The data attribute name (e.g. `data-placeholder`)\n * @param options.classes - CSS classes for empty nodes and the empty editor\n * @param options.placeholder - The placeholder text or a function that returns it\n * @returns A ProseMirror node decoration with placeholder classes and data attribute\n */\nexport function createPlaceholderDecoration(options: {\n editor: Editor\n pos: number\n node: Node\n isEmptyDoc: boolean\n hasAnchor: boolean\n dataAttribute: string\n classes: {\n emptyEditor: PlaceholderOptions['emptyEditorClass']\n emptyNode: PlaceholderOptions['emptyNodeClass']\n }\n placeholder: PlaceholderOptions['placeholder']\n}) {\n const {\n editor,\n placeholder,\n dataAttribute,\n pos,\n node,\n isEmptyDoc,\n hasAnchor,\n classes: { emptyNode, emptyEditor },\n } = options\n const classes = [emptyNode]\n\n if (isEmptyDoc) {\n classes.push(emptyEditor)\n }\n\n return Decoration.node(pos, pos + node.nodeSize, {\n class: classes.join(' '),\n [dataAttribute]:\n typeof placeholder === 'function'\n ? placeholder({\n editor,\n node,\n pos,\n hasAnchor,\n })\n : placeholder,\n })\n}\n","/**\n * Checks if an element is scrollable by testing its overflow properties.\n * Elements with `overflow: hidden` or `overflow: clip` are intentionally\n * excluded — they clip content but don't emit scroll events.\n */\nfunction isScrollable(el: HTMLElement): boolean {\n const style = getComputedStyle(el)\n const overflow = `${style.overflow} ${style.overflowY} ${style.overflowX}`\n\n return /auto|scroll|overlay/.test(overflow)\n}\n\nexport function findScrollParent(element: HTMLElement): HTMLElement | Window {\n let el: HTMLElement | null = element\n\n while (el) {\n if (isScrollable(el)) {\n return el\n }\n\n // Check if we hit a Shadow DOM boundary. If so, jump to the shadow host\n // and continue traversing the light DOM.\n const parent = el.parentElement\n if (!parent) {\n const root = el.getRootNode()\n if (root instanceof ShadowRoot) {\n el = root.host as HTMLElement\n continue\n }\n\n return window\n }\n\n el = parent\n }\n\n return window\n}\n","import type { Node } from '@tiptap/pm/model'\nimport type { EditorView } from '@tiptap/pm/view'\n\nfunction getContainerRect(container: HTMLElement | Window): { top: number; bottom: number } {\n if (container === window) {\n return { top: 0, bottom: window.innerHeight }\n }\n\n return (container as HTMLElement).getBoundingClientRect()\n}\n\nexport function getViewportBoundaryPositions({\n doc,\n view,\n scrollContainer,\n}: {\n doc: Node\n view: EditorView\n scrollContainer?: HTMLElement | Window\n}) {\n const editorRect = view.dom.getBoundingClientRect()\n const containerRect = scrollContainer ? getContainerRect(scrollContainer) : { top: 0, bottom: window.innerHeight }\n\n const visibleTop = Math.max(editorRect.top, containerRect.top)\n const visibleBottom = Math.min(editorRect.bottom, containerRect.bottom)\n\n if (visibleTop >= visibleBottom) {\n // Editor is not visible — fall back to full document range\n return { top: 0, bottom: doc.content.size }\n }\n\n // Pick the x-coordinate based on text direction. In LTR the content\n // starts at the left edge; in RTL it starts at the right edge.\n // Clamp to ensure the coordinate stays inside the editor bounds.\n const isRTL = getComputedStyle(view.dom).direction === 'rtl'\n const x = isRTL ? Math.max(editorRect.right - 2, editorRect.left + 2) : editorRect.left + 2\n\n const topPos = view.posAtCoords({ left: x, top: visibleTop + 2 })\n const bottomPos = view.posAtCoords({ left: x, top: visibleBottom - 2 })\n\n return {\n top: topPos ? topPos.pos : 0,\n bottom: bottomPos ? bottomPos.pos : doc.content.size,\n }\n}\n","export function throttle<T extends (...args: any[]) => void>(fn: T, delay: number): { call: T; cancel: () => void } {\n let timer: ReturnType<typeof setTimeout> | null = null\n\n const call = ((...args: any[]) => {\n if (timer) {\n return\n }\n\n // Leading-edge: fire immediately, then prevent subsequent calls\n // until the timer fires and resets.\n fn(...args)\n timer = setTimeout(() => {\n timer = null\n }, delay)\n }) as T\n\n const cancel = () => {\n if (timer) {\n clearTimeout(timer)\n timer = null\n }\n }\n\n return { call, cancel }\n}\n"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,kBAAuC;AACvC,mBAAkC;AAElC,IAAAA,eAA8B;;;ACD9B,kBAA2B;AAiBpB,SAAS,4BAA4B,SAYzC;AACD,QAAM;AAAA,IACJ;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA;AAAA,IACA,SAAS,EAAE,WAAW,YAAY;AAAA,EACpC,IAAI;AACJ,QAAM,UAAU,CAAC,SAAS;AAE1B,MAAI,YAAY;AACd,YAAQ,KAAK,WAAW;AAAA,EAC1B;AAEA,SAAO,uBAAW,KAAK,KAAK,MAAM,KAAK,UAAU;AAAA,IAC/C,OAAO,QAAQ,KAAK,GAAG;AAAA,IACvB,CAAC,aAAa,GACZ,OAAO,gBAAgB,aACnB,YAAY;AAAA,MACV;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC,IACD;AAAA,EACR,CAAC;AACH;;;ACvDA,SAAS,aAAa,IAA0B;AAC9C,QAAM,QAAQ,iBAAiB,EAAE;AACjC,QAAM,WAAW,GAAG,MAAM,QAAQ,IAAI,MAAM,SAAS,IAAI,MAAM,SAAS;AAExE,SAAO,sBAAsB,KAAK,QAAQ;AAC5C;AAEO,SAAS,iBAAiB,SAA4C;AAC3E,MAAI,KAAyB;AAE7B,SAAO,IAAI;AACT,QAAI,aAAa,EAAE,GAAG;AACpB,aAAO;AAAA,IACT;AAIA,UAAM,SAAS,GAAG;AAClB,QAAI,CAAC,QAAQ;AACX,YAAM,OAAO,GAAG,YAAY;AAC5B,UAAI,gBAAgB,YAAY;AAC9B,aAAK,KAAK;AACV;AAAA,MACF;AAEA,aAAO;AAAA,IACT;AAEA,SAAK;AAAA,EACP;AAEA,SAAO;AACT;;;AClCA,SAAS,iBAAiB,WAAkE;AAC1F,MAAI,cAAc,QAAQ;AACxB,WAAO,EAAE,KAAK,GAAG,QAAQ,OAAO,YAAY;AAAA,EAC9C;AAEA,SAAQ,UAA0B,sBAAsB;AAC1D;AAEO,SAAS,6BAA6B;AAAA,EAC3C;AAAA,EACA;AAAA,EACA;AACF,GAIG;AACD,QAAM,aAAa,KAAK,IAAI,sBAAsB;AAClD,QAAM,gBAAgB,kBAAkB,iBAAiB,eAAe,IAAI,EAAE,KAAK,GAAG,QAAQ,OAAO,YAAY;AAEjH,QAAM,aAAa,KAAK,IAAI,WAAW,KAAK,cAAc,GAAG;AAC7D,QAAM,gBAAgB,KAAK,IAAI,WAAW,QAAQ,cAAc,MAAM;AAEtE,MAAI,cAAc,eAAe;AAE/B,WAAO,EAAE,KAAK,GAAG,QAAQ,IAAI,QAAQ,KAAK;AAAA,EAC5C;AAKA,QAAM,QAAQ,iBAAiB,KAAK,GAAG,EAAE,cAAc;AACvD,QAAM,IAAI,QAAQ,KAAK,IAAI,WAAW,QAAQ,GAAG,WAAW,OAAO,CAAC,IAAI,WAAW,OAAO;AAE1F,QAAM,SAAS,KAAK,YAAY,EAAE,MAAM,GAAG,KAAK,aAAa,EAAE,CAAC;AAChE,QAAM,YAAY,KAAK,YAAY,EAAE,MAAM,GAAG,KAAK,gBAAgB,EAAE,CAAC;AAEtE,SAAO;AAAA,IACL,KAAK,SAAS,OAAO,MAAM;AAAA,IAC3B,QAAQ,YAAY,UAAU,MAAM,IAAI,QAAQ;AAAA,EAClD;AACF;;;AC5CO,SAAS,SAA6C,IAAO,OAAgD;AAClH,MAAI,QAA8C;AAElD,QAAM,QAAQ,IAAI,SAAgB;AAChC,QAAI,OAAO;AACT;AAAA,IACF;AAIA,OAAG,GAAG,IAAI;AACV,YAAQ,WAAW,MAAM;AACvB,cAAQ;AAAA,IACV,GAAG,KAAK;AAAA,EACV;AAEA,QAAM,SAAS,MAAM;AACnB,QAAI,OAAO;AACT,mBAAa,KAAK;AAClB,cAAQ;AAAA,IACV;AAAA,EACF;AAEA,SAAO,EAAE,MAAM,OAAO;AACxB;;;AJVA,IAAM,yBAAyB;AAOxB,SAAS,4BAA4B,MAAsB;AAChE,SACE,KAEG,QAAQ,QAAQ,GAAG,EAInB,QAAQ,kBAAkB,EAAE,EAE5B,QAAQ,YAAY,EAAE,EAEtB,QAAQ,OAAO,EAAE,EACjB,YAAY;AAEnB;AAEO,IAAM,aAAa,IAAI,uBAAU,qBAAqB;AAOtD,IAAM,cAAc,sBAAU,OAA2B;AAAA,EAC9D,MAAM;AAAA,EAEN,aAAa;AACX,WAAO;AAAA,MACL,kBAAkB;AAAA,MAClB,gBAAgB;AAAA,MAChB,eAAe;AAAA,MACf,aAAa;AAAA,MACb,sBAAsB;AAAA,MACtB,iBAAiB;AAAA,MACjB,iBAAiB;AAAA,IACnB;AAAA,EACF;AAAA,EAEA,wBAAwB;AACtB,UAAM,gBAAgB,KAAK,QAAQ,gBAC/B,QAAQ,4BAA4B,KAAK,QAAQ,aAAa,CAAC,KAC/D,QAAQ,sBAAsB;AAElC,WAAO;AAAA,MACL,IAAI,oBAAO;AAAA,QACT,OAAO;AAAA,UACL,OAAO;AACL,mBAAO;AAAA;AAAA;AAAA,cAGL,QAAQ;AAAA,cACR,WAAW;AAAA,YACb;AAAA,UACF;AAAA,UACA,MAAM,IAAI,MAAM;AACd,kBAAM,OAAO,GAAG,QAAQ,UAAU;AAElC,gBAAI,6BAAM,WAAW;AACnB,qBAAO;AAAA,gBACL,QAAQ,KAAK,UAAU;AAAA,gBACvB,WAAW,KAAK,UAAU;AAAA,cAC5B;AAAA,YACF;AAEA,gBAAI,CAAC,GAAG,YAAY;AAClB,qBAAO;AAAA,YACT;AAOA,mBAAO;AAAA,cACL,QAAQ,KAAK,WAAW,OAAO,GAAG,QAAQ,IAAI,KAAK,MAAM,IAAI;AAAA,cAC7D,WAAW,KAAK,cAAc,OAAO,GAAG,QAAQ,IAAI,KAAK,SAAS,IAAI;AAAA,YACxE;AAAA,UACF;AAAA,QACF;AAAA,QACA,KAAK;AAAA,QACL,KAAK,MAAM;AACT,gBAAM,kBAAkB,iBAAiB,KAAK,GAAG;AAEjD,gBAAM,qBAAqB,MAAM;AAC/B,kBAAM,YAAY,6BAA6B;AAAA,cAC7C;AAAA,cACA,KAAK,KAAK,MAAM;AAAA,cAChB;AAAA,YACF,CAAC;AAED,kBAAM,OAAO,WAAW,SAAS,KAAK,KAAK;AAC3C,gBAAI,KAAK,WAAW,UAAU,OAAO,KAAK,cAAc,UAAU,QAAQ;AACxE;AAAA,YACF;AAEA,kBAAM,KAAK,KAAK,MAAM,GACnB,QAAQ,YAAY,EAAE,UAAU,CAAC,EAGjC,QAAQ,0BAA0B,IAAI;AACzC,iBAAK,SAAS,EAAE;AAAA,UAClB;AAEA,gBAAM,EAAE,MAAM,iBAAiB,QAAQ,eAAe,IAAI,SAAS,oBAAoB,GAAG;AAC1F,gBAAM,eAAe;AAErB,uBAAa,iBAAiB,UAAU,iBAAiB,EAAE,SAAS,KAAK,CAAC;AAG1E,6BAAmB;AAEnB,iBAAO;AAAA,YACL,OAAO,GAAG,WAAW;AAInB,kBAAI,KAAK,MAAM,IAAI,QAAQ,SAAS,UAAU,IAAI,QAAQ,MAAM;AAC9D,mCAAmB;AAAA,cACrB;AAAA,YACF;AAAA,YACA,SAAS,MAAM;AACb,6BAAe;AACf,2BAAa,oBAAoB,UAAU,eAAe;AAAA,YAC5D;AAAA,UACF;AAAA,QACF;AAAA,QACA,OAAO;AAAA,UACL,aAAa,CAAC,EAAE,KAAK,UAAU,MAAM;AArJ/C;AAsJY,kBAAM,SAAS,KAAK,OAAO,cAAc,CAAC,KAAK,QAAQ;AAEvD,gBAAI,CAAC,QAAQ;AACX,qBAAO;AAAA,YACT;AAEA,kBAAM,EAAE,OAAO,IAAI;AACnB,kBAAM,cAA4B,CAAC;AACnC,kBAAM,aAAa,KAAK,OAAO;AAE/B,kBAAM,kBAAkB,KAAK,QAAQ,mBAAmB,CAAC,KAAK,QAAQ;AAEtE,gBAAI,iBAAiB;AACnB,oBAAM,WAAW,IAAI,QAAQ,MAAM;AAEnC,kBAAI,SAAS,QAAQ,GAAG;AACtB,sBAAM,OAAO,SAAS,KAAK,CAAC;AAC5B,sBAAM,YAAY,SAAS,OAAO,CAAC;AAEnC,oBAAI,KAAK,KAAK,mBAAe,yBAAY,IAAI,GAAG;AAC9C,wBAAM,YAAY,UAAU,aAAa,UAAU,YAAY,KAAK;AACpE,wBAAM,aAAa,4BAA4B;AAAA,oBAC7C;AAAA,oBACA;AAAA,oBACA;AAAA,oBACA,aAAa,KAAK,QAAQ;AAAA,oBAC1B,SAAS;AAAA,sBACP,aAAa,KAAK,QAAQ;AAAA,sBAC1B,WAAW,KAAK,QAAQ;AAAA,oBAC1B;AAAA,oBACA,QAAQ,KAAK;AAAA,oBACb;AAAA,oBACA,KAAK,SAAS,OAAO,CAAC;AAAA,kBACxB,CAAC;AAED,8BAAY,KAAK,UAAU;AAAA,gBAC7B;AAAA,cACF;AAAA,YACF,OAAO;AACL,oBAAM,cAAc,WAAW,SAAS,KAAK,OAAO,KAAK;AACzD,oBAAM,QAAO,iBAAY,WAAZ,YAAsB;AACnC,oBAAM,MAAK,iBAAY,cAAZ,YAAyB,IAAI,QAAQ;AAEhD,kBAAI,aAAa,MAAM,IAAI,CAAC,MAAM,QAAQ;AACxC,sBAAM,YAAY,UAAU,OAAO,UAAU,MAAM,KAAK;AACxD,sBAAM,UAAU,CAAC,KAAK,cAAU,yBAAY,IAAI;AAEhD,oBAAI,CAAC,KAAK,KAAK,aAAa;AAC1B,yBAAO,KAAK,QAAQ;AAAA,gBACtB;AAEA,qBAAK,aAAa,CAAC,KAAK,QAAQ,oBAAoB,SAAS;AAC3D,wBAAM,aAAa,4BAA4B;AAAA,oBAC7C,SAAS,EAAE,aAAa,KAAK,QAAQ,kBAAkB,WAAW,KAAK,QAAQ,eAAe;AAAA,oBAC9F,QAAQ,KAAK;AAAA,oBACb;AAAA,oBACA;AAAA,oBACA;AAAA,oBACA,aAAa,KAAK,QAAQ;AAAA,oBAC1B;AAAA,oBACA;AAAA,kBACF,CAAC;AACD,8BAAY,KAAK,UAAU;AAAA,gBAC7B;AAEA,uBAAO,KAAK,QAAQ;AAAA,cACtB,CAAC;AAAA,YACH;AAEA,mBAAO,2BAAc,OAAO,KAAK,WAAW;AAAA,UAC9C;AAAA,QACF;AAAA,MACF,CAAC;AAAA,IACH;AAAA,EACF;AACF,CAAC;","names":["import_view"]}
@@ -1,12 +1,7 @@
1
- import { Extension, Editor } from '@tiptap/core';
1
+ import { Editor, Extension } from '@tiptap/core';
2
+ import { PluginKey } from '@tiptap/pm/state';
2
3
  import { Node } from '@tiptap/pm/model';
3
4
 
4
- /**
5
- * Prepares the placeholder attribute by ensuring it is properly formatted.
6
- * @param attr - The placeholder attribute string.
7
- * @returns The prepared placeholder attribute string.
8
- */
9
- declare function preparePlaceholderAttribute(attr: string): string;
10
5
  interface PlaceholderOptions {
11
6
  /**
12
7
  * **The class name for the empty editor**
@@ -53,14 +48,22 @@ interface PlaceholderOptions {
53
48
  */
54
49
  showOnlyCurrent: boolean;
55
50
  /**
56
- * **Controls if the placeholder should be shown for all descendents.**
51
+ * **Controls if the placeholder should be shown for all descendants.**
57
52
  *
58
- * If true, the placeholder will be shown for all descendents.
53
+ * If true, the placeholder will be shown for all descendants.
59
54
  * If false, the placeholder will only be shown for the current node.
60
55
  * @default false
61
56
  */
62
57
  includeChildren: boolean;
63
58
  }
59
+
60
+ /**
61
+ * Prepares the placeholder attribute by ensuring it is properly formatted.
62
+ * @param attr - The placeholder attribute string.
63
+ * @returns The prepared placeholder attribute string.
64
+ */
65
+ declare function preparePlaceholderAttribute(attr: string): string;
66
+ declare const PLUGIN_KEY: PluginKey<any>;
64
67
  /**
65
68
  * This extension allows you to add a placeholder to your editor.
66
69
  * A placeholder is a text that appears when the editor or a node is empty.
@@ -68,4 +71,4 @@ interface PlaceholderOptions {
68
71
  */
69
72
  declare const Placeholder: Extension<PlaceholderOptions, any>;
70
73
 
71
- export { Placeholder, type PlaceholderOptions, preparePlaceholderAttribute };
74
+ export { PLUGIN_KEY, Placeholder, type PlaceholderOptions, preparePlaceholderAttribute };
@@ -1,12 +1,7 @@
1
- import { Extension, Editor } from '@tiptap/core';
1
+ import { Editor, Extension } from '@tiptap/core';
2
+ import { PluginKey } from '@tiptap/pm/state';
2
3
  import { Node } from '@tiptap/pm/model';
3
4
 
4
- /**
5
- * Prepares the placeholder attribute by ensuring it is properly formatted.
6
- * @param attr - The placeholder attribute string.
7
- * @returns The prepared placeholder attribute string.
8
- */
9
- declare function preparePlaceholderAttribute(attr: string): string;
10
5
  interface PlaceholderOptions {
11
6
  /**
12
7
  * **The class name for the empty editor**
@@ -53,14 +48,22 @@ interface PlaceholderOptions {
53
48
  */
54
49
  showOnlyCurrent: boolean;
55
50
  /**
56
- * **Controls if the placeholder should be shown for all descendents.**
51
+ * **Controls if the placeholder should be shown for all descendants.**
57
52
  *
58
- * If true, the placeholder will be shown for all descendents.
53
+ * If true, the placeholder will be shown for all descendants.
59
54
  * If false, the placeholder will only be shown for the current node.
60
55
  * @default false
61
56
  */
62
57
  includeChildren: boolean;
63
58
  }
59
+
60
+ /**
61
+ * Prepares the placeholder attribute by ensuring it is properly formatted.
62
+ * @param attr - The placeholder attribute string.
63
+ * @returns The prepared placeholder attribute string.
64
+ */
65
+ declare function preparePlaceholderAttribute(attr: string): string;
66
+ declare const PLUGIN_KEY: PluginKey<any>;
64
67
  /**
65
68
  * This extension allows you to add a placeholder to your editor.
66
69
  * A placeholder is a text that appears when the editor or a node is empty.
@@ -68,4 +71,4 @@ interface PlaceholderOptions {
68
71
  */
69
72
  declare const Placeholder: Extension<PlaceholderOptions, any>;
70
73
 
71
- export { Placeholder, type PlaceholderOptions, preparePlaceholderAttribute };
74
+ export { PLUGIN_KEY, Placeholder, type PlaceholderOptions, preparePlaceholderAttribute };