@handlewithcare/react-prosemirror 2.5.3 → 2.6.0-tiptap.0

package/README.md

@@ -693,15 +693,14 @@ export function SelectionWidget() {
 ### `NodeViewComponentProps`
 
 ```tsx
-type NodeViewComponentProps = {
+interface NodeViewComponentProps extends AllHTMLAttributes<HTMLElement> = {
   nodeProps: {
     decorations: readonly Decoration[];
     innerDecorations: DecorationSource;
     node: Node;
-    children?: ReactNode | ReactNode[];
     getPos: () => number;
   };
-} & HTMLAttributes<HTMLElement>;
+};
 ```
 
 The props that will be passed to all node view components. These props map

package/dist/cjs/components/__tests__/ProseMirror.composition.test.js

@@ -0,0 +1,398 @@
+/* eslint-disable @typescript-eslint/no-explicit-any */ /* eslint-disable @typescript-eslint/no-non-null-assertion */ "use strict";
+Object.defineProperty(exports, "__esModule", {
+    value: true
+});
+const _prosemirrorTestBuilder = require("prosemirror-test-builder");
+const _prosemirrorView = require("prosemirror-view");
+const _editorViewTestHelpersJs = require("../../testing/editorViewTestHelpers.js");
+function endComposition(view, forceUpdate) {
+    (0, _prosemirrorView["__endComposition"])(view, forceUpdate);
+}
+function event(pm, type) {
+    pm.dom.dispatchEvent(new CompositionEvent(type));
+}
+function edit(node) {
+    let text = arguments.length > 1 && arguments[1] !== void 0 ? arguments[1] : "", from = arguments.length > 2 && arguments[2] !== void 0 ? arguments[2] : node.nodeValue.length, to = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : from;
+    const val = node.nodeValue;
+    node.nodeValue = val.slice(0, from) + text + val.slice(to);
+    document.getSelection().collapse(node, from + text.length);
+    return node;
+}
+function hasCompositionNode(_pm) {
+    let { focusNode  } = document.getSelection();
+    while(focusNode && !focusNode.pmViewDesc)focusNode = focusNode.parentNode;
+    return focusNode && focusNode.pmViewDesc.constructor.name == "CompositionViewDesc";
+}
+function compose(pm, start, update) {
+    let options = arguments.length > 3 && arguments[3] !== void 0 ? arguments[3] : {};
+    event(pm, "compositionstart");
+    expect(pm.composing).toBeTruthy();
+    let node;
+    const sel = document.getSelection();
+    for(let i = -1; i < update.length; i++){
+        if (i < 0) node = start();
+        else update[i](node);
+        const { focusNode , focusOffset  } = sel;
+        // @ts-expect-error Internal property
+        pm.domObserver.flush();
+        if (options.cancel && i == update.length - 1) {
+            expect(hasCompositionNode(pm)).toBeFalsy();
+        } else {
+            expect(node.parentNode && pm.dom.contains(node.parentNode)).toBeTruthy();
+            expect(sel.focusNode === focusNode).toBeTruthy();
+            expect(sel.focusOffset === focusOffset).toBeTruthy();
+            if (options.node) expect(hasCompositionNode(pm)).toBeTruthy();
+        }
+    }
+    event(pm, "compositionend");
+    if (options.end) {
+        options.end(node);
+        // @ts-expect-error Internal property
+        pm.domObserver.flush();
+    }
+    endComposition(pm);
+    expect(pm.composing).toBeFalsy();
+    expect(hasCompositionNode(pm)).toBeFalsy();
+}
+// function wordDeco(state: EditorState) {
+//   const re = /\w+/g,
+//     deco: Decoration[] = [];
+//   state.doc.descendants((node, pos) => {
+//     if (node.isText)
+//       for (let m; (m = re.exec(node.text!)); )
+//         deco.push(
+//           Decoration.inline(pos + m.index, pos + m.index + m[0].length, {
+//             class: "word",
+//           })
+//         );
+//   });
+//   return DecorationSet.create(state.doc, deco);
+// }
+// const wordHighlighter = new Plugin({
+//   props: { decorations: wordDeco },
+// });
+// const Widget = forwardRef(function Widget(
+//   { widget, pos, ...props }: WidgetViewComponentProps,
+//   ref: Ref<HTMLElement>
+// ) {
+//   return (
+//     <var ref={ref} {...props}>
+//       ×
+//     </var>
+//   );
+// });
+// function widgets(positions: number[], sides: number[]) {
+//   return new Plugin({
+//     state: {
+//       init(state) {
+//         const deco = positions.map((p, i) =>
+//           widget(p, Widget, { side: sides[i] })
+//         );
+//         return DecorationSet.create(state.doc!, deco);
+//       },
+//       apply(tr, deco) {
+//         return deco.map(tr.mapping, tr.doc);
+//       },
+//     },
+//     props: {
+//       decorations(this: Plugin, state) {
+//         return this.getState(state);
+//       },
+//     },
+//   });
+// }
+// These unfortunately aren't working at the moment, though
+// composition seems to be working generally.
+describe.skip("EditorView composition", ()=>{
+    it("supports composition in an empty block", ()=>{
+        const { view: pm  } = (0, _editorViewTestHelpersJs.tempEditor)({
+            doc: (0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("<a>"))
+        });
+        compose(pm, ()=>edit(pm.dom.firstChild.appendChild(document.createTextNode("a"))), [
+            (n)=>edit(n, "b"),
+            (n)=>edit(n, "c")
+        ], {
+            node: true
+        });
+        expect(pm.state.doc).toEqualNode((0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("abc")));
+    });
+    it("supports composition at end of block", ()=>{
+        const { view: pm  } = (0, _editorViewTestHelpersJs.tempEditor)({
+            doc: (0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("foo"))
+        });
+        compose(pm, ()=>edit((0, _editorViewTestHelpersJs.findTextNode)(pm.dom, "foo")), [
+            (n)=>edit(n, "!"),
+            (n)=>edit(n, "?")
+        ]);
+        expect(pm.state.doc).toEqualNode((0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("foo!?")));
+    });
+    it("supports composition at end of block in a new node", ()=>{
+        const { view: pm  } = (0, _editorViewTestHelpersJs.tempEditor)({
+            doc: (0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("foo"))
+        });
+        compose(pm, ()=>edit(pm.dom.firstChild.appendChild(document.createTextNode("!"))), [
+            (n)=>edit(n, "?")
+        ], // $$FORK: We don't use composition view descriptors except for in initially empty nodes
+        {
+            node: false
+        });
+        expect(pm.state.doc).toEqualNode((0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("foo!?")));
+    });
+    it("supports composition at start of block in a new node", ()=>{
+        const { view: pm  } = (0, _editorViewTestHelpersJs.tempEditor)({
+            doc: (0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("foo"))
+        });
+        compose(pm, ()=>{
+            const p = pm.dom.firstChild;
+            return edit(p.insertBefore(document.createTextNode("!"), p.firstChild));
+        }, [
+            (n)=>edit(n, "?")
+        ], // $$FORK: We don't use composition view descriptors except for in initially empty nodes
+        {
+            node: false
+        });
+        expect(pm.state.doc).toEqualNode((0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("!?foo")));
+    });
+    it("supports composition inside existing text", ()=>{
+        const { view: pm  } = (0, _editorViewTestHelpersJs.tempEditor)({
+            doc: (0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("foo"))
+        });
+        compose(pm, ()=>edit((0, _editorViewTestHelpersJs.findTextNode)(pm.dom, "foo")), [
+            (n)=>edit(n, "x", 1),
+            (n)=>edit(n, "y", 2),
+            (n)=>edit(n, "z", 3)
+        ]);
+        expect(pm.state.doc).toEqualNode((0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("fxyzoo")));
+    });
+    // TODO: Offset out of bound
+    // eslint-disable-next-line jest/no-disabled-tests
+    it.skip("can deal with Android-style newline-after-composition", ()=>{
+        const { view: pm  } = (0, _editorViewTestHelpersJs.tempEditor)({
+            doc: (0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("abcdef"))
+        });
+        compose(pm, ()=>edit((0, _editorViewTestHelpersJs.findTextNode)(pm.dom, "abcdef")), [
+            (n)=>edit(n, "x", 3),
+            (n)=>edit(n, "y", 4)
+        ], {
+            end: (n)=>{
+                const line = pm.dom.appendChild(document.createElement("div"));
+                line.textContent = "def";
+                n.nodeValue = "abcxy";
+                document.getSelection().collapse(line, 0);
+            }
+        });
+        expect(pm.state.doc).toEqualNode((0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("abcxy"), (0, _prosemirrorTestBuilder.p)("def")));
+    });
+    it("handles replacement of existing words", ()=>{
+        const { view: pm  } = (0, _editorViewTestHelpersJs.tempEditor)({
+            doc: (0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("one two three"))
+        });
+        compose(pm, ()=>edit((0, _editorViewTestHelpersJs.findTextNode)(pm.dom, "one two three"), "five", 4, 7), [
+            (n)=>edit(n, "seven", 4, 8),
+            (n)=>edit(n, "zero", 4, 9)
+        ]);
+        expect(pm.state.doc).toEqualNode((0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("one zero three")));
+    });
+    it("handles composition inside marks", ()=>{
+        const { view: pm  } = (0, _editorViewTestHelpersJs.tempEditor)({
+            doc: (0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("one ", (0, _prosemirrorTestBuilder.em)("two")))
+        });
+        compose(pm, ()=>edit((0, _editorViewTestHelpersJs.findTextNode)(pm.dom, "two"), "o"), [
+            (n)=>edit(n, "o"),
+            (n)=>edit(n, "w")
+        ]);
+        expect(pm.state.doc).toEqualNode((0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("one ", (0, _prosemirrorTestBuilder.em)("twooow"))));
+    });
+    it.skip("handles composition in a mark that has multiple children", ()=>{
+        const { view: pm  } = (0, _editorViewTestHelpersJs.tempEditor)({
+            doc: (0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("one ", (0, _prosemirrorTestBuilder.em)("two", (0, _prosemirrorTestBuilder.strong)(" three"))))
+        });
+        compose(pm, ()=>edit((0, _editorViewTestHelpersJs.findTextNode)(pm.dom, "two"), "o"), [
+            (n)=>edit(n, "o"),
+            (n)=>edit(n, "w")
+        ]);
+        expect(pm.state.doc).toEqualNode((0, _prosemirrorTestBuilder.doc)((0, _prosemirrorTestBuilder.p)("one ", (0, _prosemirrorTestBuilder.em)("twooow", (0, _prosemirrorTestBuilder.strong)(" three")))));
+    });
+// it("supports composition in a cursor wrapper", () => {
+//   const { view: pm } = tempEditor({ doc: doc(p("<a>")) });
+//   pm.dispatch(pm.state.tr.addStoredMark(schema.marks.em.create()));
+//   compose(
+//     pm,
+//     () =>
+//       edit(pm.dom.firstChild!.appendChild(document.createTextNode("")), "a"),
+//     [(n) => edit(n, "b"), (n) => edit(n, "c")],
+//     { node: true }
+//   );
+//   ist(pm.state.doc, doc(p(em("abc"))), eq);
+// });
+// it("handles composition in a multi-child mark with a cursor wrapper", () => {
+//   const { view: pm } = requireFocus(
+//     tempEditor({ doc: doc(p("one ", em("two<a>", strong(" three")))) })
+//   );
+//   pm.dispatch(pm.state.tr.addStoredMark(schema.marks.code.create()));
+//   const emNode = pm.dom.querySelector("em")!;
+//   compose(
+//     pm,
+//     () =>
+//       edit(
+//         emNode.insertBefore(
+//           document.createTextNode(""),
+//           emNode.querySelector("strong")
+//         ),
+//         "o"
+//       ),
+//     [(n) => edit(n, "o"), (n) => edit(n, "w")],
+//     { node: true }
+//   );
+//   ist(
+//     pm.state.doc,
+//     doc(p("one ", em("two", code("oow"), strong(" three")))),
+//     eq
+//   );
+// });
+// it("doesn't get interrupted by changes in decorations", () => {
+//   const { view: pm } = requireFocus(
+//     tempEditor({ doc: doc(p("foo ...")), plugins: [wordHighlighter] })
+//   );
+//   compose(pm, () => edit(findTextNode(pm.dom, " ...")!), [
+//     (n) => edit(n, "hi", 1, 4),
+//   ]);
+//   ist(pm.state.doc, doc(p("foo hi")), eq);
+// });
+// it("works inside highlighted text", () => {
+//   const { view: pm } = requireFocus(
+//     tempEditor({ doc: doc(p("one two")), plugins: [wordHighlighter] })
+//   );
+//   compose(pm, () => edit(findTextNode(pm.dom, "one")!, "x"), [
+//     (n) => edit(n, "y"),
+//     (n) => edit(n, "."),
+//   ]);
+//   ist(pm.state.doc, doc(p("onexy. two")), eq);
+// });
+// it("can handle compositions spanning multiple nodes", () => {
+//   const { view: pm } = requireFocus(
+//     tempEditor({ doc: doc(p("one two")), plugins: [wordHighlighter] })
+//   );
+//   compose(
+//     pm,
+//     () => edit(findTextNode(pm.dom, "two")!, "a"),
+//     [(n) => edit(n, "b"), (n) => edit(n, "c")],
+//     {
+//       end: (n: Text) => {
+//         n.parentNode!.previousSibling!.remove();
+//         n.parentNode!.previousSibling!.remove();
+//         return edit(n, "xyzone ", 0);
+//       },
+//     }
+//   );
+//   ist(pm.state.doc, doc(p("xyzone twoabc")), eq);
+// });
+// it("doesn't overwrite widgets next to the composition", () => {
+//   const { view: pm } = requireFocus(
+//     tempEditor({ doc: doc(p("")), plugins: [widgets([1, 1], [-1, 1])] })
+//   );
+//   compose(
+//     pm,
+//     () => {
+//       const p = pm.dom.firstChild!;
+//       return edit(p.insertBefore(document.createTextNode("a"), p.lastChild));
+//     },
+//     [(n) => edit(n, "b", 0, 1)],
+//     {
+//       end: () => {
+//         ist(pm.dom.querySelectorAll("var").length, 2);
+//       },
+//     }
+//   );
+//   ist(pm.state.doc, doc(p("b")), eq);
+// });
+// it("cancels composition when a change fully overlaps with it", () => {
+//   const { view: pm } = requireFocus(
+//     tempEditor({ doc: doc(p("one"), p("two"), p("three")) })
+//   );
+//   compose(
+//     pm,
+//     () => edit(findTextNode(pm.dom, "two")!, "x"),
+//     [() => pm.dispatch(pm.state.tr.insertText("---", 3, 13))],
+//     { cancel: true }
+//   );
+//   ist(pm.state.doc, doc(p("on---hree")), eq);
+// });
+// it("cancels composition when a change partially overlaps with it", () => {
+//   const { view: pm } = requireFocus(
+//     tempEditor({ doc: doc(p("one"), p("two"), p("three")) })
+//   );
+//   compose(
+//     pm,
+//     () => edit(findTextNode(pm.dom, "two")!, "x", 0),
+//     [() => pm.dispatch(pm.state.tr.insertText("---", 7, 15))],
+//     { cancel: true }
+//   );
+//   ist(pm.state.doc, doc(p("one"), p("x---ee")), eq);
+// });
+// it("cancels composition when a change happens inside of it", () => {
+//   const { view: pm } = requireFocus(
+//     tempEditor({ doc: doc(p("one"), p("two"), p("three")) })
+//   );
+//   compose(
+//     pm,
+//     () => edit(findTextNode(pm.dom, "two")!, "x", 0),
+//     [() => pm.dispatch(pm.state.tr.insertText("!", 7, 8))],
+//     { cancel: true }
+//   );
+//   ist(pm.state.doc, doc(p("one"), p("x!wo"), p("three")), eq);
+// });
+// it("doesn't cancel composition when a change happens elsewhere", () => {
+//   const { view: pm } = requireFocus(
+//     tempEditor({ doc: doc(p("one"), p("two"), p("three")) })
+//   );
+//   compose(pm, () => edit(findTextNode(pm.dom, "two")!, "x", 0), [
+//     (n) => edit(n, "y", 1),
+//     () => pm.dispatch(pm.state.tr.insertText("!", 2, 3)),
+//     (n) => edit(n, "z", 2),
+//   ]);
+//   ist(pm.state.doc, doc(p("o!e"), p("xyztwo"), p("three")), eq);
+// });
+// it("handles compositions rapidly following each other", () => {
+//   const { view: pm } = tempEditor({ doc: doc(p("one"), p("two")) });
+//   event(pm, "compositionstart");
+//   const one = findTextNode(pm.dom, "one")!;
+//   edit(one, "!");
+//   pm.domObserver.flush();
+//   event(pm, "compositionend");
+//   one.nodeValue = "one!!";
+//   const L2 = pm.dom.lastChild;
+//   event(pm, "compositionstart");
+//   const two = findTextNode(pm.dom, "two")!;
+//   ist(pm.dom.lastChild, L2);
+//   edit(two, ".");
+//   pm.domObserver.flush();
+//   ist(document.getSelection()!.focusNode, two);
+//   ist(document.getSelection()!.focusOffset, 4);
+//   ist(pm.composing);
+//   event(pm, "compositionend");
+//   pm.domObserver.flush();
+//   ist(pm.state.doc, doc(p("one!!"), p("two.")), eq);
+// });
+// function crossParagraph(first = false) {
+//   const { view: pm } = requireFocus(
+//     tempEditor({ doc: doc(p("one <a>two"), p("three"), p("four<b> five")) })
+//   );
+//   compose(
+//     pm,
+//     () => {
+//       for (let i = 0; i < 2; i++)
+//         pm.dom.removeChild(first ? pm.dom.lastChild! : pm.dom.firstChild!);
+//       const target = pm.dom.firstChild!.firstChild as Text;
+//       target.nodeValue = "one A five";
+//       document.getSelection()!.collapse(target, 4);
+//       return target;
+//     },
+//     [(n) => edit(n, "B", 4, 5), (n) => edit(n, "C", 4, 5)]
+//   );
+//   ist(pm.state.doc, doc(p("one C five")), eq);
+// }
+// it("can handle cross-paragraph compositions", () => crossParagraph(true));
+// it("can handle cross-paragraph compositions (keeping the last paragraph)", () =>
+//   crossParagraph(false));
+});