@tiptap/extensions 3.30.1 → 3.30.3
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/character-count/index.cjs +84 -128
- package/dist/character-count/index.cjs.map +1 -1
- package/dist/character-count/index.d.cts +59 -58
- package/dist/character-count/index.d.cts.map +1 -0
- package/dist/character-count/index.d.ts +59 -58
- package/dist/character-count/index.d.ts.map +1 -0
- package/dist/character-count/index.js +82 -100
- package/dist/character-count/index.js.map +1 -1
- package/dist/drop-cursor/index.cjs +24 -44
- package/dist/drop-cursor/index.cjs.map +1 -1
- package/dist/drop-cursor/index.d.cts +23 -22
- package/dist/drop-cursor/index.d.cts.map +1 -0
- package/dist/drop-cursor/index.d.ts +23 -22
- package/dist/drop-cursor/index.d.ts.map +1 -0
- package/dist/drop-cursor/index.js +22 -16
- package/dist/drop-cursor/index.js.map +1 -1
- package/dist/focus/index.cjs +45 -92
- package/dist/focus/index.cjs.map +1 -1
- package/dist/focus/index.d.cts +22 -21
- package/dist/focus/index.d.cts.map +1 -0
- package/dist/focus/index.d.ts +22 -21
- package/dist/focus/index.d.ts.map +1 -0
- package/dist/focus/index.js +42 -63
- package/dist/focus/index.js.map +1 -1
- package/dist/gap-cursor/index.cjs +25 -48
- package/dist/gap-cursor/index.cjs.map +1 -1
- package/dist/gap-cursor/index.d.cts +16 -15
- package/dist/gap-cursor/index.d.cts.map +1 -0
- package/dist/gap-cursor/index.d.ts +16 -15
- package/dist/gap-cursor/index.d.ts.map +1 -0
- package/dist/gap-cursor/index.js +24 -21
- package/dist/gap-cursor/index.js.map +1 -1
- package/dist/index.cjs +666 -742
- package/dist/index.cjs.map +1 -1
- package/dist/index.d.cts +231 -220
- package/dist/index.d.cts.map +1 -0
- package/dist/index.d.ts +231 -220
- package/dist/index.d.ts.map +1 -0
- package/dist/index.js +653 -703
- package/dist/index.js.map +1 -1
- package/dist/placeholder/index.cjs +344 -376
- package/dist/placeholder/index.cjs.map +1 -1
- package/dist/placeholder/index.d.cts +73 -69
- package/dist/placeholder/index.d.cts.map +1 -0
- package/dist/placeholder/index.d.ts +73 -69
- package/dist/placeholder/index.d.ts.map +1 -0
- package/dist/placeholder/index.js +340 -346
- package/dist/placeholder/index.js.map +1 -1
- package/dist/selection/index.cjs +62 -86
- package/dist/selection/index.cjs.map +1 -1
- package/dist/selection/index.d.cts +11 -10
- package/dist/selection/index.d.cts.map +1 -0
- package/dist/selection/index.d.ts +11 -10
- package/dist/selection/index.d.ts.map +1 -0
- package/dist/selection/index.js +58 -56
- package/dist/selection/index.js.map +1 -1
- package/dist/trailing-node/index.cjs +59 -89
- package/dist/trailing-node/index.cjs.map +1 -1
- package/dist/trailing-node/index.d.cts +17 -16
- package/dist/trailing-node/index.d.cts.map +1 -0
- package/dist/trailing-node/index.d.ts +17 -16
- package/dist/trailing-node/index.d.ts.map +1 -0
- package/dist/trailing-node/index.js +55 -59
- package/dist/trailing-node/index.js.map +1 -1
- package/dist/undo-redo/index.cjs +45 -63
- package/dist/undo-redo/index.cjs.map +1 -1
- package/dist/undo-redo/index.d.cts +31 -30
- package/dist/undo-redo/index.d.cts.map +1 -0
- package/dist/undo-redo/index.d.ts +31 -30
- package/dist/undo-redo/index.d.ts.map +1 -0
- package/dist/undo-redo/index.js +43 -35
- package/dist/undo-redo/index.js.map +1 -1
- package/package.json +6 -6
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"sources":["../../src/placeholder/index.ts","../../src/placeholder/constants.ts","../../src/placeholder/placeholder.ts","../../src/placeholder/plugins/PlaceholderPlugin.ts","../../src/placeholder/utils/buildPlaceholderDecorations.ts","../../src/placeholder/utils/createPlaceholderDecoration.ts","../../src/placeholder/utils/placeholderStateField.ts","../../src/placeholder/utils/resolveTopLevelRange.ts","../../src/placeholder/utils/preparePlaceholderAttribute.ts"],"sourcesContent":["export { DEFAULT_DATA_ATTRIBUTE, PLUGIN_KEY } from './constants.js'\nexport * from './placeholder.js'\nexport * from './types.js'\nexport { preparePlaceholderAttribute } from './utils/preparePlaceholderAttribute.js'\n","import { PluginKey } from '@tiptap/pm/state'\nimport type { DecorationSet } from '@tiptap/pm/view'\n\n/** The default data attribute label */\nexport const DEFAULT_DATA_ATTRIBUTE = 'placeholder'\n\n/** The plugin key used to store and read the placeholder decoration set */\nexport const PLUGIN_KEY = new PluginKey<DecorationSet>('tiptap__placeholder')\n","import { Extension } from '@tiptap/core'\n\nimport { DEFAULT_DATA_ATTRIBUTE } from './constants.js'\nimport { createPlaceholderPlugin } from './plugins/PlaceholderPlugin.js'\nimport type { PlaceholderOptions } from './types.js'\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 return [createPlaceholderPlugin({ editor: this.editor, options: this.options })]\n },\n})\n","import type { Editor } from '@tiptap/core'\nimport { Plugin } from '@tiptap/pm/state'\nimport { DecorationSet } from '@tiptap/pm/view'\n\nimport { DEFAULT_DATA_ATTRIBUTE, PLUGIN_KEY } from '../constants.js'\nimport type { PlaceholderOptions } from '../types.js'\nimport { buildPlaceholderDecorations } from '../utils/buildPlaceholderDecorations.js'\nimport { createPlaceholderStateField } from '../utils/placeholderStateField.js'\nimport { preparePlaceholderAttribute } from '../utils/preparePlaceholderAttribute.js'\n\nexport type CreatePluginOptions = {\n editor: Editor\n options: PlaceholderOptions\n}\n\n/**\n * Creates the ProseMirror plugin that renders placeholder decorations.\n * @param options.editor - The editor instance.\n * @param options.options - The resolved placeholder options.\n * @returns The configured placeholder plugin.\n */\nexport function createPlaceholderPlugin({ editor, options }: CreatePluginOptions) {\n const dataAttribute = options.dataAttribute\n ? `data-${preparePlaceholderAttribute(options.dataAttribute)}`\n : `data-${DEFAULT_DATA_ATTRIBUTE}`\n\n const useResolvedPath = options.showOnlyCurrent && !options.includeChildren\n\n return new Plugin({\n key: PLUGIN_KEY,\n ...(useResolvedPath\n ? {}\n : {\n state: createPlaceholderStateField({ editor, options, dataAttribute }),\n }),\n props: {\n decorations: useResolvedPath\n ? ({ doc, selection }) =>\n buildPlaceholderDecorations({ editor, options, dataAttribute, doc, selection })\n : state => {\n if (options.showOnlyWhenEditable && !editor.isEditable) {\n return DecorationSet.empty\n }\n\n return PLUGIN_KEY.getState(state) ?? DecorationSet.empty\n },\n },\n })\n}\n","import type { Editor } from '@tiptap/core'\nimport { isNodeEmpty } from '@tiptap/core'\nimport type { Node } from '@tiptap/pm/model'\nimport type { Selection } 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 './createPlaceholderDecoration.js'\n\nfunction resolveEmptyNodeClass(\n emptyNodeClass: PlaceholderOptions['emptyNodeClass'],\n props: { editor: Editor; node: Node; pos: number; hasAnchor: boolean },\n): string {\n return typeof emptyNodeClass === 'function' ? emptyNodeClass(props) : emptyNodeClass\n}\n\n/**\n * Scans a document range for empty textblocks that should receive placeholder\n * decorations. Used by the slow path and incremental state updates.\n */\nexport function scanRangeForDecorations({\n editor,\n options,\n dataAttribute,\n doc,\n selection,\n from,\n to,\n}: {\n editor: Editor\n options: PlaceholderOptions\n dataAttribute: string\n doc: Node\n selection: Selection\n from: number\n to: number\n}): Decoration[] {\n const { anchor } = selection\n const decorations: Decoration[] = []\n const isEmptyDoc = editor.isEmpty\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 options.includeChildren\n }\n\n if ((hasAnchor || !options.showOnlyCurrent) && isEmpty) {\n decorations.push(\n createPlaceholderDecoration({\n editor,\n isEmptyDoc,\n dataAttribute,\n hasAnchor,\n placeholder: options.placeholder,\n classes: {\n emptyEditor: options.emptyEditorClass,\n emptyNode: resolveEmptyNodeClass(options.emptyNodeClass, {\n editor,\n node,\n pos,\n hasAnchor,\n }),\n },\n node,\n pos,\n }),\n )\n }\n\n return options.includeChildren\n })\n\n return decorations\n}\n\n/**\n * Builds the placeholder decorations for the current document state.\n * @param options.editor - The editor instance.\n * @param options.options - The resolved placeholder options.\n * @param options.dataAttribute - The prepared `data-*` attribute name.\n * @param options.doc - The current document node.\n * @param options.selection - The current selection.\n * @returns A decoration set, or `null` when no placeholders should be shown.\n */\nexport function buildPlaceholderDecorations({\n editor,\n options,\n dataAttribute,\n doc,\n selection,\n}: {\n editor: Editor\n options: PlaceholderOptions\n dataAttribute: string\n doc: Node\n selection: Selection\n}): DecorationSet | null {\n const active = editor.isEditable || !options.showOnlyWhenEditable\n\n if (!active) {\n return null\n }\n\n const { anchor } = selection\n const decorations: Decoration[] = []\n const isEmptyDoc = editor.isEmpty\n\n const useResolvedPath = options.showOnlyCurrent && !options.includeChildren\n\n if (useResolvedPath) {\n const resolved = doc.resolve(anchor)\n\n // When the selection spans the whole document (e.g. an `AllSelection`\n // after Cmd+A), the anchor resolves to the document level (depth 0). In\n // that case the relevant textblock is the node directly after the\n // position rather than an ancestor. otherwise the placeholder would\n // disappear after selecting all and deleting.\n const node = resolved.depth > 0 ? resolved.node(1) : resolved.nodeAfter\n const nodeStart = resolved.depth > 0 ? resolved.before(1) : anchor\n\n if (node && node.type.isTextblock && isNodeEmpty(node)) {\n const hasAnchor = anchor >= nodeStart && anchor <= nodeStart + node.nodeSize\n\n decorations.push(\n createPlaceholderDecoration({\n editor,\n isEmptyDoc,\n dataAttribute,\n hasAnchor,\n placeholder: options.placeholder,\n classes: {\n emptyEditor: options.emptyEditorClass,\n emptyNode: resolveEmptyNodeClass(options.emptyNodeClass, {\n editor,\n node,\n pos: nodeStart,\n hasAnchor,\n }),\n },\n node,\n pos: nodeStart,\n }),\n )\n }\n } else {\n decorations.push(\n ...scanRangeForDecorations({\n editor,\n options,\n dataAttribute,\n doc,\n selection,\n from: 0,\n to: doc.content.size,\n }),\n )\n }\n\n return DecorationSet.create(doc, decorations)\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: string\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","import type { Editor } from '@tiptap/core'\nimport { getChangedRanges } from '@tiptap/core'\nimport type { Node } from '@tiptap/pm/model'\nimport type { EditorState, StateField, Transaction } from '@tiptap/pm/state'\nimport type { Selection } from '@tiptap/pm/state'\nimport { DecorationSet } from '@tiptap/pm/view'\n\nimport type { PlaceholderOptions } from '../types.js'\nimport {\n buildPlaceholderDecorations,\n scanRangeForDecorations,\n} from './buildPlaceholderDecorations.js'\nimport {\n getTopLevelBlocksInRange,\n mergeRanges,\n resolveTopLevelRange,\n toContentRelativeRange,\n} from './resolveTopLevelRange.js'\n\n/** Options passed to {@link createPlaceholderStateField}. */\nexport type CreatePlaceholderStateFieldOptions = {\n editor: Editor\n options: PlaceholderOptions\n dataAttribute: string\n}\n\n/**\n * Expands a single changed range to the top-level blocks it touches.\n * Also resolves blocks at range boundaries so split/merge edits update\n * adjacent empty nodes (e.g. a new paragraph after Enter).\n */\nfunction collectBlocksForChange(\n doc: Node,\n change: { from: number; to: number },\n): Array<{ from: number; to: number }> {\n const ranges = getTopLevelBlocksInRange(doc, change.from, change.to)\n\n ranges.push(toContentRelativeRange(doc, resolveTopLevelRange(doc, change.from)))\n\n if (change.to > change.from) {\n ranges.push(\n toContentRelativeRange(\n doc,\n resolveTopLevelRange(doc, Math.min(change.to, doc.content.size + 1) - 1),\n ),\n )\n } else if (change.from < doc.content.size + 1) {\n ranges.push(\n toContentRelativeRange(\n doc,\n resolveTopLevelRange(doc, Math.min(change.from + 1, doc.content.size)),\n ),\n )\n }\n\n return ranges\n}\n\n/**\n * Collects content-relative top-level block ranges that need placeholder\n * decorations recomputed after a transaction.\n */\nfunction collectRescanRanges(\n tr: Transaction,\n oldState: EditorState,\n newState: EditorState,\n): Array<{ from: number; to: number }> {\n const ranges: Array<{ from: number; to: number }> = []\n\n if (tr.docChanged) {\n const changes = getChangedRanges(tr)\n\n for (const change of changes) {\n ranges.push(...collectBlocksForChange(newState.doc, change.newRange))\n }\n }\n\n if (tr.selectionSet) {\n ranges.push(\n toContentRelativeRange(\n newState.doc,\n resolveTopLevelRange(newState.doc, tr.mapping.map(oldState.selection.anchor)),\n ),\n )\n ranges.push(\n toContentRelativeRange(\n newState.doc,\n resolveTopLevelRange(newState.doc, newState.selection.anchor),\n ),\n )\n }\n\n return mergeRanges(ranges)\n}\n\n/** Clamps a content-relative range to `[0, doc.content.size]`. */\nfunction clampRange(from: number, to: number, doc: Node): { from: number; to: number } {\n const clampedFrom = Math.max(0, Math.min(from, doc.content.size))\n const clampedTo = Math.max(clampedFrom, Math.min(to, doc.content.size))\n\n return { from: clampedFrom, to: clampedTo }\n}\n\n/**\n * Removes and rebuilds placeholder decorations within the given ranges.\n * Only drops decorations fully contained in a range so mapped decorations\n * on neighbouring blocks (e.g. at a block boundary) are kept intact.\n */\nfunction updateDecorationsInRanges({\n decorations,\n ranges,\n editor,\n options,\n dataAttribute,\n doc,\n selection,\n}: {\n decorations: DecorationSet\n ranges: Array<{ from: number; to: number }>\n editor: Editor\n options: PlaceholderOptions\n dataAttribute: string\n doc: Node\n selection: Selection\n}): DecorationSet {\n let next = decorations\n\n for (const range of ranges) {\n const { from, to } = clampRange(range.from, range.to, doc)\n const existing = next\n .find(from, to)\n .filter(decoration => decoration.from >= from && decoration.to <= to)\n\n if (existing.length) {\n next = next.remove(existing)\n }\n\n const newDecos = scanRangeForDecorations({\n editor,\n options,\n dataAttribute,\n doc,\n selection,\n from,\n to,\n })\n\n if (newDecos.length) {\n next = next.add(doc, newDecos)\n }\n }\n\n return next\n}\n\n/**\n * Creates the incremental `StateField<DecorationSet>` used by the slow path\n * (`showOnlyCurrent: false` or `includeChildren: true`).\n *\n * Decorations are mapped through each transaction and only recomputed for\n * top-level blocks touched by document or selection changes.\n * @param options.editor - The editor instance.\n * @param options.options - The resolved placeholder options.\n * @param options.dataAttribute - The prepared `data-*` attribute name.\n * @returns A ProseMirror state field storing the placeholder decoration set.\n */\nexport function createPlaceholderStateField({\n editor,\n options,\n dataAttribute,\n}: CreatePlaceholderStateFieldOptions): StateField<DecorationSet> {\n return {\n init(_config, state: EditorState) {\n const decorations = buildPlaceholderDecorations({\n editor,\n options,\n dataAttribute,\n doc: state.doc,\n selection: state.selection,\n })\n\n return decorations ?? DecorationSet.empty\n },\n\n apply(tr: Transaction, prev: DecorationSet, oldState: EditorState, newState: EditorState) {\n if (!tr.docChanged && !tr.selectionSet) {\n return prev\n }\n\n const mapped = prev.map(tr.mapping, tr.doc)\n const ranges = collectRescanRanges(tr, oldState, newState)\n\n return updateDecorationsInRanges({\n decorations: mapped,\n ranges,\n editor,\n options,\n dataAttribute,\n doc: newState.doc,\n selection: newState.selection,\n })\n },\n }\n}\n","import type { Node } from '@tiptap/pm/model'\n\n/**\n * Resolves a document position to the `[from, to)` range of its containing\n * top-level block node in absolute document positions.\n */\nexport function resolveTopLevelRange(doc: Node, pos: number): { from: number; to: number } {\n const resolved = doc.resolve(pos)\n\n if (resolved.depth === 0) {\n const node = resolved.nodeAfter ?? resolved.nodeBefore\n\n if (!node) {\n return { from: pos, to: pos }\n }\n\n const nodePos = resolved.nodeAfter ? pos : pos - node.nodeSize\n\n return { from: nodePos, to: nodePos + node.nodeSize }\n }\n\n const topLevelPos = resolved.before(1)\n const node = resolved.node(1)\n\n return { from: topLevelPos, to: topLevelPos + node.nodeSize }\n}\n\n/**\n * Converts an absolute document range to content-relative positions used by\n * `Node#nodesBetween` and `Node#forEach` offsets.\n */\nexport function toContentRelativeRange(\n doc: Node,\n range: { from: number; to: number },\n): { from: number; to: number } {\n return {\n from: Math.max(0, range.from - 1),\n to: Math.min(doc.content.size, range.to - 1),\n }\n}\n\n/**\n * Returns the top-level block ranges that intersect a document change range.\n * Input `from`/`to` are absolute positions (e.g. from `getChangedRanges`).\n * Returned ranges are content-relative, matching `Node#forEach` offsets.\n */\nexport function getTopLevelBlocksInRange(\n doc: Node,\n from: number,\n to: number,\n): Array<{ from: number; to: number }> {\n const ranges: Array<{ from: number; to: number }> = []\n\n doc.forEach((node, offset) => {\n const nodeStart = offset\n const nodeEnd = nodeStart + node.nodeSize\n const absNodeStart = nodeStart + 1\n const absNodeEnd = nodeEnd + 1\n\n if (absNodeStart < to && absNodeEnd > from) {\n ranges.push({ from: nodeStart, to: nodeEnd })\n }\n })\n\n return ranges\n}\n\n/**\n * Sorts ranges by start position and merges overlapping or adjacent ranges.\n */\nexport function mergeRanges(\n ranges: Array<{ from: number; to: number }>,\n): Array<{ from: number; to: number }> {\n if (ranges.length === 0) {\n return []\n }\n\n const sorted = [...ranges].sort((a, b) => a.from - b.from)\n const merged: Array<{ from: number; to: number }> = [{ ...sorted[0] }]\n\n for (let i = 1; i < sorted.length; i += 1) {\n const last = merged[merged.length - 1]\n const current = sorted[i]\n\n if (current.from <= last.to) {\n last.to = Math.max(last.to, current.to)\n } else {\n merged.push({ ...current })\n }\n }\n\n return merged\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"],"mappings":";;;;;;;;;;;;;;;;;;;;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;AAAA;;;ACAA,mBAA0B;AAInB,IAAM,yBAAyB;AAG/B,IAAM,aAAa,IAAI,uBAAyB,qBAAqB;;;ACP5E,IAAAA,eAA0B;;;ACC1B,IAAAC,gBAAuB;AACvB,IAAAC,eAA8B;;;ACD9B,kBAA4B;AAI5B,IAAAC,eAA8B;;;ACH9B,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;;;ADlDA,SAAS,sBACP,gBACA,OACQ;AACR,SAAO,OAAO,mBAAmB,aAAa,eAAe,KAAK,IAAI;AACxE;AAMO,SAAS,wBAAwB;AAAA,EACtC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAQiB;AACf,QAAM,EAAE,OAAO,IAAI;AACnB,QAAM,cAA4B,CAAC;AACnC,QAAM,aAAa,OAAO;AAE1B,MAAI,aAAa,MAAM,IAAI,CAAC,MAAM,QAAQ;AACxC,UAAM,YAAY,UAAU,OAAO,UAAU,MAAM,KAAK;AACxD,UAAM,UAAU,CAAC,KAAK,cAAU,yBAAY,IAAI;AAEhD,QAAI,CAAC,KAAK,KAAK,aAAa;AAC1B,aAAO,QAAQ;AAAA,IACjB;AAEA,SAAK,aAAa,CAAC,QAAQ,oBAAoB,SAAS;AACtD,kBAAY;AAAA,QACV,4BAA4B;AAAA,UAC1B;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA,aAAa,QAAQ;AAAA,UACrB,SAAS;AAAA,YACP,aAAa,QAAQ;AAAA,YACrB,WAAW,sBAAsB,QAAQ,gBAAgB;AAAA,cACvD;AAAA,cACA;AAAA,cACA;AAAA,cACA;AAAA,YACF,CAAC;AAAA,UACH;AAAA,UACA;AAAA,UACA;AAAA,QACF,CAAC;AAAA,MACH;AAAA,IACF;AAEA,WAAO,QAAQ;AAAA,EACjB,CAAC;AAED,SAAO;AACT;AAWO,SAAS,4BAA4B;AAAA,EAC1C;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAMyB;AACvB,QAAM,SAAS,OAAO,cAAc,CAAC,QAAQ;AAE7C,MAAI,CAAC,QAAQ;AACX,WAAO;AAAA,EACT;AAEA,QAAM,EAAE,OAAO,IAAI;AACnB,QAAM,cAA4B,CAAC;AACnC,QAAM,aAAa,OAAO;AAE1B,QAAM,kBAAkB,QAAQ,mBAAmB,CAAC,QAAQ;AAE5D,MAAI,iBAAiB;AACnB,UAAM,WAAW,IAAI,QAAQ,MAAM;AAOnC,UAAM,OAAO,SAAS,QAAQ,IAAI,SAAS,KAAK,CAAC,IAAI,SAAS;AAC9D,UAAM,YAAY,SAAS,QAAQ,IAAI,SAAS,OAAO,CAAC,IAAI;AAE5D,QAAI,QAAQ,KAAK,KAAK,mBAAe,yBAAY,IAAI,GAAG;AACtD,YAAM,YAAY,UAAU,aAAa,UAAU,YAAY,KAAK;AAEpE,kBAAY;AAAA,QACV,4BAA4B;AAAA,UAC1B;AAAA,UACA;AAAA,UACA;AAAA,UACA;AAAA,UACA,aAAa,QAAQ;AAAA,UACrB,SAAS;AAAA,YACP,aAAa,QAAQ;AAAA,YACrB,WAAW,sBAAsB,QAAQ,gBAAgB;AAAA,cACvD;AAAA,cACA;AAAA,cACA,KAAK;AAAA,cACL;AAAA,YACF,CAAC;AAAA,UACH;AAAA,UACA;AAAA,UACA,KAAK;AAAA,QACP,CAAC;AAAA,MACH;AAAA,IACF;AAAA,EACF,OAAO;AACL,gBAAY;AAAA,MACV,GAAG,wBAAwB;AAAA,QACzB;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,MAAM;AAAA,QACN,IAAI,IAAI,QAAQ;AAAA,MAClB,CAAC;AAAA,IACH;AAAA,EACF;AAEA,SAAO,2BAAc,OAAO,KAAK,WAAW;AAC9C;;;AElKA,IAAAC,eAAiC;AAIjC,IAAAC,eAA8B;;;ACCvB,SAAS,qBAAqB,KAAW,KAA2C;AAN3F;AAOE,QAAM,WAAW,IAAI,QAAQ,GAAG;AAEhC,MAAI,SAAS,UAAU,GAAG;AACxB,UAAMC,SAAO,cAAS,cAAT,YAAsB,SAAS;AAE5C,QAAI,CAACA,OAAM;AACT,aAAO,EAAE,MAAM,KAAK,IAAI,IAAI;AAAA,IAC9B;AAEA,UAAM,UAAU,SAAS,YAAY,MAAM,MAAMA,MAAK;AAEtD,WAAO,EAAE,MAAM,SAAS,IAAI,UAAUA,MAAK,SAAS;AAAA,EACtD;AAEA,QAAM,cAAc,SAAS,OAAO,CAAC;AACrC,QAAM,OAAO,SAAS,KAAK,CAAC;AAE5B,SAAO,EAAE,MAAM,aAAa,IAAI,cAAc,KAAK,SAAS;AAC9D;AAMO,SAAS,uBACd,KACA,OAC8B;AAC9B,SAAO;AAAA,IACL,MAAM,KAAK,IAAI,GAAG,MAAM,OAAO,CAAC;AAAA,IAChC,IAAI,KAAK,IAAI,IAAI,QAAQ,MAAM,MAAM,KAAK,CAAC;AAAA,EAC7C;AACF;AAOO,SAAS,yBACd,KACA,MACA,IACqC;AACrC,QAAM,SAA8C,CAAC;AAErD,MAAI,QAAQ,CAAC,MAAM,WAAW;AAC5B,UAAM,YAAY;AAClB,UAAM,UAAU,YAAY,KAAK;AACjC,UAAM,eAAe,YAAY;AACjC,UAAM,aAAa,UAAU;AAE7B,QAAI,eAAe,MAAM,aAAa,MAAM;AAC1C,aAAO,KAAK,EAAE,MAAM,WAAW,IAAI,QAAQ,CAAC;AAAA,IAC9C;AAAA,EACF,CAAC;AAED,SAAO;AACT;AAKO,SAAS,YACd,QACqC;AACrC,MAAI,OAAO,WAAW,GAAG;AACvB,WAAO,CAAC;AAAA,EACV;AAEA,QAAM,SAAS,CAAC,GAAG,MAAM,EAAE,KAAK,CAAC,GAAG,MAAM,EAAE,OAAO,EAAE,IAAI;AACzD,QAAM,SAA8C,CAAC,EAAE,GAAG,OAAO,CAAC,EAAE,CAAC;AAErE,WAAS,IAAI,GAAG,IAAI,OAAO,QAAQ,KAAK,GAAG;AACzC,UAAM,OAAO,OAAO,OAAO,SAAS,CAAC;AACrC,UAAM,UAAU,OAAO,CAAC;AAExB,QAAI,QAAQ,QAAQ,KAAK,IAAI;AAC3B,WAAK,KAAK,KAAK,IAAI,KAAK,IAAI,QAAQ,EAAE;AAAA,IACxC,OAAO;AACL,aAAO,KAAK,EAAE,GAAG,QAAQ,CAAC;AAAA,IAC5B;AAAA,EACF;AAEA,SAAO;AACT;;;AD7DA,SAAS,uBACP,KACA,QACqC;AACrC,QAAM,SAAS,yBAAyB,KAAK,OAAO,MAAM,OAAO,EAAE;AAEnE,SAAO,KAAK,uBAAuB,KAAK,qBAAqB,KAAK,OAAO,IAAI,CAAC,CAAC;AAE/E,MAAI,OAAO,KAAK,OAAO,MAAM;AAC3B,WAAO;AAAA,MACL;AAAA,QACE;AAAA,QACA,qBAAqB,KAAK,KAAK,IAAI,OAAO,IAAI,IAAI,QAAQ,OAAO,CAAC,IAAI,CAAC;AAAA,MACzE;AAAA,IACF;AAAA,EACF,WAAW,OAAO,OAAO,IAAI,QAAQ,OAAO,GAAG;AAC7C,WAAO;AAAA,MACL;AAAA,QACE;AAAA,QACA,qBAAqB,KAAK,KAAK,IAAI,OAAO,OAAO,GAAG,IAAI,QAAQ,IAAI,CAAC;AAAA,MACvE;AAAA,IACF;AAAA,EACF;AAEA,SAAO;AACT;AAMA,SAAS,oBACP,IACA,UACA,UACqC;AACrC,QAAM,SAA8C,CAAC;AAErD,MAAI,GAAG,YAAY;AACjB,UAAM,cAAU,+BAAiB,EAAE;AAEnC,eAAW,UAAU,SAAS;AAC5B,aAAO,KAAK,GAAG,uBAAuB,SAAS,KAAK,OAAO,QAAQ,CAAC;AAAA,IACtE;AAAA,EACF;AAEA,MAAI,GAAG,cAAc;AACnB,WAAO;AAAA,MACL;AAAA,QACE,SAAS;AAAA,QACT,qBAAqB,SAAS,KAAK,GAAG,QAAQ,IAAI,SAAS,UAAU,MAAM,CAAC;AAAA,MAC9E;AAAA,IACF;AACA,WAAO;AAAA,MACL;AAAA,QACE,SAAS;AAAA,QACT,qBAAqB,SAAS,KAAK,SAAS,UAAU,MAAM;AAAA,MAC9D;AAAA,IACF;AAAA,EACF;AAEA,SAAO,YAAY,MAAM;AAC3B;AAGA,SAAS,WAAW,MAAc,IAAY,KAAyC;AACrF,QAAM,cAAc,KAAK,IAAI,GAAG,KAAK,IAAI,MAAM,IAAI,QAAQ,IAAI,CAAC;AAChE,QAAM,YAAY,KAAK,IAAI,aAAa,KAAK,IAAI,IAAI,IAAI,QAAQ,IAAI,CAAC;AAEtE,SAAO,EAAE,MAAM,aAAa,IAAI,UAAU;AAC5C;AAOA,SAAS,0BAA0B;AAAA,EACjC;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AAAA,EACA;AACF,GAQkB;AAChB,MAAI,OAAO;AAEX,aAAW,SAAS,QAAQ;AAC1B,UAAM,EAAE,MAAM,GAAG,IAAI,WAAW,MAAM,MAAM,MAAM,IAAI,GAAG;AACzD,UAAM,WAAW,KACd,KAAK,MAAM,EAAE,EACb,OAAO,gBAAc,WAAW,QAAQ,QAAQ,WAAW,MAAM,EAAE;AAEtE,QAAI,SAAS,QAAQ;AACnB,aAAO,KAAK,OAAO,QAAQ;AAAA,IAC7B;AAEA,UAAM,WAAW,wBAAwB;AAAA,MACvC;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,MACA;AAAA,IACF,CAAC;AAED,QAAI,SAAS,QAAQ;AACnB,aAAO,KAAK,IAAI,KAAK,QAAQ;AAAA,IAC/B;AAAA,EACF;AAEA,SAAO;AACT;AAaO,SAAS,4BAA4B;AAAA,EAC1C;AAAA,EACA;AAAA,EACA;AACF,GAAkE;AAChE,SAAO;AAAA,IACL,KAAK,SAAS,OAAoB;AAChC,YAAM,cAAc,4BAA4B;AAAA,QAC9C;AAAA,QACA;AAAA,QACA;AAAA,QACA,KAAK,MAAM;AAAA,QACX,WAAW,MAAM;AAAA,MACnB,CAAC;AAED,aAAO,oCAAe,2BAAc;AAAA,IACtC;AAAA,IAEA,MAAM,IAAiB,MAAqB,UAAuB,UAAuB;AACxF,UAAI,CAAC,GAAG,cAAc,CAAC,GAAG,cAAc;AACtC,eAAO;AAAA,MACT;AAEA,YAAM,SAAS,KAAK,IAAI,GAAG,SAAS,GAAG,GAAG;AAC1C,YAAM,SAAS,oBAAoB,IAAI,UAAU,QAAQ;AAEzD,aAAO,0BAA0B;AAAA,QAC/B,aAAa;AAAA,QACb;AAAA,QACA;AAAA,QACA;AAAA,QACA;AAAA,QACA,KAAK,SAAS;AAAA,QACd,WAAW,SAAS;AAAA,MACtB,CAAC;AAAA,IACH;AAAA,EACF;AACF;;;AEtMO,SAAS,4BAA4B,MAAsB;AAChE,SACE,KAEG,QAAQ,QAAQ,GAAG,EAInB,QAAQ,kBAAkB,EAAE,EAE5B,QAAQ,YAAY,EAAE,EAEtB,QAAQ,OAAO,EAAE,EACjB,YAAY;AAEnB;;;ALCO,SAAS,wBAAwB,EAAE,QAAQ,QAAQ,GAAwB;AAChF,QAAM,gBAAgB,QAAQ,gBAC1B,QAAQ,4BAA4B,QAAQ,aAAa,CAAC,KAC1D,QAAQ,sBAAsB;AAElC,QAAM,kBAAkB,QAAQ,mBAAmB,CAAC,QAAQ;AAE5D,SAAO,IAAI,qBAAO;AAAA,IAChB,KAAK;AAAA,IACL,GAAI,kBACA,CAAC,IACD;AAAA,MACE,OAAO,4BAA4B,EAAE,QAAQ,SAAS,cAAc,CAAC;AAAA,IACvE;AAAA,IACJ,OAAO;AAAA,MACL,aAAa,kBACT,CAAC,EAAE,KAAK,UAAU,MAChB,4BAA4B,EAAE,QAAQ,SAAS,eAAe,KAAK,UAAU,CAAC,IAChF,WAAS;AAvCnB;AAwCY,YAAI,QAAQ,wBAAwB,CAAC,OAAO,YAAY;AACtD,iBAAO,2BAAc;AAAA,QACvB;AAEA,gBAAO,gBAAW,SAAS,KAAK,MAAzB,YAA8B,2BAAc;AAAA,MACrD;AAAA,IACN;AAAA,EACF,CAAC;AACH;;;ADrCO,IAAM,cAAc,uBAAU,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,WAAO,CAAC,wBAAwB,EAAE,QAAQ,KAAK,QAAQ,SAAS,KAAK,QAAQ,CAAC,CAAC;AAAA,EACjF;AACF,CAAC;","names":["import_core","import_state","import_view","import_view","import_core","import_view","node"]}
|
|
1
|
+
{"version":3,"file":"index.cjs","names":["PluginKey","Decoration","DecorationSet","DecorationSet","Plugin","DecorationSet","Extension"],"sources":["../../src/placeholder/constants.ts","../../src/placeholder/utils/createPlaceholderDecoration.ts","../../src/placeholder/utils/buildPlaceholderDecorations.ts","../../src/placeholder/utils/resolveTopLevelRange.ts","../../src/placeholder/utils/placeholderStateField.ts","../../src/placeholder/utils/preparePlaceholderAttribute.ts","../../src/placeholder/plugins/PlaceholderPlugin.ts","../../src/placeholder/placeholder.ts"],"sourcesContent":["import { PluginKey } from '@tiptap/pm/state'\nimport type { DecorationSet } from '@tiptap/pm/view'\n\n/** The default data attribute label */\nexport const DEFAULT_DATA_ATTRIBUTE = 'placeholder'\n\n/** The plugin key used to store and read the placeholder decoration set */\nexport const PLUGIN_KEY = new PluginKey<DecorationSet>('tiptap__placeholder')\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: string\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","import type { Editor } from '@tiptap/core'\nimport { isNodeEmpty } from '@tiptap/core'\nimport type { Node } from '@tiptap/pm/model'\nimport type { Selection } 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 './createPlaceholderDecoration.js'\n\nfunction resolveEmptyNodeClass(\n emptyNodeClass: PlaceholderOptions['emptyNodeClass'],\n props: { editor: Editor; node: Node; pos: number; hasAnchor: boolean },\n): string {\n return typeof emptyNodeClass === 'function' ? emptyNodeClass(props) : emptyNodeClass\n}\n\n/**\n * Scans a document range for empty textblocks that should receive placeholder\n * decorations. Used by the slow path and incremental state updates.\n */\nexport function scanRangeForDecorations({\n editor,\n options,\n dataAttribute,\n doc,\n selection,\n from,\n to,\n}: {\n editor: Editor\n options: PlaceholderOptions\n dataAttribute: string\n doc: Node\n selection: Selection\n from: number\n to: number\n}): Decoration[] {\n const { anchor } = selection\n const decorations: Decoration[] = []\n const isEmptyDoc = editor.isEmpty\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 options.includeChildren\n }\n\n if ((hasAnchor || !options.showOnlyCurrent) && isEmpty) {\n decorations.push(\n createPlaceholderDecoration({\n editor,\n isEmptyDoc,\n dataAttribute,\n hasAnchor,\n placeholder: options.placeholder,\n classes: {\n emptyEditor: options.emptyEditorClass,\n emptyNode: resolveEmptyNodeClass(options.emptyNodeClass, {\n editor,\n node,\n pos,\n hasAnchor,\n }),\n },\n node,\n pos,\n }),\n )\n }\n\n return options.includeChildren\n })\n\n return decorations\n}\n\n/**\n * Builds the placeholder decorations for the current document state.\n * @param options.editor - The editor instance.\n * @param options.options - The resolved placeholder options.\n * @param options.dataAttribute - The prepared `data-*` attribute name.\n * @param options.doc - The current document node.\n * @param options.selection - The current selection.\n * @returns A decoration set, or `null` when no placeholders should be shown.\n */\nexport function buildPlaceholderDecorations({\n editor,\n options,\n dataAttribute,\n doc,\n selection,\n}: {\n editor: Editor\n options: PlaceholderOptions\n dataAttribute: string\n doc: Node\n selection: Selection\n}): DecorationSet | null {\n const active = editor.isEditable || !options.showOnlyWhenEditable\n\n if (!active) {\n return null\n }\n\n const { anchor } = selection\n const decorations: Decoration[] = []\n const isEmptyDoc = editor.isEmpty\n\n const useResolvedPath = options.showOnlyCurrent && !options.includeChildren\n\n if (useResolvedPath) {\n const resolved = doc.resolve(anchor)\n\n // When the selection spans the whole document (e.g. an `AllSelection`\n // after Cmd+A), the anchor resolves to the document level (depth 0). In\n // that case the relevant textblock is the node directly after the\n // position rather than an ancestor. otherwise the placeholder would\n // disappear after selecting all and deleting.\n const node = resolved.depth > 0 ? resolved.node(1) : resolved.nodeAfter\n const nodeStart = resolved.depth > 0 ? resolved.before(1) : anchor\n\n if (node && node.type.isTextblock && isNodeEmpty(node)) {\n const hasAnchor = anchor >= nodeStart && anchor <= nodeStart + node.nodeSize\n\n decorations.push(\n createPlaceholderDecoration({\n editor,\n isEmptyDoc,\n dataAttribute,\n hasAnchor,\n placeholder: options.placeholder,\n classes: {\n emptyEditor: options.emptyEditorClass,\n emptyNode: resolveEmptyNodeClass(options.emptyNodeClass, {\n editor,\n node,\n pos: nodeStart,\n hasAnchor,\n }),\n },\n node,\n pos: nodeStart,\n }),\n )\n }\n } else {\n decorations.push(\n ...scanRangeForDecorations({\n editor,\n options,\n dataAttribute,\n doc,\n selection,\n from: 0,\n to: doc.content.size,\n }),\n )\n }\n\n return DecorationSet.create(doc, decorations)\n}\n","import type { Node } from '@tiptap/pm/model'\n\n/**\n * Resolves a document position to the `[from, to)` range of its containing\n * top-level block node in absolute document positions.\n */\nexport function resolveTopLevelRange(doc: Node, pos: number): { from: number; to: number } {\n const resolved = doc.resolve(pos)\n\n if (resolved.depth === 0) {\n const node = resolved.nodeAfter ?? resolved.nodeBefore\n\n if (!node) {\n return { from: pos, to: pos }\n }\n\n const nodePos = resolved.nodeAfter ? pos : pos - node.nodeSize\n\n return { from: nodePos, to: nodePos + node.nodeSize }\n }\n\n const topLevelPos = resolved.before(1)\n const node = resolved.node(1)\n\n return { from: topLevelPos, to: topLevelPos + node.nodeSize }\n}\n\n/**\n * Converts an absolute document range to content-relative positions used by\n * `Node#nodesBetween` and `Node#forEach` offsets.\n */\nexport function toContentRelativeRange(\n doc: Node,\n range: { from: number; to: number },\n): { from: number; to: number } {\n return {\n from: Math.max(0, range.from - 1),\n to: Math.min(doc.content.size, range.to - 1),\n }\n}\n\n/**\n * Returns the top-level block ranges that intersect a document change range.\n * Input `from`/`to` are absolute positions (e.g. from `getChangedRanges`).\n * Returned ranges are content-relative, matching `Node#forEach` offsets.\n */\nexport function getTopLevelBlocksInRange(\n doc: Node,\n from: number,\n to: number,\n): Array<{ from: number; to: number }> {\n const ranges: Array<{ from: number; to: number }> = []\n\n doc.forEach((node, offset) => {\n const nodeStart = offset\n const nodeEnd = nodeStart + node.nodeSize\n const absNodeStart = nodeStart + 1\n const absNodeEnd = nodeEnd + 1\n\n if (absNodeStart < to && absNodeEnd > from) {\n ranges.push({ from: nodeStart, to: nodeEnd })\n }\n })\n\n return ranges\n}\n\n/**\n * Sorts ranges by start position and merges overlapping or adjacent ranges.\n */\nexport function mergeRanges(\n ranges: Array<{ from: number; to: number }>,\n): Array<{ from: number; to: number }> {\n if (ranges.length === 0) {\n return []\n }\n\n const sorted = [...ranges].sort((a, b) => a.from - b.from)\n const merged: Array<{ from: number; to: number }> = [{ ...sorted[0] }]\n\n for (let i = 1; i < sorted.length; i += 1) {\n const last = merged[merged.length - 1]\n const current = sorted[i]\n\n if (current.from <= last.to) {\n last.to = Math.max(last.to, current.to)\n } else {\n merged.push({ ...current })\n }\n }\n\n return merged\n}\n","import type { Editor } from '@tiptap/core'\nimport { getChangedRanges } from '@tiptap/core'\nimport type { Node } from '@tiptap/pm/model'\nimport type { EditorState, StateField, Transaction } from '@tiptap/pm/state'\nimport type { Selection } from '@tiptap/pm/state'\nimport { DecorationSet } from '@tiptap/pm/view'\n\nimport type { PlaceholderOptions } from '../types.js'\nimport {\n buildPlaceholderDecorations,\n scanRangeForDecorations,\n} from './buildPlaceholderDecorations.js'\nimport {\n getTopLevelBlocksInRange,\n mergeRanges,\n resolveTopLevelRange,\n toContentRelativeRange,\n} from './resolveTopLevelRange.js'\n\n/** Options passed to {@link createPlaceholderStateField}. */\nexport type CreatePlaceholderStateFieldOptions = {\n editor: Editor\n options: PlaceholderOptions\n dataAttribute: string\n}\n\n/**\n * Expands a single changed range to the top-level blocks it touches.\n * Also resolves blocks at range boundaries so split/merge edits update\n * adjacent empty nodes (e.g. a new paragraph after Enter).\n */\nfunction collectBlocksForChange(\n doc: Node,\n change: { from: number; to: number },\n): Array<{ from: number; to: number }> {\n const ranges = getTopLevelBlocksInRange(doc, change.from, change.to)\n\n ranges.push(toContentRelativeRange(doc, resolveTopLevelRange(doc, change.from)))\n\n if (change.to > change.from) {\n ranges.push(\n toContentRelativeRange(\n doc,\n resolveTopLevelRange(doc, Math.min(change.to, doc.content.size + 1) - 1),\n ),\n )\n } else if (change.from < doc.content.size + 1) {\n ranges.push(\n toContentRelativeRange(\n doc,\n resolveTopLevelRange(doc, Math.min(change.from + 1, doc.content.size)),\n ),\n )\n }\n\n return ranges\n}\n\n/**\n * Collects content-relative top-level block ranges that need placeholder\n * decorations recomputed after a transaction.\n */\nfunction collectRescanRanges(\n tr: Transaction,\n oldState: EditorState,\n newState: EditorState,\n): Array<{ from: number; to: number }> {\n const ranges: Array<{ from: number; to: number }> = []\n\n if (tr.docChanged) {\n const changes = getChangedRanges(tr)\n\n for (const change of changes) {\n ranges.push(...collectBlocksForChange(newState.doc, change.newRange))\n }\n }\n\n if (tr.selectionSet) {\n ranges.push(\n toContentRelativeRange(\n newState.doc,\n resolveTopLevelRange(newState.doc, tr.mapping.map(oldState.selection.anchor)),\n ),\n )\n ranges.push(\n toContentRelativeRange(\n newState.doc,\n resolveTopLevelRange(newState.doc, newState.selection.anchor),\n ),\n )\n }\n\n return mergeRanges(ranges)\n}\n\n/** Clamps a content-relative range to `[0, doc.content.size]`. */\nfunction clampRange(from: number, to: number, doc: Node): { from: number; to: number } {\n const clampedFrom = Math.max(0, Math.min(from, doc.content.size))\n const clampedTo = Math.max(clampedFrom, Math.min(to, doc.content.size))\n\n return { from: clampedFrom, to: clampedTo }\n}\n\n/**\n * Removes and rebuilds placeholder decorations within the given ranges.\n * Only drops decorations fully contained in a range so mapped decorations\n * on neighbouring blocks (e.g. at a block boundary) are kept intact.\n */\nfunction updateDecorationsInRanges({\n decorations,\n ranges,\n editor,\n options,\n dataAttribute,\n doc,\n selection,\n}: {\n decorations: DecorationSet\n ranges: Array<{ from: number; to: number }>\n editor: Editor\n options: PlaceholderOptions\n dataAttribute: string\n doc: Node\n selection: Selection\n}): DecorationSet {\n let next = decorations\n\n for (const range of ranges) {\n const { from, to } = clampRange(range.from, range.to, doc)\n const existing = next\n .find(from, to)\n .filter(decoration => decoration.from >= from && decoration.to <= to)\n\n if (existing.length) {\n next = next.remove(existing)\n }\n\n const newDecos = scanRangeForDecorations({\n editor,\n options,\n dataAttribute,\n doc,\n selection,\n from,\n to,\n })\n\n if (newDecos.length) {\n next = next.add(doc, newDecos)\n }\n }\n\n return next\n}\n\n/**\n * Creates the incremental `StateField<DecorationSet>` used by the slow path\n * (`showOnlyCurrent: false` or `includeChildren: true`).\n *\n * Decorations are mapped through each transaction and only recomputed for\n * top-level blocks touched by document or selection changes.\n * @param options.editor - The editor instance.\n * @param options.options - The resolved placeholder options.\n * @param options.dataAttribute - The prepared `data-*` attribute name.\n * @returns A ProseMirror state field storing the placeholder decoration set.\n */\nexport function createPlaceholderStateField({\n editor,\n options,\n dataAttribute,\n}: CreatePlaceholderStateFieldOptions): StateField<DecorationSet> {\n return {\n init(_config, state: EditorState) {\n const decorations = buildPlaceholderDecorations({\n editor,\n options,\n dataAttribute,\n doc: state.doc,\n selection: state.selection,\n })\n\n return decorations ?? DecorationSet.empty\n },\n\n apply(tr: Transaction, prev: DecorationSet, oldState: EditorState, newState: EditorState) {\n if (!tr.docChanged && !tr.selectionSet) {\n return prev\n }\n\n const mapped = prev.map(tr.mapping, tr.doc)\n const ranges = collectRescanRanges(tr, oldState, newState)\n\n return updateDecorationsInRanges({\n decorations: mapped,\n ranges,\n editor,\n options,\n dataAttribute,\n doc: newState.doc,\n selection: newState.selection,\n })\n },\n }\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","import type { Editor } from '@tiptap/core'\nimport { Plugin } from '@tiptap/pm/state'\nimport { DecorationSet } from '@tiptap/pm/view'\n\nimport { DEFAULT_DATA_ATTRIBUTE, PLUGIN_KEY } from '../constants.js'\nimport type { PlaceholderOptions } from '../types.js'\nimport { buildPlaceholderDecorations } from '../utils/buildPlaceholderDecorations.js'\nimport { createPlaceholderStateField } from '../utils/placeholderStateField.js'\nimport { preparePlaceholderAttribute } from '../utils/preparePlaceholderAttribute.js'\n\nexport type CreatePluginOptions = {\n editor: Editor\n options: PlaceholderOptions\n}\n\n/**\n * Creates the ProseMirror plugin that renders placeholder decorations.\n * @param options.editor - The editor instance.\n * @param options.options - The resolved placeholder options.\n * @returns The configured placeholder plugin.\n */\nexport function createPlaceholderPlugin({ editor, options }: CreatePluginOptions) {\n const dataAttribute = options.dataAttribute\n ? `data-${preparePlaceholderAttribute(options.dataAttribute)}`\n : `data-${DEFAULT_DATA_ATTRIBUTE}`\n\n const useResolvedPath = options.showOnlyCurrent && !options.includeChildren\n\n return new Plugin({\n key: PLUGIN_KEY,\n ...(useResolvedPath\n ? {}\n : {\n state: createPlaceholderStateField({ editor, options, dataAttribute }),\n }),\n props: {\n decorations: useResolvedPath\n ? ({ doc, selection }) =>\n buildPlaceholderDecorations({ editor, options, dataAttribute, doc, selection })\n : state => {\n if (options.showOnlyWhenEditable && !editor.isEditable) {\n return DecorationSet.empty\n }\n\n return PLUGIN_KEY.getState(state) ?? DecorationSet.empty\n },\n },\n })\n}\n","import { Extension } from '@tiptap/core'\n\nimport { DEFAULT_DATA_ATTRIBUTE } from './constants.js'\nimport { createPlaceholderPlugin } from './plugins/PlaceholderPlugin.js'\nimport type { PlaceholderOptions } from './types.js'\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 return [createPlaceholderPlugin({ editor: this.editor, options: this.options })]\n },\n})\n"],"mappings":";;;;;;AAIA,MAAa,yBAAyB;;AAGtC,MAAa,aAAa,IAAIA,iBAAAA,UAAyB,qBAAqB;;;;;;;;;;;;;;;;ACY5E,SAAgB,4BAA4B,SAYzC;CACD,MAAM,EACJ,QACA,aACA,eACA,KACA,MACA,YACA,WACA,SAAS,EAAE,WAAW,kBACpB;CACJ,MAAM,UAAU,CAAC,SAAS;CAE1B,IAAI,YACF,QAAQ,KAAK,WAAW;CAG1B,OAAOC,gBAAAA,WAAW,KAAK,KAAK,MAAM,KAAK,UAAU;EAC/C,OAAO,QAAQ,KAAK,GAAG;GACtB,gBACC,OAAO,gBAAgB,aACnB,YAAY;GACV;GACA;GACA;GACA;EACF,CAAC,IACD;CACR,CAAC;AACH;;;AClDA,SAAS,sBACP,gBACA,OACQ;CACR,OAAO,OAAO,mBAAmB,aAAa,eAAe,KAAK,IAAI;AACxE;;;;;AAMA,SAAgB,wBAAwB,EACtC,QACA,SACA,eACA,KACA,WACA,MACA,MASe;CACf,MAAM,EAAE,WAAW;CACnB,MAAM,cAA4B,CAAC;CACnC,MAAM,aAAa,OAAO;CAE1B,IAAI,aAAa,MAAM,KAAK,MAAM,QAAQ;EACxC,MAAM,YAAY,UAAU,OAAO,UAAU,MAAM,KAAK;EACxD,MAAM,UAAU,CAAC,KAAK,WAAA,GAAA,aAAA,YAAA,CAAsB,IAAI;EAEhD,IAAI,CAAC,KAAK,KAAK,aACb,OAAO,QAAQ;EAGjB,KAAK,aAAa,CAAC,QAAQ,oBAAoB,SAC7C,YAAY,KACV,4BAA4B;GAC1B;GACA;GACA;GACA;GACA,aAAa,QAAQ;GACrB,SAAS;IACP,aAAa,QAAQ;IACrB,WAAW,sBAAsB,QAAQ,gBAAgB;KACvD;KACA;KACA;KACA;IACF,CAAC;GACH;GACA;GACA;EACF,CAAC,CACH;EAGF,OAAO,QAAQ;CACjB,CAAC;CAED,OAAO;AACT;;;;;;;;;;AAWA,SAAgB,4BAA4B,EAC1C,QACA,SACA,eACA,KACA,aAOuB;CAGvB,IAAI,EAFW,OAAO,cAAc,CAAC,QAAQ,uBAG3C,OAAO;CAGT,MAAM,EAAE,WAAW;CACnB,MAAM,cAA4B,CAAC;CACnC,MAAM,aAAa,OAAO;CAI1B,IAFwB,QAAQ,mBAAmB,CAAC,QAAQ,iBAEvC;EACnB,MAAM,WAAW,IAAI,QAAQ,MAAM;EAOnC,MAAM,OAAO,SAAS,QAAQ,IAAI,SAAS,KAAK,CAAC,IAAI,SAAS;EAC9D,MAAM,YAAY,SAAS,QAAQ,IAAI,SAAS,OAAO,CAAC,IAAI;EAE5D,IAAI,QAAQ,KAAK,KAAK,gBAAA,GAAA,aAAA,YAAA,CAA2B,IAAI,GAAG;GACtD,MAAM,YAAY,UAAU,aAAa,UAAU,YAAY,KAAK;GAEpE,YAAY,KACV,4BAA4B;IAC1B;IACA;IACA;IACA;IACA,aAAa,QAAQ;IACrB,SAAS;KACP,aAAa,QAAQ;KACrB,WAAW,sBAAsB,QAAQ,gBAAgB;MACvD;MACA;MACA,KAAK;MACL;KACF,CAAC;IACH;IACA;IACA,KAAK;GACP,CAAC,CACH;EACF;CACF,OACE,YAAY,KACV,GAAG,wBAAwB;EACzB;EACA;EACA;EACA;EACA;EACA,MAAM;EACN,IAAI,IAAI,QAAQ;CAClB,CAAC,CACH;CAGF,OAAOC,gBAAAA,cAAc,OAAO,KAAK,WAAW;AAC9C;;;;;;;AC7JA,SAAgB,qBAAqB,KAAW,KAA2C;CACzF,MAAM,WAAW,IAAI,QAAQ,GAAG;CAEhC,IAAI,SAAS,UAAU,GAAG;;EACxB,MAAM,QAAA,sBAAO,SAAS,eAAA,QAAA,wBAAA,KAAA,IAAA,sBAAa,SAAS;EAE5C,IAAI,CAAC,MACH,OAAO;GAAE,MAAM;GAAK,IAAI;EAAI;EAG9B,MAAM,UAAU,SAAS,YAAY,MAAM,MAAM,KAAK;EAEtD,OAAO;GAAE,MAAM;GAAS,IAAI,UAAU,KAAK;EAAS;CACtD;CAEA,MAAM,cAAc,SAAS,OAAO,CAAC;CAGrC,OAAO;EAAE,MAAM;EAAa,IAAI,cAFnB,SAAS,KAAK,CAEsB,CAAC,CAAC;CAAS;AAC9D;;;;;AAMA,SAAgB,uBACd,KACA,OAC8B;CAC9B,OAAO;EACL,MAAM,KAAK,IAAI,GAAG,MAAM,OAAO,CAAC;EAChC,IAAI,KAAK,IAAI,IAAI,QAAQ,MAAM,MAAM,KAAK,CAAC;CAC7C;AACF;;;;;;AAOA,SAAgB,yBACd,KACA,MACA,IACqC;CACrC,MAAM,SAA8C,CAAC;CAErD,IAAI,SAAS,MAAM,WAAW;EAC5B,MAAM,YAAY;EAClB,MAAM,UAAU,YAAY,KAAK;EACjC,MAAM,eAAe,YAAY;EACjC,MAAM,aAAa,UAAU;EAE7B,IAAI,eAAe,MAAM,aAAa,MACpC,OAAO,KAAK;GAAE,MAAM;GAAW,IAAI;EAAQ,CAAC;CAEhD,CAAC;CAED,OAAO;AACT;;;;AAKA,SAAgB,YACd,QACqC;CACrC,IAAI,OAAO,WAAW,GACpB,OAAO,CAAC;CAGV,MAAM,SAAS,CAAC,GAAG,MAAM,CAAC,CAAC,MAAM,GAAG,MAAM,EAAE,OAAO,EAAE,IAAI;CACzD,MAAM,SAA8C,CAAC,EAAE,GAAG,OAAO,GAAG,CAAC;CAErE,KAAK,IAAI,IAAI,GAAG,IAAI,OAAO,QAAQ,KAAK,GAAG;EACzC,MAAM,OAAO,OAAO,OAAO,SAAS;EACpC,MAAM,UAAU,OAAO;EAEvB,IAAI,QAAQ,QAAQ,KAAK,IACvB,KAAK,KAAK,KAAK,IAAI,KAAK,IAAI,QAAQ,EAAE;OAEtC,OAAO,KAAK,EAAE,GAAG,QAAQ,CAAC;CAE9B;CAEA,OAAO;AACT;;;;;;;;AC7DA,SAAS,uBACP,KACA,QACqC;CACrC,MAAM,SAAS,yBAAyB,KAAK,OAAO,MAAM,OAAO,EAAE;CAEnE,OAAO,KAAK,uBAAuB,KAAK,qBAAqB,KAAK,OAAO,IAAI,CAAC,CAAC;CAE/E,IAAI,OAAO,KAAK,OAAO,MACrB,OAAO,KACL,uBACE,KACA,qBAAqB,KAAK,KAAK,IAAI,OAAO,IAAI,IAAI,QAAQ,OAAO,CAAC,IAAI,CAAC,CACzE,CACF;MACK,IAAI,OAAO,OAAO,IAAI,QAAQ,OAAO,GAC1C,OAAO,KACL,uBACE,KACA,qBAAqB,KAAK,KAAK,IAAI,OAAO,OAAO,GAAG,IAAI,QAAQ,IAAI,CAAC,CACvE,CACF;CAGF,OAAO;AACT;;;;;AAMA,SAAS,oBACP,IACA,UACA,UACqC;CACrC,MAAM,SAA8C,CAAC;CAErD,IAAI,GAAG,YAAY;EACjB,MAAM,WAAA,GAAA,aAAA,iBAAA,CAA2B,EAAE;EAEnC,KAAK,MAAM,UAAU,SACnB,OAAO,KAAK,GAAG,uBAAuB,SAAS,KAAK,OAAO,QAAQ,CAAC;CAExE;CAEA,IAAI,GAAG,cAAc;EACnB,OAAO,KACL,uBACE,SAAS,KACT,qBAAqB,SAAS,KAAK,GAAG,QAAQ,IAAI,SAAS,UAAU,MAAM,CAAC,CAC9E,CACF;EACA,OAAO,KACL,uBACE,SAAS,KACT,qBAAqB,SAAS,KAAK,SAAS,UAAU,MAAM,CAC9D,CACF;CACF;CAEA,OAAO,YAAY,MAAM;AAC3B;;AAGA,SAAS,WAAW,MAAc,IAAY,KAAyC;CACrF,MAAM,cAAc,KAAK,IAAI,GAAG,KAAK,IAAI,MAAM,IAAI,QAAQ,IAAI,CAAC;CAGhE,OAAO;EAAE,MAAM;EAAa,IAFV,KAAK,IAAI,aAAa,KAAK,IAAI,IAAI,IAAI,QAAQ,IAAI,CAE7B;CAAE;AAC5C;;;;;;AAOA,SAAS,0BAA0B,EACjC,aACA,QACA,QACA,SACA,eACA,KACA,aASgB;CAChB,IAAI,OAAO;CAEX,KAAK,MAAM,SAAS,QAAQ;EAC1B,MAAM,EAAE,MAAM,OAAO,WAAW,MAAM,MAAM,MAAM,IAAI,GAAG;EACzD,MAAM,WAAW,KACd,KAAK,MAAM,EAAE,CAAC,CACd,QAAO,eAAc,WAAW,QAAQ,QAAQ,WAAW,MAAM,EAAE;EAEtE,IAAI,SAAS,QACX,OAAO,KAAK,OAAO,QAAQ;EAG7B,MAAM,WAAW,wBAAwB;GACvC;GACA;GACA;GACA;GACA;GACA;GACA;EACF,CAAC;EAED,IAAI,SAAS,QACX,OAAO,KAAK,IAAI,KAAK,QAAQ;CAEjC;CAEA,OAAO;AACT;;;;;;;;;;;;AAaA,SAAgB,4BAA4B,EAC1C,QACA,SACA,iBACgE;CAChE,OAAO;EACL,KAAK,SAAS,OAAoB;GAChC,MAAM,cAAc,4BAA4B;IAC9C;IACA;IACA;IACA,KAAK,MAAM;IACX,WAAW,MAAM;GACnB,CAAC;GAED,OAAO,gBAAA,QAAA,gBAAA,KAAA,IAAA,cAAeC,gBAAAA,cAAc;EACtC;EAEA,MAAM,IAAiB,MAAqB,UAAuB,UAAuB;GACxF,IAAI,CAAC,GAAG,cAAc,CAAC,GAAG,cACxB,OAAO;GAMT,OAAO,0BAA0B;IAC/B,aAJa,KAAK,IAAI,GAAG,SAAS,GAAG,GAInB;IAClB,QAJa,oBAAoB,IAAI,UAAU,QAI1C;IACL;IACA;IACA;IACA,KAAK,SAAS;IACd,WAAW,SAAS;GACtB,CAAC;EACH;CACF;AACF;;;;;;;;ACtMA,SAAgB,4BAA4B,MAAsB;CAChE,OACE,KAEG,QAAQ,QAAQ,GAAG,CAAC,CAIpB,QAAQ,kBAAkB,EAAE,CAAC,CAE7B,QAAQ,YAAY,EAAE,CAAC,CAEvB,QAAQ,OAAO,EAAE,CAAC,CAClB,YAAY;AAEnB;;;;;;;;;ACCA,SAAgB,wBAAwB,EAAE,QAAQ,WAAgC;CAChF,MAAM,gBAAgB,QAAQ,gBAC1B,QAAQ,4BAA4B,QAAQ,aAAa,MACzD,QAAQ;CAEZ,MAAM,kBAAkB,QAAQ,mBAAmB,CAAC,QAAQ;CAE5D,OAAO,IAAIC,iBAAAA,OAAO;EAChB,KAAK;EACL,GAAI,kBACA,CAAC,IACD,EACE,OAAO,4BAA4B;GAAE;GAAQ;GAAS;EAAc,CAAC,EACvE;EACJ,OAAO,EACL,aAAa,mBACR,EAAE,KAAK,gBACN,4BAA4B;GAAE;GAAQ;GAAS;GAAe;GAAK;EAAU,CAAC,KAChF,UAAS;;GACP,IAAI,QAAQ,wBAAwB,CAAC,OAAO,YAC1C,OAAOC,gBAAAA,cAAc;GAGvB,QAAA,uBAAO,WAAW,SAAS,KAAK,OAAA,QAAA,yBAAA,KAAA,IAAA,uBAAKA,gBAAAA,cAAc;EACrD,EACN;CACF,CAAC;AACH;;;;;;;;ACrCA,MAAa,cAAcC,aAAAA,UAAU,OAA2B;CAC9D,MAAM;CAEN,aAAa;EACX,OAAO;GACL,kBAAkB;GAClB,gBAAgB;GAChB,eAAe;GACf,aAAa;GACb,sBAAsB;GACtB,iBAAiB;GACjB,iBAAiB;EACnB;CACF;CAEA,wBAAwB;EACtB,OAAO,CAAC,wBAAwB;GAAE,QAAQ,KAAK;GAAQ,SAAS,KAAK;EAAQ,CAAC,CAAC;CACjF;AACF,CAAC"}
|
|
@@ -1,87 +1,91 @@
|
|
|
1
|
-
import { PluginKey } from
|
|
2
|
-
import { DecorationSet } from
|
|
3
|
-
import { Editor, Extension } from
|
|
4
|
-
import { Node } from
|
|
5
|
-
|
|
1
|
+
import { PluginKey } from "@tiptap/pm/state";
|
|
2
|
+
import { DecorationSet } from "@tiptap/pm/view";
|
|
3
|
+
import { Editor, Extension } from "@tiptap/core";
|
|
4
|
+
import { Node } from "@tiptap/pm/model";
|
|
5
|
+
//#region src/placeholder/constants.d.ts
|
|
6
6
|
/** The default data attribute label */
|
|
7
7
|
declare const DEFAULT_DATA_ATTRIBUTE = "placeholder";
|
|
8
8
|
/** The plugin key used to store and read the placeholder decoration set */
|
|
9
9
|
declare const PLUGIN_KEY: PluginKey<DecorationSet>;
|
|
10
|
-
|
|
10
|
+
//#endregion
|
|
11
|
+
//#region src/placeholder/types.d.ts
|
|
11
12
|
interface PlaceholderOptions {
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
13
|
+
/**
|
|
14
|
+
* **The class name for the empty editor**
|
|
15
|
+
* @default 'is-editor-empty'
|
|
16
|
+
*/
|
|
17
|
+
emptyEditorClass: string;
|
|
18
|
+
/**
|
|
19
|
+
* **The class name for empty nodes**
|
|
20
|
+
*
|
|
21
|
+
* You can use a function to return a dynamic class name or a string.
|
|
22
|
+
* @default 'is-empty'
|
|
23
|
+
*/
|
|
24
|
+
emptyNodeClass: ((EmptyNodeClassProps: {
|
|
25
|
+
editor: Editor;
|
|
26
|
+
node: Node;
|
|
27
|
+
pos: number;
|
|
28
|
+
hasAnchor: boolean;
|
|
29
|
+
}) => string) | string;
|
|
30
|
+
/**
|
|
31
|
+
* **The data-attribute used for the placeholder label**
|
|
32
|
+
* Will be prepended with `data-` and converted to kebab-case and cleaned of special characters.
|
|
33
|
+
* @default 'placeholder'
|
|
34
|
+
*/
|
|
35
|
+
dataAttribute: string;
|
|
36
|
+
/**
|
|
37
|
+
* **The placeholder content**
|
|
38
|
+
*
|
|
39
|
+
* You can use a function to return a dynamic placeholder or a string.
|
|
40
|
+
* @default 'Write something …'
|
|
41
|
+
*/
|
|
42
|
+
placeholder: ((PlaceholderProps: {
|
|
43
|
+
editor: Editor;
|
|
44
|
+
node: Node;
|
|
45
|
+
pos: number;
|
|
46
|
+
hasAnchor: boolean;
|
|
47
|
+
}) => string) | string;
|
|
48
|
+
/**
|
|
49
|
+
* **Checks if the placeholder should be only shown when the editor is editable.**
|
|
50
|
+
*
|
|
51
|
+
* If true, the placeholder will only be shown when the editor is editable.
|
|
52
|
+
* If false, the placeholder will always be shown.
|
|
53
|
+
* @default true
|
|
54
|
+
*/
|
|
55
|
+
showOnlyWhenEditable: boolean;
|
|
56
|
+
/**
|
|
57
|
+
* **Checks if the placeholder should be only shown when the current node is empty.**
|
|
58
|
+
*
|
|
59
|
+
* If true, the placeholder will only be shown when the current node is empty.
|
|
60
|
+
* If false, the placeholder will be shown when any node is empty.
|
|
61
|
+
* @default true
|
|
62
|
+
*/
|
|
63
|
+
showOnlyCurrent: boolean;
|
|
64
|
+
/**
|
|
65
|
+
* **Controls if the placeholder should be shown for all descendants.**
|
|
66
|
+
*
|
|
67
|
+
* If true, the placeholder will be shown for all descendants.
|
|
68
|
+
* If false, the placeholder will only be shown for the current node.
|
|
69
|
+
* @default false
|
|
70
|
+
*/
|
|
71
|
+
includeChildren: boolean;
|
|
71
72
|
}
|
|
72
|
-
|
|
73
|
+
//#endregion
|
|
74
|
+
//#region src/placeholder/placeholder.d.ts
|
|
73
75
|
/**
|
|
74
76
|
* This extension allows you to add a placeholder to your editor.
|
|
75
77
|
* A placeholder is a text that appears when the editor or a node is empty.
|
|
76
78
|
* @see https://www.tiptap.dev/api/extensions/placeholder
|
|
77
79
|
*/
|
|
78
80
|
declare const Placeholder: Extension<PlaceholderOptions, any>;
|
|
79
|
-
|
|
81
|
+
//#endregion
|
|
82
|
+
//#region src/placeholder/utils/preparePlaceholderAttribute.d.ts
|
|
80
83
|
/**
|
|
81
84
|
* Prepares the placeholder attribute by ensuring it is properly formatted.
|
|
82
85
|
* @param attr - The placeholder attribute string.
|
|
83
86
|
* @returns The prepared placeholder attribute string.
|
|
84
87
|
*/
|
|
85
88
|
declare function preparePlaceholderAttribute(attr: string): string;
|
|
86
|
-
|
|
87
|
-
export { DEFAULT_DATA_ATTRIBUTE, PLUGIN_KEY, Placeholder,
|
|
89
|
+
//#endregion
|
|
90
|
+
export { DEFAULT_DATA_ATTRIBUTE, PLUGIN_KEY, Placeholder, PlaceholderOptions, preparePlaceholderAttribute };
|
|
91
|
+
//# sourceMappingURL=index.d.cts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.cts","names":[],"sources":["../../src/placeholder/constants.ts","../../src/placeholder/types.ts","../../src/placeholder/placeholder.ts","../../src/placeholder/utils/preparePlaceholderAttribute.ts"],"mappings":";;;;;;cAIa;;cAGA,YAAU,UAAA;;;UCJN;;;;;EAKf;;;;;;;EAQA,kBACM;IACA,QAAQ;IACR,MAAM;IACN;IACA;;;;;;;EASN;;;;;;;EAQA,eACM;IACA,QAAQ;IACR,MAAM;IACN;IACA;;;;;;;;;EAWN;;;;;;;;EASA;;;;;;;;EASA;;;;;;;;;cC7DW,aAAW,UAAA;;;;;;;;iBCNR,4BAA4B"}
|
|
@@ -1,87 +1,91 @@
|
|
|
1
|
-
import { PluginKey } from
|
|
2
|
-
import {
|
|
3
|
-
import {
|
|
4
|
-
import { Node } from
|
|
5
|
-
|
|
1
|
+
import { PluginKey } from "@tiptap/pm/state";
|
|
2
|
+
import { Editor, Extension } from "@tiptap/core";
|
|
3
|
+
import { DecorationSet } from "@tiptap/pm/view";
|
|
4
|
+
import { Node } from "@tiptap/pm/model";
|
|
5
|
+
//#region src/placeholder/constants.d.ts
|
|
6
6
|
/** The default data attribute label */
|
|
7
7
|
declare const DEFAULT_DATA_ATTRIBUTE = "placeholder";
|
|
8
8
|
/** The plugin key used to store and read the placeholder decoration set */
|
|
9
9
|
declare const PLUGIN_KEY: PluginKey<DecorationSet>;
|
|
10
|
-
|
|
10
|
+
//#endregion
|
|
11
|
+
//#region src/placeholder/types.d.ts
|
|
11
12
|
interface PlaceholderOptions {
|
|
12
|
-
|
|
13
|
-
|
|
14
|
-
|
|
15
|
-
|
|
16
|
-
|
|
17
|
-
|
|
18
|
-
|
|
19
|
-
|
|
20
|
-
|
|
21
|
-
|
|
22
|
-
|
|
23
|
-
|
|
24
|
-
|
|
25
|
-
|
|
26
|
-
|
|
27
|
-
|
|
28
|
-
|
|
29
|
-
|
|
30
|
-
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
|
|
41
|
-
|
|
42
|
-
|
|
43
|
-
|
|
44
|
-
|
|
45
|
-
|
|
46
|
-
|
|
47
|
-
|
|
48
|
-
|
|
49
|
-
|
|
50
|
-
|
|
51
|
-
|
|
52
|
-
|
|
53
|
-
|
|
54
|
-
|
|
55
|
-
|
|
56
|
-
|
|
57
|
-
|
|
58
|
-
|
|
59
|
-
|
|
60
|
-
|
|
61
|
-
|
|
62
|
-
|
|
63
|
-
|
|
64
|
-
|
|
65
|
-
|
|
66
|
-
|
|
67
|
-
|
|
68
|
-
|
|
69
|
-
|
|
70
|
-
|
|
13
|
+
/**
|
|
14
|
+
* **The class name for the empty editor**
|
|
15
|
+
* @default 'is-editor-empty'
|
|
16
|
+
*/
|
|
17
|
+
emptyEditorClass: string;
|
|
18
|
+
/**
|
|
19
|
+
* **The class name for empty nodes**
|
|
20
|
+
*
|
|
21
|
+
* You can use a function to return a dynamic class name or a string.
|
|
22
|
+
* @default 'is-empty'
|
|
23
|
+
*/
|
|
24
|
+
emptyNodeClass: ((EmptyNodeClassProps: {
|
|
25
|
+
editor: Editor;
|
|
26
|
+
node: Node;
|
|
27
|
+
pos: number;
|
|
28
|
+
hasAnchor: boolean;
|
|
29
|
+
}) => string) | string;
|
|
30
|
+
/**
|
|
31
|
+
* **The data-attribute used for the placeholder label**
|
|
32
|
+
* Will be prepended with `data-` and converted to kebab-case and cleaned of special characters.
|
|
33
|
+
* @default 'placeholder'
|
|
34
|
+
*/
|
|
35
|
+
dataAttribute: string;
|
|
36
|
+
/**
|
|
37
|
+
* **The placeholder content**
|
|
38
|
+
*
|
|
39
|
+
* You can use a function to return a dynamic placeholder or a string.
|
|
40
|
+
* @default 'Write something …'
|
|
41
|
+
*/
|
|
42
|
+
placeholder: ((PlaceholderProps: {
|
|
43
|
+
editor: Editor;
|
|
44
|
+
node: Node;
|
|
45
|
+
pos: number;
|
|
46
|
+
hasAnchor: boolean;
|
|
47
|
+
}) => string) | string;
|
|
48
|
+
/**
|
|
49
|
+
* **Checks if the placeholder should be only shown when the editor is editable.**
|
|
50
|
+
*
|
|
51
|
+
* If true, the placeholder will only be shown when the editor is editable.
|
|
52
|
+
* If false, the placeholder will always be shown.
|
|
53
|
+
* @default true
|
|
54
|
+
*/
|
|
55
|
+
showOnlyWhenEditable: boolean;
|
|
56
|
+
/**
|
|
57
|
+
* **Checks if the placeholder should be only shown when the current node is empty.**
|
|
58
|
+
*
|
|
59
|
+
* If true, the placeholder will only be shown when the current node is empty.
|
|
60
|
+
* If false, the placeholder will be shown when any node is empty.
|
|
61
|
+
* @default true
|
|
62
|
+
*/
|
|
63
|
+
showOnlyCurrent: boolean;
|
|
64
|
+
/**
|
|
65
|
+
* **Controls if the placeholder should be shown for all descendants.**
|
|
66
|
+
*
|
|
67
|
+
* If true, the placeholder will be shown for all descendants.
|
|
68
|
+
* If false, the placeholder will only be shown for the current node.
|
|
69
|
+
* @default false
|
|
70
|
+
*/
|
|
71
|
+
includeChildren: boolean;
|
|
71
72
|
}
|
|
72
|
-
|
|
73
|
+
//#endregion
|
|
74
|
+
//#region src/placeholder/placeholder.d.ts
|
|
73
75
|
/**
|
|
74
76
|
* This extension allows you to add a placeholder to your editor.
|
|
75
77
|
* A placeholder is a text that appears when the editor or a node is empty.
|
|
76
78
|
* @see https://www.tiptap.dev/api/extensions/placeholder
|
|
77
79
|
*/
|
|
78
80
|
declare const Placeholder: Extension<PlaceholderOptions, any>;
|
|
79
|
-
|
|
81
|
+
//#endregion
|
|
82
|
+
//#region src/placeholder/utils/preparePlaceholderAttribute.d.ts
|
|
80
83
|
/**
|
|
81
84
|
* Prepares the placeholder attribute by ensuring it is properly formatted.
|
|
82
85
|
* @param attr - The placeholder attribute string.
|
|
83
86
|
* @returns The prepared placeholder attribute string.
|
|
84
87
|
*/
|
|
85
88
|
declare function preparePlaceholderAttribute(attr: string): string;
|
|
86
|
-
|
|
87
|
-
export { DEFAULT_DATA_ATTRIBUTE, PLUGIN_KEY, Placeholder,
|
|
89
|
+
//#endregion
|
|
90
|
+
export { DEFAULT_DATA_ATTRIBUTE, PLUGIN_KEY, Placeholder, PlaceholderOptions, preparePlaceholderAttribute };
|
|
91
|
+
//# sourceMappingURL=index.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"index.d.ts","names":[],"sources":["../../src/placeholder/constants.ts","../../src/placeholder/types.ts","../../src/placeholder/placeholder.ts","../../src/placeholder/utils/preparePlaceholderAttribute.ts"],"mappings":";;;;;;cAIa;;cAGA,YAAU,UAAA;;;UCJN;;;;;EAKf;;;;;;;EAQA,kBACM;IACA,QAAQ;IACR,MAAM;IACN;IACA;;;;;;;EASN;;;;;;;EAQA,eACM;IACA,QAAQ;IACR,MAAM;IACN;IACA;;;;;;;;;EAWN;;;;;;;;EASA;;;;;;;;EASA;;;;;;;;;cC7DW,aAAW,UAAA;;;;;;;;iBCNR,4BAA4B"}
|