@tiptap/extension-details 2.24.2 → 3.0.0-beta.11

package/dist/index.js

@@ -1,381 +1,361 @@
-import { findParentNode, findChildren, Node, mergeAttributes, defaultBlockAt, isActive } from '@tiptap/core';
-import { Selection, Plugin, PluginKey, TextSelection } from '@tiptap/pm/state';
-import { GapCursor } from '@tiptap/pm/gapcursor';
+// src/details.ts
+import { defaultBlockAt, findChildren as findChildren2, findParentNode as findParentNode2, isActive, mergeAttributes, Node } from "@tiptap/core";
+import { Plugin, PluginKey, Selection, TextSelection } from "@tiptap/pm/state";
 
-const isNodeVisible = (position, editor) => {
-    const node = editor.view.domAtPos(position).node;
-    const isOpen = node.offsetParent !== null;
-    return isOpen;
+// src/helpers/isNodeVisible.ts
+var isNodeVisible = (position, editor) => {
+  const node = editor.view.domAtPos(position).node;
+  const isOpen = node.offsetParent !== null;
+  return isOpen;
 };
 
-const findClosestVisibleNode = ($pos, predicate, editor) => {
-    for (let i = $pos.depth; i > 0; i -= 1) {
-        const node = $pos.node(i);
-        const match = predicate(node);
-        const isVisible = isNodeVisible($pos.start(i), editor);
-        if (match && isVisible) {
-            return {
-                pos: i > 0 ? $pos.before(i) : 0,
-                start: $pos.start(i),
-                depth: i,
-                node,
-            };
-        }
+// src/helpers/findClosestVisibleNode.ts
+var findClosestVisibleNode = ($pos, predicate, editor) => {
+  for (let i = $pos.depth; i > 0; i -= 1) {
+    const node = $pos.node(i);
+    const match = predicate(node);
+    const isVisible = isNodeVisible($pos.start(i), editor);
+    if (match && isVisible) {
+      return {
+        pos: i > 0 ? $pos.before(i) : 0,
+        start: $pos.start(i),
+        depth: i,
+        node
+      };
     }
+  }
 };
 
-const setGapCursor = (editor, direction) => {
-    const { state, view, extensionManager } = editor;
-    const { schema, selection } = state;
-    const { empty, $anchor } = selection;
-    const hasGapCursorExtension = !!extensionManager.extensions.find(extension => extension.name === 'gapCursor');
-    if (!empty
-        || $anchor.parent.type !== schema.nodes.detailsSummary
-        || !hasGapCursorExtension) {
-        return false;
-    }
-    if (direction === 'right'
-        && $anchor.parentOffset !== ($anchor.parent.nodeSize - 2)) {
-        return false;
-    }
-    const details = findParentNode(node => node.type === schema.nodes.details)(selection);
-    if (!details) {
-        return false;
-    }
-    const detailsContent = findChildren(details.node, node => node.type === schema.nodes.detailsContent);
-    if (!detailsContent.length) {
-        return false;
-    }
-    const isOpen = isNodeVisible(details.start + detailsContent[0].pos + 1, editor);
-    if (isOpen) {
-        return false;
-    }
-    const $position = state.doc.resolve(details.pos + details.node.nodeSize);
-    const $validPosition = GapCursor.findFrom($position, 1, false);
-    if (!$validPosition) {
-        return false;
-    }
-    const { tr } = state;
-    const gapCursorSelection = new GapCursor($validPosition);
-    tr.setSelection(gapCursorSelection);
-    tr.scrollIntoView();
-    view.dispatch(tr);
-    return true;
+// src/helpers/setGapCursor.ts
+import { findChildren, findParentNode } from "@tiptap/core";
+import { GapCursor } from "@tiptap/pm/gapcursor";
+var setGapCursor = (editor, direction) => {
+  const { state, view, extensionManager } = editor;
+  const { schema, selection } = state;
+  const { empty, $anchor } = selection;
+  const hasGapCursorExtension = !!extensionManager.extensions.find((extension) => extension.name === "gapCursor");
+  if (!empty || $anchor.parent.type !== schema.nodes.detailsSummary || !hasGapCursorExtension) {
+    return false;
+  }
+  if (direction === "right" && $anchor.parentOffset !== $anchor.parent.nodeSize - 2) {
+    return false;
+  }
+  const details = findParentNode((node) => node.type === schema.nodes.details)(selection);
+  if (!details) {
+    return false;
+  }
+  const detailsContent = findChildren(details.node, (node) => node.type === schema.nodes.detailsContent);
+  if (!detailsContent.length) {
+    return false;
+  }
+  const isOpen = isNodeVisible(details.start + detailsContent[0].pos + 1, editor);
+  if (isOpen) {
+    return false;
+  }
+  const $position = state.doc.resolve(details.pos + details.node.nodeSize);
+  const $validPosition = GapCursor.findFrom($position, 1, false);
+  if (!$validPosition) {
+    return false;
+  }
+  const { tr } = state;
+  const gapCursorSelection = new GapCursor($validPosition);
+  tr.setSelection(gapCursorSelection);
+  tr.scrollIntoView();
+  view.dispatch(tr);
+  return true;
 };
 
-const Details = Node.create({
-    name: 'details',
-    content: 'detailsSummary detailsContent',
-    group: 'block',
-    defining: true,
-    isolating: true,
-    allowGapCursor: false,
-    addOptions() {
-        return {
-            persist: false,
-            openClassName: 'is-open',
-            HTMLAttributes: {},
-        };
-    },
-    addAttributes() {
+// src/details.ts
+var Details = Node.create({
+  name: "details",
+  content: "detailsSummary detailsContent",
+  group: "block",
+  defining: true,
+  isolating: true,
+  // @ts-ignore: allowGapCursor is not a valid option by default, dts on build doesnt pick this up
+  allowGapCursor: false,
+  addOptions() {
+    return {
+      persist: false,
+      openClassName: "is-open",
+      HTMLAttributes: {}
+    };
+  },
+  addAttributes() {
+    if (!this.options.persist) {
+      return [];
+    }
+    return {
+      open: {
+        default: false,
+        parseHTML: (element) => element.hasAttribute("open"),
+        renderHTML: ({ open }) => {
+          if (!open) {
+            return {};
+          }
+          return { open: "" };
+        }
+      }
+    };
+  },
+  parseHTML() {
+    return [
+      {
+        tag: "details"
+      }
+    ];
+  },
+  renderHTML({ HTMLAttributes }) {
+    return ["details", mergeAttributes(this.options.HTMLAttributes, HTMLAttributes), 0];
+  },
+  addNodeView() {
+    return ({ editor, getPos, node, HTMLAttributes }) => {
+      const dom = document.createElement("div");
+      const attributes = mergeAttributes(this.options.HTMLAttributes, HTMLAttributes, {
+        "data-type": this.name
+      });
+      Object.entries(attributes).forEach(([key, value]) => dom.setAttribute(key, value));
+      const toggle = document.createElement("button");
+      toggle.type = "button";
+      dom.append(toggle);
+      const content = document.createElement("div");
+      dom.append(content);
+      const toggleDetailsContent = (setToValue) => {
+        if (setToValue !== void 0) {
+          if (setToValue) {
+            if (dom.classList.contains(this.options.openClassName)) {
+              return;
+            }
+            dom.classList.add(this.options.openClassName);
+          } else {
+            if (!dom.classList.contains(this.options.openClassName)) {
+              return;
+            }
+            dom.classList.remove(this.options.openClassName);
+          }
+        } else {
+          dom.classList.toggle(this.options.openClassName);
+        }
+        const event = new Event("toggleDetailsContent");
+        const detailsContent = content.querySelector(':scope > div[data-type="detailsContent"]');
+        detailsContent == null ? void 0 : detailsContent.dispatchEvent(event);
+      };
+      if (node.attrs.open) {
+        setTimeout(() => toggleDetailsContent());
+      }
+      toggle.addEventListener("click", () => {
+        toggleDetailsContent();
         if (!this.options.persist) {
-            return [];
+          editor.commands.focus(void 0, { scrollIntoView: false });
+          return;
         }
-        return {
-            open: {
-                default: false,
-                parseHTML: element => element.hasAttribute('open'),
-                renderHTML: ({ open }) => {
-                    if (!open) {
-                        return {};
-                    }
-                    return { open: '' };
-                },
-            },
-        };
-    },
-    parseHTML() {
-        return [
-            {
-                tag: 'details',
-            },
-        ];
-    },
-    renderHTML({ HTMLAttributes }) {
-        return [
-            'details',
-            mergeAttributes(this.options.HTMLAttributes, HTMLAttributes),
-            0,
-        ];
-    },
-    addNodeView() {
-        return ({ editor, getPos, node, HTMLAttributes, }) => {
-            const dom = document.createElement('div');
-            const attributes = mergeAttributes(this.options.HTMLAttributes, HTMLAttributes, {
-                'data-type': this.name,
-            });
-            Object.entries(attributes).forEach(([key, value]) => dom.setAttribute(key, value));
-            const toggle = document.createElement('button');
-            toggle.type = 'button';
-            dom.append(toggle);
-            const content = document.createElement('div');
-            dom.append(content);
-            const toggleDetailsContent = (setToValue) => {
-                if (setToValue !== undefined) {
-                    if (setToValue) {
-                        if (dom.classList.contains(this.options.openClassName)) {
-                            return;
-                        }
-                        dom.classList.add(this.options.openClassName);
-                    }
-                    else {
-                        if (!dom.classList.contains(this.options.openClassName)) {
-                            return;
-                        }
-                        dom.classList.remove(this.options.openClassName);
-                    }
-                }
-                else {
-                    dom.classList.toggle(this.options.openClassName);
-                }
-                const event = new Event('toggleDetailsContent');
-                const detailsContent = content.querySelector(':scope > div[data-type="detailsContent"]');
-                detailsContent === null || detailsContent === void 0 ? void 0 : detailsContent.dispatchEvent(event);
-            };
-            if (node.attrs.open) {
-                setTimeout(() => toggleDetailsContent());
+        if (editor.isEditable && typeof getPos === "function") {
+          const { from, to } = editor.state.selection;
+          editor.chain().command(({ tr }) => {
+            const pos = getPos();
+            if (pos === void 0) {
+              return false;
+            }
+            const currentNode = tr.doc.nodeAt(pos);
+            if ((currentNode == null ? void 0 : currentNode.type) !== this.type) {
+              return false;
             }
-            toggle.addEventListener('click', () => {
-                toggleDetailsContent();
-                if (!this.options.persist) {
-                    editor.commands
-                        .focus(undefined, { scrollIntoView: false });
-                    return;
-                }
-                if (editor.isEditable && typeof getPos === 'function') {
-                    const { from, to } = editor.state.selection;
-                    editor
-                        .chain()
-                        .command(({ tr }) => {
-                        const pos = getPos();
-                        const currentNode = tr.doc.nodeAt(pos);
-                        if ((currentNode === null || currentNode === void 0 ? void 0 : currentNode.type) !== this.type) {
-                            return false;
-                        }
-                        tr.setNodeMarkup(pos, undefined, {
-                            open: !currentNode.attrs.open,
-                        });
-                        return true;
-                    })
-                        .setTextSelection({
-                        from,
-                        to,
-                    })
-                        .focus(undefined, { scrollIntoView: false })
-                        .run();
-                }
+            tr.setNodeMarkup(pos, void 0, {
+              open: !currentNode.attrs.open
             });
-            return {
-                dom,
-                contentDOM: content,
-                ignoreMutation(mutation) {
-                    if (mutation.type === 'selection') {
-                        return false;
-                    }
-                    return !dom.contains(mutation.target) || dom === mutation.target;
-                },
-                update: updatedNode => {
-                    if (updatedNode.type !== this.type) {
-                        return false;
-                    }
-                    // Only update the open state if set
-                    if (updatedNode.attrs.open !== undefined) {
-                        toggleDetailsContent(updatedNode.attrs.open);
-                    }
-                    return true;
-                },
-            };
-        };
-    },
-    addCommands() {
-        return {
-            setDetails: () => ({ state, chain }) => {
-                var _a;
-                const { schema, selection } = state;
-                const { $from, $to } = selection;
-                const range = $from.blockRange($to);
-                if (!range) {
-                    return false;
-                }
-                const slice = state.doc.slice(range.start, range.end);
-                const match = schema.nodes.detailsContent.contentMatch.matchFragment(slice.content);
-                if (!match) {
-                    return false;
-                }
-                const content = ((_a = slice.toJSON()) === null || _a === void 0 ? void 0 : _a.content) || [];
-                return chain()
-                    .insertContentAt({ from: range.start, to: range.end }, {
-                    type: this.name,
-                    content: [
-                        {
-                            type: 'detailsSummary',
-                        },
-                        {
-                            type: 'detailsContent',
-                            content,
-                        },
-                    ],
-                })
-                    .setTextSelection(range.start + 2)
-                    .run();
-            },
-            unsetDetails: () => ({ state, chain }) => {
-                const { selection, schema } = state;
-                const details = findParentNode(node => node.type === this.type)(selection);
-                if (!details) {
-                    return false;
-                }
-                const detailsSummaries = findChildren(details.node, node => node.type === schema.nodes.detailsSummary);
-                const detailsContents = findChildren(details.node, node => node.type === schema.nodes.detailsContent);
-                if (!detailsSummaries.length || !detailsContents.length) {
-                    return false;
-                }
-                const detailsSummary = detailsSummaries[0];
-                const detailsContent = detailsContents[0];
-                const from = details.pos;
-                const $from = state.doc.resolve(from);
-                const to = from + details.node.nodeSize;
-                const range = { from, to };
-                const content = detailsContent.node.content.toJSON() || [];
-                const defaultTypeForSummary = $from.parent.type.contentMatch.defaultType;
-                // TODO: this may break for some custom schemas
-                const summaryContent = defaultTypeForSummary === null || defaultTypeForSummary === void 0 ? void 0 : defaultTypeForSummary.create(null, detailsSummary.node.content).toJSON();
-                const mergedContent = [
-                    summaryContent,
-                    ...content,
-                ];
-                return chain()
-                    .insertContentAt(range, mergedContent)
-                    .setTextSelection(from + 1)
-                    .run();
-            },
-        };
-    },
-    addKeyboardShortcuts() {
-        return {
-            Backspace: () => {
-                const { schema, selection } = this.editor.state;
-                const { empty, $anchor } = selection;
-                if (!empty || $anchor.parent.type !== schema.nodes.detailsSummary) {
-                    return false;
-                }
-                // for some reason safari removes the whole text content within a `<summary>`tag on backspace
-                // so we have to remove the text manually
-                // see: https://discuss.prosemirror.net/t/safari-backspace-bug-with-details-tag/4223
-                if ($anchor.parentOffset !== 0) {
-                    return this.editor.commands.command(({ tr }) => {
-                        const from = $anchor.pos - 1;
-                        const to = $anchor.pos;
-                        tr.delete(from, to);
-                        return true;
-                    });
-                }
-                return this.editor.commands.unsetDetails();
-            },
-            // Creates a new node below it if it is closed.
-            // Otherwise inside `DetailsContent`.
-            Enter: ({ editor }) => {
-                const { state, view } = editor;
-                const { schema, selection } = state;
-                const { $head } = selection;
-                if ($head.parent.type !== schema.nodes.detailsSummary) {
-                    return false;
-                }
-                const isVisible = isNodeVisible($head.after() + 1, editor);
-                const above = isVisible
-                    ? state.doc.nodeAt($head.after())
-                    : $head.node(-2);
-                if (!above) {
-                    return false;
-                }
-                const after = isVisible
-                    ? 0
-                    : $head.indexAfter(-1);
-                const type = defaultBlockAt(above.contentMatchAt(after));
-                if (!type || !above.canReplaceWith(after, after, type)) {
-                    return false;
-                }
-                const node = type.createAndFill();
-                if (!node) {
-                    return false;
-                }
-                const pos = isVisible
-                    ? $head.after() + 1
-                    : $head.after(-1);
-                const tr = state.tr.replaceWith(pos, pos, node);
-                const $pos = tr.doc.resolve(pos);
-                const newSelection = Selection.near($pos, 1);
-                tr.setSelection(newSelection);
-                tr.scrollIntoView();
-                view.dispatch(tr);
-                return true;
-            },
-            // The default gapcursor implementation can’t handle hidden content, so we need to fix this.
-            ArrowRight: ({ editor }) => {
-                return setGapCursor(editor, 'right');
-            },
-            // The default gapcursor implementation can’t handle hidden content, so we need to fix this.
-            ArrowDown: ({ editor }) => {
-                return setGapCursor(editor, 'down');
-            },
-        };
-    },
-    addProseMirrorPlugins() {
-        return [
-            // This plugin prevents text selections within the hidden content in `DetailsContent`.
-            // The cursor is moved to the next visible position.
-            new Plugin({
-                key: new PluginKey('detailsSelection'),
-                appendTransaction: (transactions, oldState, newState) => {
-                    const { editor, type } = this;
-                    const selectionSet = transactions.some(transaction => transaction.selectionSet);
-                    if (!selectionSet
-                        || !oldState.selection.empty
-                        || !newState.selection.empty) {
-                        return;
-                    }
-                    const detailsIsActive = isActive(newState, type.name);
-                    if (!detailsIsActive) {
-                        return;
-                    }
-                    const { $from } = newState.selection;
-                    const isVisible = isNodeVisible($from.pos, editor);
-                    if (isVisible) {
-                        return;
-                    }
-                    const details = findClosestVisibleNode($from, node => node.type === type, editor);
-                    if (!details) {
-                        return;
-                    }
-                    const detailsSummaries = findChildren(details.node, node => node.type === newState.schema.nodes.detailsSummary);
-                    if (!detailsSummaries.length) {
-                        return;
-                    }
-                    const detailsSummary = detailsSummaries[0];
-                    const selectionDirection = oldState.selection.from < newState.selection.from
-                        ? 'forward'
-                        : 'backward';
-                    const correctedPosition = selectionDirection === 'forward'
-                        ? details.start + detailsSummary.pos
-                        : details.pos + detailsSummary.pos + detailsSummary.node.nodeSize;
-                    const selection = TextSelection.create(newState.doc, correctedPosition);
-                    const transaction = newState.tr.setSelection(selection);
-                    return transaction;
-                },
-            }),
-        ];
-    },
+            return true;
+          }).setTextSelection({
+            from,
+            to
+          }).focus(void 0, { scrollIntoView: false }).run();
+        }
+      });
+      return {
+        dom,
+        contentDOM: content,
+        ignoreMutation(mutation) {
+          if (mutation.type === "selection") {
+            return false;
+          }
+          return !dom.contains(mutation.target) || dom === mutation.target;
+        },
+        update: (updatedNode) => {
+          if (updatedNode.type !== this.type) {
+            return false;
+          }
+          if (updatedNode.attrs.open !== void 0) {
+            toggleDetailsContent(updatedNode.attrs.open);
+          }
+          return true;
+        }
+      };
+    };
+  },
+  addCommands() {
+    return {
+      setDetails: () => ({ state, chain }) => {
+        var _a;
+        const { schema, selection } = state;
+        const { $from, $to } = selection;
+        const range = $from.blockRange($to);
+        if (!range) {
+          return false;
+        }
+        const slice = state.doc.slice(range.start, range.end);
+        const match = schema.nodes.detailsContent.contentMatch.matchFragment(slice.content);
+        if (!match) {
+          return false;
+        }
+        const content = ((_a = slice.toJSON()) == null ? void 0 : _a.content) || [];
+        return chain().insertContentAt(
+          { from: range.start, to: range.end },
+          {
+            type: this.name,
+            content: [
+              {
+                type: "detailsSummary"
+              },
+              {
+                type: "detailsContent",
+                content
+              }
+            ]
+          }
+        ).setTextSelection(range.start + 2).run();
+      },
+      unsetDetails: () => ({ state, chain }) => {
+        const { selection, schema } = state;
+        const details = findParentNode2((node) => node.type === this.type)(selection);
+        if (!details) {
+          return false;
+        }
+        const detailsSummaries = findChildren2(details.node, (node) => node.type === schema.nodes.detailsSummary);
+        const detailsContents = findChildren2(details.node, (node) => node.type === schema.nodes.detailsContent);
+        if (!detailsSummaries.length || !detailsContents.length) {
+          return false;
+        }
+        const detailsSummary = detailsSummaries[0];
+        const detailsContent = detailsContents[0];
+        const from = details.pos;
+        const $from = state.doc.resolve(from);
+        const to = from + details.node.nodeSize;
+        const range = { from, to };
+        const content = detailsContent.node.content.toJSON() || [];
+        const defaultTypeForSummary = $from.parent.type.contentMatch.defaultType;
+        const summaryContent = defaultTypeForSummary == null ? void 0 : defaultTypeForSummary.create(null, detailsSummary.node.content).toJSON();
+        const mergedContent = [summaryContent, ...content];
+        return chain().insertContentAt(range, mergedContent).setTextSelection(from + 1).run();
+      }
+    };
+  },
+  addKeyboardShortcuts() {
+    return {
+      Backspace: () => {
+        const { schema, selection } = this.editor.state;
+        const { empty, $anchor } = selection;
+        if (!empty || $anchor.parent.type !== schema.nodes.detailsSummary) {
+          return false;
+        }
+        if ($anchor.parentOffset !== 0) {
+          return this.editor.commands.command(({ tr }) => {
+            const from = $anchor.pos - 1;
+            const to = $anchor.pos;
+            tr.delete(from, to);
+            return true;
+          });
+        }
+        return this.editor.commands.unsetDetails();
+      },
+      // Creates a new node below it if it is closed.
+      // Otherwise inside `DetailsContent`.
+      Enter: ({ editor }) => {
+        const { state, view } = editor;
+        const { schema, selection } = state;
+        const { $head } = selection;
+        if ($head.parent.type !== schema.nodes.detailsSummary) {
+          return false;
+        }
+        const isVisible = isNodeVisible($head.after() + 1, editor);
+        const above = isVisible ? state.doc.nodeAt($head.after()) : $head.node(-2);
+        if (!above) {
+          return false;
+        }
+        const after = isVisible ? 0 : $head.indexAfter(-1);
+        const type = defaultBlockAt(above.contentMatchAt(after));
+        if (!type || !above.canReplaceWith(after, after, type)) {
+          return false;
+        }
+        const node = type.createAndFill();
+        if (!node) {
+          return false;
+        }
+        const pos = isVisible ? $head.after() + 1 : $head.after(-1);
+        const tr = state.tr.replaceWith(pos, pos, node);
+        const $pos = tr.doc.resolve(pos);
+        const newSelection = Selection.near($pos, 1);
+        tr.setSelection(newSelection);
+        tr.scrollIntoView();
+        view.dispatch(tr);
+        return true;
+      },
+      // The default gapcursor implementation can’t handle hidden content, so we need to fix this.
+      ArrowRight: ({ editor }) => {
+        return setGapCursor(editor, "right");
+      },
+      // The default gapcursor implementation can’t handle hidden content, so we need to fix this.
+      ArrowDown: ({ editor }) => {
+        return setGapCursor(editor, "down");
+      }
+    };
+  },
+  addProseMirrorPlugins() {
+    return [
+      // This plugin prevents text selections within the hidden content in `DetailsContent`.
+      // The cursor is moved to the next visible position.
+      new Plugin({
+        key: new PluginKey("detailsSelection"),
+        appendTransaction: (transactions, oldState, newState) => {
+          const { editor, type } = this;
+          const selectionSet = transactions.some((transaction2) => transaction2.selectionSet);
+          if (!selectionSet || !oldState.selection.empty || !newState.selection.empty) {
+            return;
+          }
+          const detailsIsActive = isActive(newState, type.name);
+          if (!detailsIsActive) {
+            return;
+          }
+          const { $from } = newState.selection;
+          const isVisible = isNodeVisible($from.pos, editor);
+          if (isVisible) {
+            return;
+          }
+          const details = findClosestVisibleNode($from, (node) => node.type === type, editor);
+          if (!details) {
+            return;
+          }
+          const detailsSummaries = findChildren2(
+            details.node,
+            (node) => node.type === newState.schema.nodes.detailsSummary
+          );
+          if (!detailsSummaries.length) {
+            return;
+          }
+          const detailsSummary = detailsSummaries[0];
+          const selectionDirection = oldState.selection.from < newState.selection.from ? "forward" : "backward";
+          const correctedPosition = selectionDirection === "forward" ? details.start + detailsSummary.pos : details.pos + detailsSummary.pos + detailsSummary.node.nodeSize;
+          const selection = TextSelection.create(newState.doc, correctedPosition);
+          const transaction = newState.tr.setSelection(selection);
+          return transaction;
+        }
+      })
+    ];
+  }
 });
 
-export { Details, Details as default };
-//# sourceMappingURL=index.js.map
+// src/index.ts
+var index_default = Details;
+export {
+  Details,
+  index_default as default
+};
+//# sourceMappingURL=index.js.map