prosemirror-view 1.34.2 → 1.35.0

package/CHANGELOG.md

@@ -1,3 +1,17 @@
+## 1.35.0 (2024-10-29)
+
+### New features
+
+The new `NodeView.multiType` flag is now required to opt into handling different node types in a single node view. It used to be the default, but this tripped too many people up.
+
+## 1.34.3 (2024-09-19)
+
+### Bug fixes
+
+Fix an issue that would, during some types of document updates, leave the document DOM in an improper form.
+
+Handle the case where drag-selecting in Firefox creates a selection with multiple distinct ranges.
+
 ## 1.34.2 (2024-09-03)
 
 ### Bug fixes

package/dist/index.cjs

@@ -1564,7 +1564,7 @@ var CustomNodeViewDesc = function (_NodeViewDesc2) {
     key: "update",
     value: function update(node, outerDeco, innerDeco, view) {
       if (this.dirty == NODE_DIRTY) return false;
-      if (this.spec.update) {
+      if (this.spec.update && (this.node.type == node.type || this.spec.multiType)) {
         var result = this.spec.update(node, outerDeco, innerDeco);
         if (result) this.updateInner(node, outerDeco, innerDeco, view);
         return result;
@@ -1840,6 +1840,7 @@ var ViewTreeUpdater = function () {
             this.index++;
             return true;
           } else if (!locked && (updated = this.recreateWrapper(next, node, outerDeco, innerDeco, view, pos))) {
+            this.destroyBetween(this.index, i);
             this.top.children[this.index] = updated;
             if (updated.contentDOM) {
               updated.dirty = CONTENT_DIRTY;
@@ -1858,7 +1859,7 @@ var ViewTreeUpdater = function () {
   }, {
     key: "recreateWrapper",
     value: function recreateWrapper(next, node, outerDeco, innerDeco, view, pos) {
-      if (next.dirty || node.isAtom || !next.children.length || !next.node.content.eq(node.content)) return null;
+      if (next.dirty || node.isAtom || !next.children.length || !next.node.content.eq(node.content) || !sameOuterDeco(outerDeco, next.outerDeco) || !innerDeco.eq(next.innerDeco)) return null;
       var wrapper = NodeViewDesc.create(this.top, node, outerDeco, innerDeco, view, pos);
       if (wrapper.contentDOM) {
         wrapper.children = next.children;
@@ -2105,10 +2106,10 @@ function selectionFromDOM(view) {
   var head = view.docView.posFromDOM(domSel.focusNode, domSel.focusOffset, 1);
   if (head < 0) return null;
   var $head = doc.resolve(head),
-    $anchor,
+    anchor,
     selection;
   if (selectionCollapsed(domSel)) {
-    $anchor = $head;
+    anchor = head;
     while (nearestDesc && !nearestDesc.node) nearestDesc = nearestDesc.parent;
     var nearestDescNode = nearestDesc.node;
     if (nearestDesc && nearestDescNode.isAtom && prosemirrorState.NodeSelection.isSelectable(nearestDescNode) && nearestDesc.parent && !(nearestDescNode.isInline && isOnEdge(domSel.focusNode, domSel.focusOffset, nearestDesc.dom))) {
@@ -2116,10 +2117,26 @@ function selectionFromDOM(view) {
       selection = new prosemirrorState.NodeSelection(head == pos ? $head : doc.resolve(pos));
     }
   } else {
-    var anchor = view.docView.posFromDOM(domSel.anchorNode, domSel.anchorOffset, 1);
+    if (domSel instanceof view.dom.ownerDocument.defaultView.Selection && domSel.rangeCount > 1) {
+      var min = head,
+        max = head;
+      for (var i = 0; i < domSel.rangeCount; i++) {
+        var range = domSel.getRangeAt(i);
+        min = Math.min(min, view.docView.posFromDOM(range.startContainer, range.startOffset, 1));
+        max = Math.max(max, view.docView.posFromDOM(range.endContainer, range.endOffset, -1));
+      }
+      if (min < 0) return null;
+      var _ref3 = max == view.state.selection.anchor ? [max, min] : [min, max];
+      var _ref4 = _slicedToArray(_ref3, 2);
+      anchor = _ref4[0];
+      head = _ref4[1];
+      $head = doc.resolve(head);
+    } else {
+      anchor = view.docView.posFromDOM(domSel.anchorNode, domSel.anchorOffset, 1);
+    }
     if (anchor < 0) return null;
-    $anchor = doc.resolve(anchor);
   }
+  var $anchor = doc.resolve(anchor);
   if (!selection) {
     var bias = origin == "pointer" || view.state.selection.head < $head.pos && !inWidget ? 1 : -1;
     selection = selectionBetween(view, $anchor, $head, bias);
@@ -2910,7 +2927,7 @@ editHandlers.keydown = function (view, _event) {
   view.input.lastKeyCode = event.keyCode;
   view.input.lastKeyCodeTime = Date.now();
   if (android && chrome && event.keyCode == 13) return;
-  if (view.domObserver.selectionChanged(view.domSelectionRange())) view.domObserver.flush();else if (event.keyCode != 229) view.domObserver.forceFlush();
+  if (event.keyCode != 229) view.domObserver.forceFlush();
   if (ios && event.keyCode == 13 && !event.ctrlKey && !event.altKey && !event.metaKey) {
     var now = Date.now();
     view.input.lastIOSEnter = now;
@@ -4275,11 +4292,6 @@ var DOMObserver = function () {
       }
       return this.queue;
     }
-  }, {
-    key: "selectionChanged",
-    value: function selectionChanged(sel) {
-      return !this.suppressingSelectionUpdates && !this.currentSelection.eq(sel) && hasFocusAndSelection(this.view) && !this.ignoreSelectionChange(sel);
-    }
   }, {
     key: "flush",
     value: function flush() {
@@ -4287,8 +4299,8 @@ var DOMObserver = function () {
       if (!view.docView || this.flushingSoon > -1) return;
       var mutations = this.pendingRecords();
       if (mutations.length) this.queue = [];
-      var sel = view.domSelectionRange(),
-        newSel = this.selectionChanged(sel);
+      var sel = view.domSelectionRange();
+      var newSel = !this.suppressingSelectionUpdates && !this.currentSelection.eq(sel) && hasFocusAndSelection(view) && !this.ignoreSelectionChange(sel);
       var from = -1,
         to = -1,
         typeOver = false,
@@ -4417,11 +4429,11 @@ function rangeToSelectionRange(view, range) {
     focusOffset = range.endOffset;
   var currentAnchor = view.domAtPos(view.state.selection.anchor);
   if (isEquivalentPosition(currentAnchor.node, currentAnchor.offset, focusNode, focusOffset)) {
-    var _ref3 = [focusNode, focusOffset, anchorNode, anchorOffset];
-    anchorNode = _ref3[0];
-    anchorOffset = _ref3[1];
-    focusNode = _ref3[2];
-    focusOffset = _ref3[3];
+    var _ref5 = [focusNode, focusOffset, anchorNode, anchorOffset];
+    anchorNode = _ref5[0];
+    anchorOffset = _ref5[1];
+    focusNode = _ref5[2];
+    focusOffset = _ref5[3];
   }
   return {
     anchorNode: anchorNode,

package/dist/index.d.cts

@@ -265,19 +265,28 @@ interface NodeView {
     */
     contentDOM?: HTMLElement | null;
     /**
-    When given, this will be called when the view is updating itself.
-    It will be given a node (possibly of a different type), an array
-    of active decorations around the node (which are automatically
-    drawn, and the node view may ignore if it isn't interested in
-    them), and a [decoration source](https://prosemirror.net/docs/ref/#view.DecorationSource) that
-    represents any decorations that apply to the content of the node
-    (which again may be ignored). It should return true if it was
-    able to update to that node, and false otherwise. If the node
-    view has a `contentDOM` property (or no `dom` property), updating
-    its child nodes will be handled by ProseMirror.
+    When given, this will be called when the view is updating
+    itself. It will be given a node, an array of active decorations
+    around the node (which are automatically drawn, and the node
+    view may ignore if it isn't interested in them), and a
+    [decoration source](https://prosemirror.net/docs/ref/#view.DecorationSource) that represents any
+    decorations that apply to the content of the node (which again
+    may be ignored). It should return true if it was able to update
+    to that node, and false otherwise. If the node view has a
+    `contentDOM` property (or no `dom` property), updating its child
+    nodes will be handled by ProseMirror.
     */
     update?: (node: Node, decorations: readonly Decoration[], innerDecorations: DecorationSource) => boolean;
     /**
+    By default, `update` will only be called when a node of the same
+    node type appears in this view's position. When you set this to
+    true, it will be called for any node, making it possible to have
+    a node view that representsmultiple types of nodes. You will
+    need to check the type of the nodes you get in `update` and
+    return `false` for types you cannot handle.
+    */
+    multiType?: boolean;
+    /**
     Can be used to override the way the node's selected status (as a
     node selection) is displayed.
     */

package/dist/index.d.ts

@@ -265,19 +265,28 @@ interface NodeView {
     */
     contentDOM?: HTMLElement | null;
     /**
-    When given, this will be called when the view is updating itself.
-    It will be given a node (possibly of a different type), an array
-    of active decorations around the node (which are automatically
-    drawn, and the node view may ignore if it isn't interested in
-    them), and a [decoration source](https://prosemirror.net/docs/ref/#view.DecorationSource) that
-    represents any decorations that apply to the content of the node
-    (which again may be ignored). It should return true if it was
-    able to update to that node, and false otherwise. If the node
-    view has a `contentDOM` property (or no `dom` property), updating
-    its child nodes will be handled by ProseMirror.
+    When given, this will be called when the view is updating
+    itself. It will be given a node, an array of active decorations
+    around the node (which are automatically drawn, and the node
+    view may ignore if it isn't interested in them), and a
+    [decoration source](https://prosemirror.net/docs/ref/#view.DecorationSource) that represents any
+    decorations that apply to the content of the node (which again
+    may be ignored). It should return true if it was able to update
+    to that node, and false otherwise. If the node view has a
+    `contentDOM` property (or no `dom` property), updating its child
+    nodes will be handled by ProseMirror.
     */
     update?: (node: Node, decorations: readonly Decoration[], innerDecorations: DecorationSource) => boolean;
     /**
+    By default, `update` will only be called when a node of the same
+    node type appears in this view's position. When you set this to
+    true, it will be called for any node, making it possible to have
+    a node view that representsmultiple types of nodes. You will
+    need to check the type of the nodes you get in `update` and
+    return `false` for types you cannot handle.
+    */
+    multiType?: boolean;
+    /**
     Can be used to override the way the node's selected status (as a
     node selection) is displayed.
     */

package/dist/index.js

@@ -1552,7 +1552,7 @@ class CustomNodeViewDesc extends NodeViewDesc {
     update(node, outerDeco, innerDeco, view) {
         if (this.dirty == NODE_DIRTY)
             return false;
-        if (this.spec.update) {
+        if (this.spec.update && (this.node.type == node.type || this.spec.multiType)) {
             let result = this.spec.update(node, outerDeco, innerDeco);
             if (result)
                 this.updateInner(node, outerDeco, innerDeco, view);
@@ -1870,6 +1870,7 @@ class ViewTreeUpdater {
                     return true;
                 }
                 else if (!locked && (updated = this.recreateWrapper(next, node, outerDeco, innerDeco, view, pos))) {
+                    this.destroyBetween(this.index, i);
                     this.top.children[this.index] = updated;
                     if (updated.contentDOM) {
                         updated.dirty = CONTENT_DIRTY;
@@ -1889,7 +1890,8 @@ class ViewTreeUpdater {
     // identical content, move over its children.
     recreateWrapper(next, node, outerDeco, innerDeco, view, pos) {
         if (next.dirty || node.isAtom || !next.children.length ||
-            !next.node.content.eq(node.content))
+            !next.node.content.eq(node.content) ||
+            !sameOuterDeco(outerDeco, next.outerDeco) || !innerDeco.eq(next.innerDeco))
             return null;
         let wrapper = NodeViewDesc.create(this.top, node, outerDeco, innerDeco, view, pos);
         if (wrapper.contentDOM) {
@@ -2160,9 +2162,9 @@ function selectionFromDOM(view, origin = null) {
     let head = view.docView.posFromDOM(domSel.focusNode, domSel.focusOffset, 1);
     if (head < 0)
         return null;
-    let $head = doc.resolve(head), $anchor, selection;
+    let $head = doc.resolve(head), anchor, selection;
     if (selectionCollapsed(domSel)) {
-        $anchor = $head;
+        anchor = head;
         while (nearestDesc && !nearestDesc.node)
             nearestDesc = nearestDesc.parent;
         let nearestDescNode = nearestDesc.node;
@@ -2173,11 +2175,25 @@ function selectionFromDOM(view, origin = null) {
         }
     }
     else {
-        let anchor = view.docView.posFromDOM(domSel.anchorNode, domSel.anchorOffset, 1);
+        if (domSel instanceof view.dom.ownerDocument.defaultView.Selection && domSel.rangeCount > 1) {
+            let min = head, max = head;
+            for (let i = 0; i < domSel.rangeCount; i++) {
+                let range = domSel.getRangeAt(i);
+                min = Math.min(min, view.docView.posFromDOM(range.startContainer, range.startOffset, 1));
+                max = Math.max(max, view.docView.posFromDOM(range.endContainer, range.endOffset, -1));
+            }
+            if (min < 0)
+                return null;
+            [anchor, head] = max == view.state.selection.anchor ? [max, min] : [min, max];
+            $head = doc.resolve(head);
+        }
+        else {
+            anchor = view.docView.posFromDOM(domSel.anchorNode, domSel.anchorOffset, 1);
+        }
         if (anchor < 0)
             return null;
-        $anchor = doc.resolve(anchor);
     }
+    let $anchor = doc.resolve(anchor);
     if (!selection) {
         let bias = origin == "pointer" || (view.state.selection.head < $head.pos && !inWidget) ? 1 : -1;
         selection = selectionBetween(view, $anchor, $head, bias);
@@ -3095,9 +3111,7 @@ editHandlers.keydown = (view, _event) => {
     // and handling them eagerly tends to corrupt the input.
     if (android && chrome && event.keyCode == 13)
         return;
-    if (view.domObserver.selectionChanged(view.domSelectionRange()))
-        view.domObserver.flush();
-    else if (event.keyCode != 229)
+    if (event.keyCode != 229)
         view.domObserver.forceFlush();
     // On iOS, if we preventDefault enter key presses, the virtual
     // keyboard gets confused. So the hack here is to set a flag that
@@ -4620,9 +4634,6 @@ class DOMObserver {
                 this.queue.push(mut);
         return this.queue;
     }
-    selectionChanged(sel) {
-        return !this.suppressingSelectionUpdates && !this.currentSelection.eq(sel) && hasFocusAndSelection(this.view) && !this.ignoreSelectionChange(sel);
-    }
     flush() {
         let { view } = this;
         if (!view.docView || this.flushingSoon > -1)
@@ -4630,7 +4641,8 @@ class DOMObserver {
         let mutations = this.pendingRecords();
         if (mutations.length)
             this.queue = [];
-        let sel = view.domSelectionRange(), newSel = this.selectionChanged(sel);
+        let sel = view.domSelectionRange();
+        let newSel = !this.suppressingSelectionUpdates && !this.currentSelection.eq(sel) && hasFocusAndSelection(view) && !this.ignoreSelectionChange(sel);
         let from = -1, to = -1, typeOver = false, added = [];
         if (view.editable) {
             for (let i = 0; i < mutations.length; i++) {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "prosemirror-view",
-  "version": "1.34.2",
+  "version": "1.35.0",
   "description": "ProseMirror's view component",
   "type": "module",
   "main": "dist/index.cjs",

package/src/domobserver.ts

@@ -163,17 +163,14 @@ export class DOMObserver {
     return this.queue
   }
 
-  selectionChanged(sel: DOMSelectionRange) {
-    return !this.suppressingSelectionUpdates && !this.currentSelection.eq(sel) && hasFocusAndSelection(this.view) && !this.ignoreSelectionChange(sel)
-  }
-
   flush() {
     let {view} = this
     if (!view.docView || this.flushingSoon > -1) return
     let mutations = this.pendingRecords()
     if (mutations.length) this.queue = []
 
-    let sel = view.domSelectionRange(), newSel = this.selectionChanged(sel)
+    let sel = view.domSelectionRange()
+    let newSel = !this.suppressingSelectionUpdates && !this.currentSelection.eq(sel) && hasFocusAndSelection(view) && !this.ignoreSelectionChange(sel)
 
     let from = -1, to = -1, typeOver = false, added: Node[] = []
     if (view.editable) {

package/src/input.ts

@@ -112,9 +112,7 @@ editHandlers.keydown = (view: EditorView, _event: Event) => {
   // to be part of a confused sequence of composition events fired,
   // and handling them eagerly tends to corrupt the input.
   if (browser.android && browser.chrome && event.keyCode == 13) return
-
-  if (view.domObserver.selectionChanged(view.domSelectionRange())) view.domObserver.flush()
-  else if (event.keyCode != 229) view.domObserver.forceFlush()
+  if (event.keyCode != 229) view.domObserver.forceFlush()
 
   // On iOS, if we preventDefault enter key presses, the virtual
   // keyboard gets confused. So the hack here is to set a flag that

package/src/selection.ts

@@ -12,9 +12,9 @@ export function selectionFromDOM(view: EditorView, origin: string | null = null)
   let nearestDesc = view.docView.nearestDesc(domSel.focusNode), inWidget = nearestDesc && nearestDesc.size == 0
   let head = view.docView.posFromDOM(domSel.focusNode, domSel.focusOffset, 1)
   if (head < 0) return null
-  let $head = doc.resolve(head), $anchor, selection
+  let $head = doc.resolve(head), anchor, selection
   if (selectionCollapsed(domSel)) {
-    $anchor = $head
+    anchor = head
     while (nearestDesc && !nearestDesc.node) nearestDesc = nearestDesc.parent
     let nearestDescNode = (nearestDesc as NodeViewDesc).node
     if (nearestDesc && nearestDescNode.isAtom && NodeSelection.isSelectable(nearestDescNode) && nearestDesc.parent
@@ -23,10 +23,22 @@ export function selectionFromDOM(view: EditorView, origin: string | null = null)
       selection = new NodeSelection(head == pos ? $head : doc.resolve(pos))
     }
   } else {
-    let anchor = view.docView.posFromDOM(domSel.anchorNode!, domSel.anchorOffset, 1)
+    if (domSel instanceof view.dom.ownerDocument.defaultView!.Selection && domSel.rangeCount > 1) {
+      let min = head, max = head
+      for (let i = 0; i < domSel.rangeCount; i++) {
+        let range = domSel.getRangeAt(i)
+        min = Math.min(min, view.docView.posFromDOM(range.startContainer, range.startOffset, 1))
+        max = Math.max(max, view.docView.posFromDOM(range.endContainer, range.endOffset, -1))
+      }
+      if (min < 0) return null
+      ;[anchor, head] = max == view.state.selection.anchor ? [max, min] : [min, max]
+      $head = doc.resolve(head)
+    } else {
+      anchor = view.docView.posFromDOM(domSel.anchorNode!, domSel.anchorOffset, 1)
+    }
     if (anchor < 0) return null
-    $anchor = doc.resolve(anchor)
   }
+  let $anchor = doc.resolve(anchor)
 
   if (!selection) {
     let bias = origin == "pointer" || (view.state.selection.head < $head.pos && !inWidget) ? 1 : -1

package/src/viewdesc.ts

@@ -33,18 +33,26 @@ export interface NodeView {
   /// (or deciding not to render) its child nodes.
   contentDOM?: HTMLElement | null
 
-  /// When given, this will be called when the view is updating itself.
-  /// It will be given a node (possibly of a different type), an array
-  /// of active decorations around the node (which are automatically
-  /// drawn, and the node view may ignore if it isn't interested in
-  /// them), and a [decoration source](#view.DecorationSource) that
-  /// represents any decorations that apply to the content of the node
-  /// (which again may be ignored). It should return true if it was
-  /// able to update to that node, and false otherwise. If the node
-  /// view has a `contentDOM` property (or no `dom` property), updating
-  /// its child nodes will be handled by ProseMirror.
+  /// When given, this will be called when the view is updating
+  /// itself. It will be given a node, an array of active decorations
+  /// around the node (which are automatically drawn, and the node
+  /// view may ignore if it isn't interested in them), and a
+  /// [decoration source](#view.DecorationSource) that represents any
+  /// decorations that apply to the content of the node (which again
+  /// may be ignored). It should return true if it was able to update
+  /// to that node, and false otherwise. If the node view has a
+  /// `contentDOM` property (or no `dom` property), updating its child
+  /// nodes will be handled by ProseMirror.
   update?: (node: Node, decorations: readonly Decoration[], innerDecorations: DecorationSource) => boolean
 
+  /// By default, `update` will only be called when a node of the same
+  /// node type appears in this view's position. When you set this to
+  /// true, it will be called for any node, making it possible to have
+  /// a node view that representsmultiple types of nodes. You will
+  /// need to check the type of the nodes you get in `update` and
+  /// return `false` for types you cannot handle.
+  multiType?: boolean
+
   /// Can be used to override the way the node's selected status (as a
   /// node selection) is displayed.
   selectNode?: () => void
@@ -938,7 +946,7 @@ class CustomNodeViewDesc extends NodeViewDesc {
   // updates the children.
   update(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, view: EditorView) {
     if (this.dirty == NODE_DIRTY) return false
-    if (this.spec.update) {
+    if (this.spec.update && (this.node.type == node.type || this.spec.multiType)) {
       let result = this.spec.update(node, outerDeco, innerDeco)
       if (result) this.updateInner(node, outerDeco, innerDeco, view)
       return result
@@ -1249,6 +1257,7 @@ class ViewTreeUpdater {
           this.index++
           return true
         } else if (!locked && (updated = this.recreateWrapper(next, node, outerDeco, innerDeco, view, pos))) {
+          this.destroyBetween(this.index, i)
           this.top.children[this.index] = updated
           if (updated.contentDOM) {
             updated.dirty = CONTENT_DIRTY
@@ -1270,7 +1279,8 @@ class ViewTreeUpdater {
   recreateWrapper(next: NodeViewDesc, node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource,
                   view: EditorView, pos: number) {
     if (next.dirty || node.isAtom || !next.children.length ||
-        !next.node.content.eq(node.content)) return null
+        !next.node.content.eq(node.content) ||
+        !sameOuterDeco(outerDeco, next.outerDeco) || !innerDeco.eq(next.innerDeco)) return null
     let wrapper = NodeViewDesc.create(this.top, node, outerDeco, innerDeco, view, pos)
     if (wrapper.contentDOM) {
       wrapper.children = next.children