prosemirror-view 1.37.2 → 1.38.1

package/CHANGELOG.md

@@ -1,3 +1,19 @@
+## 1.38.1 (2025-03-04)
+
+### Bug fixes
+
+Fix a regression in 1.38.0 that breaks scrolling back to the selection after Chrome tries to reset it on focus.
+
+Remove some internally used types from the public type declaration files. Include file extension in web test local imports
+
+Fix an issue where scrolling the cursor into view could inappropriately scroll parent nodes of absolutely positioned elements.
+
+## 1.38.0 (2025-02-12)
+
+### New features
+
+The clipboard serialization logic is now available as a `serializeToClipboard` method on the view object.
+
 ## 1.37.2 (2025-01-22)
 
 ### Bug fixes

package/dist/index.cjs

@@ -200,9 +200,12 @@ function scrollRectIntoView(view, rect, startDOM) {
   var scrollThreshold = view.someProp("scrollThreshold") || 0,
     scrollMargin = view.someProp("scrollMargin") || 5;
   var doc = view.dom.ownerDocument;
-  for (var parent = startDOM || view.dom;; parent = parentNode(parent)) {
+  for (var parent = startDOM || view.dom;;) {
     if (!parent) break;
-    if (parent.nodeType != 1) continue;
+    if (parent.nodeType != 1) {
+      parent = parentNode(parent);
+      continue;
+    }
     var elt = parent;
     var atTop = elt == doc.body;
     var bounding = atTop ? windowRect(doc) : clientRect(elt);
@@ -228,7 +231,9 @@ function scrollRectIntoView(view, rect, startDOM) {
         };
       }
     }
-    if (atTop || /^(fixed|sticky)$/.test(getComputedStyle(parent).position)) break;
+    var pos = atTop ? "fixed" : getComputedStyle(parent).position;
+    if (/^(fixed|sticky)$/.test(pos)) break;
+    parent = pos == "absolute" ? parent.offsetParent : parentNode(parent);
   }
 }
 function storeScrollPos(view) {
@@ -2609,7 +2614,7 @@ function captureKeyDown(view, event) {
   }
   return false;
 }
-function serializeForClipboard(view, slice) {
+function _serializeForClipboard(view, slice) {
   view.someProp("transformCopied", function (f) {
     slice = f(slice, view);
   });
@@ -3354,7 +3359,7 @@ handlers.copy = editHandlers.cut = function (view, _event) {
   if (sel.empty) return;
   var data = brokenClipboardAPI ? null : event.clipboardData;
   var slice = sel.content(),
-    _serializeForClipboar = serializeForClipboard(view, slice),
+    _serializeForClipboar = _serializeForClipboard(view, slice),
     dom = _serializeForClipboar.dom,
     text = _serializeForClipboar.text;
   if (data) {
@@ -3430,7 +3435,7 @@ handlers.dragstart = function (view, _event) {
     if (desc && desc.node.type.spec.draggable && desc != view.docView) node = prosemirrorState.NodeSelection.create(view.state.doc, desc.posBefore);
   }
   var draggedSlice = (node || view.state.selection).content();
-  var _serializeForClipboar2 = serializeForClipboard(view, draggedSlice),
+  var _serializeForClipboar2 = _serializeForClipboard(view, draggedSlice),
     dom = _serializeForClipboar2.dom,
     text = _serializeForClipboar2.text,
     slice = _serializeForClipboar2.slice;
@@ -4812,7 +4817,6 @@ function isSurrogatePair(str) {
     b = str.charCodeAt(1);
   return a >= 0xDC00 && a <= 0xDFFF && b >= 0xD800 && b <= 0xDBFF;
 }
-var __serializeForClipboard = serializeForClipboard;
 var __parseFromClipboard = parseFromClipboard;
 var __endComposition = endComposition;
 var EditorView = function () {
@@ -5124,6 +5128,11 @@ var EditorView = function () {
     value: function pasteText(text, event) {
       return doPaste(this, text, null, true, event || new ClipboardEvent("paste"));
     }
+  }, {
+    key: "serializeForClipboard",
+    value: function serializeForClipboard(slice) {
+      return _serializeForClipboard(this, slice);
+    }
   }, {
     key: "destroy",
     value: function destroy() {
@@ -5242,4 +5251,3 @@ exports.DecorationSet = DecorationSet;
 exports.EditorView = EditorView;
 exports.__endComposition = __endComposition;
 exports.__parseFromClipboard = __parseFromClipboard;
-exports.__serializeForClipboard = __serializeForClipboard;

package/dist/index.d.cts

@@ -1,5 +1,5 @@
 import { EditorState, Transaction, Selection, Plugin } from 'prosemirror-state';
-import { Mark, Node, TagParseRule, Slice, ResolvedPos, DOMParser, DOMSerializer } from 'prosemirror-model';
+import { Mark, Node, Slice, ResolvedPos, DOMParser, DOMSerializer } from 'prosemirror-model';
 import { Mapping } from 'prosemirror-transform';
 
 type DOMNode = InstanceType<typeof window.Node>;
@@ -234,7 +234,6 @@ declare class DecorationGroup implements DecorationSource {
 
 declare global {
     interface Node {
-        pmViewDesc?: ViewDesc;
     }
 }
 /**
@@ -361,104 +360,6 @@ interface MarkView {
     */
     destroy?: () => void;
 }
-declare class ViewDesc {
-    parent: ViewDesc | undefined;
-    children: ViewDesc[];
-    dom: DOMNode;
-    contentDOM: HTMLElement | null;
-    dirty: number;
-    node: Node | null;
-    constructor(parent: ViewDesc | undefined, children: ViewDesc[], dom: DOMNode, contentDOM: HTMLElement | null);
-    matchesWidget(widget: Decoration): boolean;
-    matchesMark(mark: Mark): boolean;
-    matchesNode(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource): boolean;
-    matchesHack(nodeName: string): boolean;
-    parseRule(): Omit<TagParseRule, "tag"> | null;
-    stopEvent(event: Event): boolean;
-    get size(): number;
-    get border(): number;
-    destroy(): void;
-    posBeforeChild(child: ViewDesc): number;
-    get posBefore(): number;
-    get posAtStart(): number;
-    get posAfter(): number;
-    get posAtEnd(): number;
-    localPosFromDOM(dom: DOMNode, offset: number, bias: number): number;
-    nearestDesc(dom: DOMNode): ViewDesc | undefined;
-    nearestDesc(dom: DOMNode, onlyNodes: true): NodeViewDesc | undefined;
-    getDesc(dom: DOMNode): ViewDesc | undefined;
-    posFromDOM(dom: DOMNode, offset: number, bias: number): number;
-    descAt(pos: number): ViewDesc | undefined;
-    domFromPos(pos: number, side: number): {
-        node: DOMNode;
-        offset: number;
-        atom?: number;
-    };
-    parseRange(from: number, to: number, base?: number): {
-        node: DOMNode;
-        from: number;
-        to: number;
-        fromOffset: number;
-        toOffset: number;
-    };
-    emptyChildAt(side: number): boolean;
-    domAfterPos(pos: number): DOMNode;
-    setSelection(anchor: number, head: number, view: EditorView, force?: boolean): void;
-    ignoreMutation(mutation: ViewMutationRecord): boolean;
-    get contentLost(): boolean | null;
-    markDirty(from: number, to: number): void;
-    markParentsDirty(): void;
-    get domAtom(): boolean;
-    get ignoreForCoords(): boolean;
-    isText(text: string): boolean;
-}
-declare class NodeViewDesc extends ViewDesc {
-    node: Node;
-    outerDeco: readonly Decoration[];
-    innerDeco: DecorationSource;
-    readonly nodeDOM: DOMNode;
-    constructor(parent: ViewDesc | undefined, node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, dom: DOMNode, contentDOM: HTMLElement | null, nodeDOM: DOMNode, view: EditorView, pos: number);
-    static create(parent: ViewDesc | undefined, node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, view: EditorView, pos: number): NodeViewDesc | TextViewDesc;
-    parseRule(): Omit<TagParseRule, "tag"> | null;
-    matchesNode(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource): boolean;
-    get size(): number;
-    get border(): 0 | 1;
-    updateChildren(view: EditorView, pos: number): void;
-    localCompositionInfo(view: EditorView, pos: number): {
-        node: Text;
-        pos: number;
-        text: string;
-    } | null;
-    protectLocalComposition(view: EditorView, { node, pos, text }: {
-        node: Text;
-        pos: number;
-        text: string;
-    }): void;
-    update(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, view: EditorView): boolean;
-    updateInner(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, view: EditorView): void;
-    updateOuterDeco(outerDeco: readonly Decoration[]): void;
-    selectNode(): void;
-    deselectNode(): void;
-    get domAtom(): boolean;
-}
-declare class TextViewDesc extends NodeViewDesc {
-    constructor(parent: ViewDesc | undefined, node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, dom: DOMNode, nodeDOM: DOMNode, view: EditorView);
-    parseRule(): {
-        skip: any;
-    };
-    update(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, view: EditorView): boolean;
-    inParent(): boolean;
-    domFromPos(pos: number): {
-        node: globalThis.Node;
-        offset: number;
-    };
-    localPosFromDOM(dom: DOMNode, offset: number, bias: number): number;
-    ignoreMutation(mutation: ViewMutationRecord): boolean;
-    slice(from: number, to: number, view: EditorView): TextViewDesc;
-    markDirty(from: number, to: number): void;
-    get domAtom(): boolean;
-    isText(text: string): boolean;
-}
 
 /**
 An editor view manages the DOM structure that represents an
@@ -650,6 +551,19 @@ declare class EditorView {
     */
     pasteText(text: string, event?: ClipboardEvent): boolean;
     /**
+    Serialize the given slice as it would be if it was copied from
+    this editor. Returns a DOM element that contains a
+    representation of the slice as its children, a textual
+    representation, and the transformed slice (which can be
+    different from the given input due to hooks like
+    [`transformCopied`](https://prosemirror.net/docs/ref/#view.EditorProps.transformCopied)).
+    */
+    serializeForClipboard(slice: Slice): {
+        dom: HTMLElement;
+        text: string;
+        slice: Slice;
+    };
+    /**
     Removes the editor from the DOM and destroys all [node
     views](https://prosemirror.net/docs/ref/#view.NodeView).
     */

package/dist/index.d.ts

@@ -1,5 +1,5 @@
 import { EditorState, Transaction, Selection, Plugin } from 'prosemirror-state';
-import { Mark, Node, TagParseRule, Slice, ResolvedPos, DOMParser, DOMSerializer } from 'prosemirror-model';
+import { Mark, Node, Slice, ResolvedPos, DOMParser, DOMSerializer } from 'prosemirror-model';
 import { Mapping } from 'prosemirror-transform';
 
 type DOMNode = InstanceType<typeof window.Node>;
@@ -234,7 +234,6 @@ declare class DecorationGroup implements DecorationSource {
 
 declare global {
     interface Node {
-        pmViewDesc?: ViewDesc;
     }
 }
 /**
@@ -361,104 +360,6 @@ interface MarkView {
     */
     destroy?: () => void;
 }
-declare class ViewDesc {
-    parent: ViewDesc | undefined;
-    children: ViewDesc[];
-    dom: DOMNode;
-    contentDOM: HTMLElement | null;
-    dirty: number;
-    node: Node | null;
-    constructor(parent: ViewDesc | undefined, children: ViewDesc[], dom: DOMNode, contentDOM: HTMLElement | null);
-    matchesWidget(widget: Decoration): boolean;
-    matchesMark(mark: Mark): boolean;
-    matchesNode(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource): boolean;
-    matchesHack(nodeName: string): boolean;
-    parseRule(): Omit<TagParseRule, "tag"> | null;
-    stopEvent(event: Event): boolean;
-    get size(): number;
-    get border(): number;
-    destroy(): void;
-    posBeforeChild(child: ViewDesc): number;
-    get posBefore(): number;
-    get posAtStart(): number;
-    get posAfter(): number;
-    get posAtEnd(): number;
-    localPosFromDOM(dom: DOMNode, offset: number, bias: number): number;
-    nearestDesc(dom: DOMNode): ViewDesc | undefined;
-    nearestDesc(dom: DOMNode, onlyNodes: true): NodeViewDesc | undefined;
-    getDesc(dom: DOMNode): ViewDesc | undefined;
-    posFromDOM(dom: DOMNode, offset: number, bias: number): number;
-    descAt(pos: number): ViewDesc | undefined;
-    domFromPos(pos: number, side: number): {
-        node: DOMNode;
-        offset: number;
-        atom?: number;
-    };
-    parseRange(from: number, to: number, base?: number): {
-        node: DOMNode;
-        from: number;
-        to: number;
-        fromOffset: number;
-        toOffset: number;
-    };
-    emptyChildAt(side: number): boolean;
-    domAfterPos(pos: number): DOMNode;
-    setSelection(anchor: number, head: number, view: EditorView, force?: boolean): void;
-    ignoreMutation(mutation: ViewMutationRecord): boolean;
-    get contentLost(): boolean | null;
-    markDirty(from: number, to: number): void;
-    markParentsDirty(): void;
-    get domAtom(): boolean;
-    get ignoreForCoords(): boolean;
-    isText(text: string): boolean;
-}
-declare class NodeViewDesc extends ViewDesc {
-    node: Node;
-    outerDeco: readonly Decoration[];
-    innerDeco: DecorationSource;
-    readonly nodeDOM: DOMNode;
-    constructor(parent: ViewDesc | undefined, node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, dom: DOMNode, contentDOM: HTMLElement | null, nodeDOM: DOMNode, view: EditorView, pos: number);
-    static create(parent: ViewDesc | undefined, node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, view: EditorView, pos: number): NodeViewDesc | TextViewDesc;
-    parseRule(): Omit<TagParseRule, "tag"> | null;
-    matchesNode(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource): boolean;
-    get size(): number;
-    get border(): 0 | 1;
-    updateChildren(view: EditorView, pos: number): void;
-    localCompositionInfo(view: EditorView, pos: number): {
-        node: Text;
-        pos: number;
-        text: string;
-    } | null;
-    protectLocalComposition(view: EditorView, { node, pos, text }: {
-        node: Text;
-        pos: number;
-        text: string;
-    }): void;
-    update(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, view: EditorView): boolean;
-    updateInner(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, view: EditorView): void;
-    updateOuterDeco(outerDeco: readonly Decoration[]): void;
-    selectNode(): void;
-    deselectNode(): void;
-    get domAtom(): boolean;
-}
-declare class TextViewDesc extends NodeViewDesc {
-    constructor(parent: ViewDesc | undefined, node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, dom: DOMNode, nodeDOM: DOMNode, view: EditorView);
-    parseRule(): {
-        skip: any;
-    };
-    update(node: Node, outerDeco: readonly Decoration[], innerDeco: DecorationSource, view: EditorView): boolean;
-    inParent(): boolean;
-    domFromPos(pos: number): {
-        node: globalThis.Node;
-        offset: number;
-    };
-    localPosFromDOM(dom: DOMNode, offset: number, bias: number): number;
-    ignoreMutation(mutation: ViewMutationRecord): boolean;
-    slice(from: number, to: number, view: EditorView): TextViewDesc;
-    markDirty(from: number, to: number): void;
-    get domAtom(): boolean;
-    isText(text: string): boolean;
-}
 
 /**
 An editor view manages the DOM structure that represents an
@@ -650,6 +551,19 @@ declare class EditorView {
     */
     pasteText(text: string, event?: ClipboardEvent): boolean;
     /**
+    Serialize the given slice as it would be if it was copied from
+    this editor. Returns a DOM element that contains a
+    representation of the slice as its children, a textual
+    representation, and the transformed slice (which can be
+    different from the given input due to hooks like
+    [`transformCopied`](https://prosemirror.net/docs/ref/#view.EditorProps.transformCopied)).
+    */
+    serializeForClipboard(slice: Slice): {
+        dom: HTMLElement;
+        text: string;
+        slice: Slice;
+    };
+    /**
     Removes the editor from the DOM and destroys all [node
     views](https://prosemirror.net/docs/ref/#view.NodeView).
     */

package/dist/index.js

@@ -201,11 +201,13 @@ function clientRect(node) {
 function scrollRectIntoView(view, rect, startDOM) {
     let scrollThreshold = view.someProp("scrollThreshold") || 0, scrollMargin = view.someProp("scrollMargin") || 5;
     let doc = view.dom.ownerDocument;
-    for (let parent = startDOM || view.dom;; parent = parentNode(parent)) {
+    for (let parent = startDOM || view.dom;;) {
         if (!parent)
             break;
-        if (parent.nodeType != 1)
+        if (parent.nodeType != 1) {
+            parent = parentNode(parent);
             continue;
+        }
         let elt = parent;
         let atTop = elt == doc.body;
         let bounding = atTop ? windowRect(doc) : clientRect(elt);
@@ -234,8 +236,10 @@ function scrollRectIntoView(view, rect, startDOM) {
                 rect = { left: rect.left - dX, top: rect.top - dY, right: rect.right - dX, bottom: rect.bottom - dY };
             }
         }
-        if (atTop || /^(fixed|sticky)$/.test(getComputedStyle(parent).position))
+        let pos = atTop ? "fixed" : getComputedStyle(parent).position;
+        if (/^(fixed|sticky)$/.test(pos))
             break;
+        parent = pos == "absolute" ? parent.offsetParent : parentNode(parent);
     }
 }
 // Store the scroll position of the editor's parent nodes, along with
@@ -5207,10 +5211,6 @@ function isSurrogatePair(str) {
     return a >= 0xDC00 && a <= 0xDFFF && b >= 0xD800 && b <= 0xDBFF;
 }
 
-/**
-@internal
-*/
-const __serializeForClipboard = serializeForClipboard;
 /**
 @internal
 */
@@ -5660,6 +5660,17 @@ class EditorView {
         return doPaste(this, text, null, true, event || new ClipboardEvent("paste"));
     }
     /**
+    Serialize the given slice as it would be if it was copied from
+    this editor. Returns a DOM element that contains a
+    representation of the slice as its children, a textual
+    representation, and the transformed slice (which can be
+    different from the given input due to hooks like
+    [`transformCopied`](https://prosemirror.net/docs/ref/#view.EditorProps.transformCopied)).
+    */
+    serializeForClipboard(slice) {
+        return serializeForClipboard(this, slice);
+    }
+    /**
     Removes the editor from the DOM and destroys all [node
     views](https://prosemirror.net/docs/ref/#view.NodeView).
     */
@@ -5793,4 +5804,4 @@ function checkStateComponent(plugin) {
         throw new RangeError("Plugins passed directly to the view must not have a state component");
 }
 
-export { Decoration, DecorationSet, EditorView, __endComposition, __parseFromClipboard, __serializeForClipboard };
+export { Decoration, DecorationSet, EditorView, __endComposition, __parseFromClipboard };

package/package.json

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

package/src/domcoords.ts

@@ -32,9 +32,9 @@ function clientRect(node: HTMLElement): Rect {
 export function scrollRectIntoView(view: EditorView, rect: Rect, startDOM: Node) {
   let scrollThreshold = view.someProp("scrollThreshold") || 0, scrollMargin = view.someProp("scrollMargin") || 5
   let doc = view.dom.ownerDocument
-  for (let parent: Node | null = startDOM || view.dom;; parent = parentNode(parent)) {
+  for (let parent: Node | null = startDOM || view.dom;;) {
     if (!parent) break
-    if (parent.nodeType != 1) continue
+    if (parent.nodeType != 1) { parent = parentNode(parent); continue }
     let elt = parent as HTMLElement
     let atTop = elt == doc.body
     let bounding = atTop ? windowRect(doc) : clientRect(elt as HTMLElement)
@@ -60,7 +60,9 @@ export function scrollRectIntoView(view: EditorView, rect: Rect, startDOM: Node)
         rect = {left: rect.left - dX, top: rect.top - dY, right: rect.right - dX, bottom: rect.bottom - dY}
       }
     }
-    if (atTop || /^(fixed|sticky)$/.test(getComputedStyle(parent as HTMLElement).position)) break
+    let pos: string = atTop ? "fixed" : getComputedStyle(parent as HTMLElement).position
+    if (/^(fixed|sticky)$/.test(pos)) break
+    parent = pos == "absolute" ? (parent as HTMLElement).offsetParent : parentNode(parent)
   }
 }
 

package/src/index.ts

@@ -20,8 +20,6 @@ export {NodeView, MarkView, ViewMutationRecord} from "./viewdesc"
 import {serializeForClipboard, parseFromClipboard} from "./clipboard"
 import {endComposition} from "./input"
 /// @internal
-export const __serializeForClipboard = serializeForClipboard
-/// @internal
 export const __parseFromClipboard = parseFromClipboard
 /// @internal
 export const __endComposition = endComposition
@@ -446,6 +444,16 @@ export class EditorView {
     return doPaste(this, text, null, true, event || new ClipboardEvent("paste"))
   }
 
+  /// Serialize the given slice as it would be if it was copied from
+  /// this editor. Returns a DOM element that contains a
+  /// representation of the slice as its children, a textual
+  /// representation, and the transformed slice (which can be
+  /// different from the given input due to hooks like
+  /// [`transformCopied`](#view.EditorProps.transformCopied)).
+  serializeForClipboard(slice: Slice): {dom: HTMLElement, text: string, slice: Slice} {
+    return serializeForClipboard(this, slice)
+  }
+
   /// Removes the editor from the DOM and destroys all [node
   /// views](#view.NodeView).
   destroy() {

package/src/viewdesc.ts

@@ -7,7 +7,10 @@ import {Decoration, DecorationSource, WidgetConstructor, WidgetType, NodeType} f
 import {EditorView} from "./index"
 
 declare global {
-  interface Node { pmViewDesc?: ViewDesc }
+  interface Node { 
+    /// @internal
+    pmViewDesc?: ViewDesc 
+  }
 }
 
 /// A ViewMutationRecord represents a DOM