Fix white spaces not being preserved when pasted into editor

slab · Jul 18, 2024 · 87967e6 · 87967e6
1 parent 5d752e3
commit 87967e6
Show file tree

Hide file tree

Showing 2 changed files with 56 additions and 10 deletions.
diff --git a/packages/quill/src/modules/clipboard.ts b/packages/quill/src/modules/clipboard.ts
@@ -364,18 +364,48 @@ function isBetweenInlineElements(node: HTMLElement, scroll: ScrollBlot) {
   );
 }
 
-const preNodes = new WeakMap();
-function isPre(node: Node | null) {
-  if (node == null) return false;
-  if (!preNodes.has(node)) {
-    // @ts-expect-error
+enum WhiteSpaceStyle {
+  Collapsed,
+  Preserved,
+  Inherited,
+}
+const getWhiteSpaceStyle = (node: Node) => {
+  if (node instanceof HTMLElement) {
+    const { whiteSpace } = node.style;
+    if (
+      whiteSpace === 'pre' ||
+      whiteSpace === 'pre-wrap' ||
+      whiteSpace === 'break-spaces'
+    ) {
+      return WhiteSpaceStyle.Preserved;
+    }
+    if (whiteSpace && whiteSpace !== 'inherit') {
+      return WhiteSpaceStyle.Collapsed;
+    }
     if (node.tagName === 'PRE') {
-      preNodes.set(node, true);
-    } else {
-      preNodes.set(node, isPre(node.parentNode));
+      return WhiteSpaceStyle.Preserved;
     }
   }
-  return preNodes.get(node);
+  return WhiteSpaceStyle.Inherited;
+};
+
+const whiteSpacePreservedNodes = new WeakMap();
+function getShouldPreserveWhiteSpaces(node: Node | null) {
+  if (node == null) return false;
+
+  if (!whiteSpacePreservedNodes.has(node)) {
+    let shouldPreserve = false;
+
+    const style = getWhiteSpaceStyle(node);
+    if (style === WhiteSpaceStyle.Preserved) {
+      shouldPreserve = true;
+    } else if (style === WhiteSpaceStyle.Inherited) {
+      shouldPreserve = getShouldPreserveWhiteSpaces(node.parentNode);
+    }
+
+    whiteSpacePreservedNodes.set(node, shouldPreserve);
+  }
+  return whiteSpacePreservedNodes.get(node);
 }
 
 function traverse(
@@ -631,7 +661,7 @@ function matchText(node: HTMLElement, delta: Delta, scroll: ScrollBlot) {
   if (node.parentElement?.tagName === 'O:P') {
     return delta.insert(text.trim());
   }
-  if (!isPre(node)) {
+  if (!getShouldPreserveWhiteSpaces(node)) {
     if (
       text.trim().length === 0 &&
       text.includes('\n') &&

diff --git a/packages/quill/test/unit/modules/clipboard.spec.ts b/packages/quill/test/unit/modules/clipboard.spec.ts
@@ -361,6 +361,22 @@ describe('Clipboard', () => {
       );
     });
 
+    test('white-space', () => {
+      const html = '<span style="white-space:pre">0  1</span>';
+      expect(createClipboard().convert({ html })).toEqual(
+        new Delta().insert('0  1'),
+      );
+    });
+
+    test('white-space with nested levels', () => {
+      const html = `
+        <div style="white-space:pre"><span>0  1</span><span style="white-space:normal">0  1</span><span style="white-space:inherit">0  1</span></div>
+      `;
+      expect(createClipboard().convert({ html })).toEqual(
+        new Delta().insert('0  10 10  1'),
+      );
+    });
+
     test('nested list', () => {
       const delta = createClipboard().convert({
         html: '<ol><li>One</li><li class="ql-indent-1">Alpha</li></ol>',