Merge empty prev nodes for list item and blockquote

.changeset/tall-hats-hide.md

@@ -0,0 +1,6 @@
+---
+"@udecode/plate-block-quote": patch
+"@udecode/plate-indent-list": patch
+---
+
+The behivor abnormal when deleting back to empty list item or quote

package.json

@@ -134,7 +134,7 @@
     "react-is": "18.2.0",
     "react-test-renderer": "18.2.0",
     "rimraf": "^5.0.5",
-    "slate": "0.102.0",
+    "slate": "0.103.0",
     "slate-history": "0.100.0",
     "slate-hyperscript": "0.100.0",
     "slate-react": "0.102.0",

packages/block-quote/src/createBlockquotePlugin.ts

@@ -4,6 +4,8 @@ import {
   onKeyDownToggleElement,
 } from '@udecode/plate-common';
 
+import { withBlockquote } from './withBlockquote';
+
 export const ELEMENT_BLOCKQUOTE = 'blockquote';
 
 /**
@@ -13,6 +15,7 @@ export const ELEMENT_BLOCKQUOTE = 'blockquote';
 export const createBlockquotePlugin = createPluginFactory<HotkeyPlugin>({
   key: ELEMENT_BLOCKQUOTE,
   isElement: true,
+  withOverrides: withBlockquote,
   deserializeHtml: {
     rules: [
       {

packages/block-quote/src/index.ts

@@ -3,3 +3,4 @@
  */
 
 export * from './createBlockquotePlugin';
+export * from './withBlockquote';

packages/block-quote/src/withBlockquote.ts

@@ -0,0 +1,24 @@
+import { PlateEditor, TElement, Value } from '@udecode/plate-common';
+
+import { ELEMENT_BLOCKQUOTE } from './createBlockquotePlugin';
+
+export const withBlockquote = <
+  V extends Value = Value,
+  E extends PlateEditor<V> = PlateEditor<V>,
+>(
+  editor: E
+) => {
+  const { shouldMergeNodesRemovePrevNode } = editor;
+
+  if (!!shouldMergeNodesRemovePrevNode) {
+    editor.shouldMergeNodesRemovePrevNode = (prevNodeEntry, curNodeEntry) => {
+      const prevNode = prevNodeEntry[0] as TElement;
+
+      if (prevNode.type === ELEMENT_BLOCKQUOTE) return false;
+
+      return shouldMergeNodesRemovePrevNode(prevNodeEntry, curNodeEntry);
+    };
+  }
+
+  return editor;
+};

packages/indent-list/src/index.ts

@@ -8,7 +8,6 @@ export * from './normalizeIndentList';
 export * from './onKeyDownIndentList';
 export * from './types';
 export * from './withIndentList';
-export * from './delete-backward/index';
 export * from './hooks/index';
 export * from './normalizers/index';
 export * from './queries/index';

packages/indent-list/src/delete-backward/deleteBackwardIndentList.ts → packages/indent-list/src/normalizers/deleteBackwardIndentList.ts

@@ -17,20 +17,17 @@ export const deleteBackwardIndentList = <V extends Value>(
   const { deleteBackward } = editor;
 
   return function (unit: TextUnit) {
-    deleteBackwardHelper(editor);
-    deleteBackward(unit);
-  };
-};
+    const nodeEntry = getAboveNode(editor);
+    if (!nodeEntry) return deleteBackward(unit);
+
+    const listNode = nodeEntry[0];
+    if (isCollapsed(editor.selection) && getNodeString(listNode))
+      return deleteBackward(unit);
 
-function deleteBackwardHelper<V extends Value>(editor: PlateEditor<V>) {
-  if (isCollapsed(editor.selection)) {
-    const str = getNodeString(editor);
-    if (str) return;
-    const entry = getAboveNode(editor);
-    if (!entry) return;
-    const node = entry[0];
-    if (isDefined(node[KEY_LIST_STYLE_TYPE])) {
-      outdentList(editor);
+    if (isDefined(listNode[KEY_LIST_STYLE_TYPE])) {
+      return outdentList(editor);
     }
-  }
-}
+
+    return deleteBackward(unit);
+  };
+};

packages/indent-list/src/normalizers/index.ts

@@ -2,6 +2,8 @@
  * @file Automatically generated by barrelsby.
  */
 
+export * from './deleteBackwardIndentList';
 export * from './normalizeFirstIndentListStart';
 export * from './normalizeIndentListNotIndented';
 export * from './normalizeIndentListStart';
+export * from './shouldMergeNodesRemovePrevNodeIndentList';

packages/indent-list/src/normalizers/shouldMergeNodesRemovePrevNodeIndentList.ts

@@ -0,0 +1,24 @@
+import { isDefined, PlateEditor, TElement, Value } from '@udecode/plate-common';
+import { NodeEntry } from 'slate';
+
+import { KEY_LIST_STYLE_TYPE } from '../createIndentListPlugin';
+
+export const shouldMergeNodesRemovePrevNodeIndentList = <V extends Value>(
+  editor: PlateEditor<V>
+) => {
+  const { shouldMergeNodesRemovePrevNode } = editor;
+
+  return function (prevEntry: NodeEntry, curNodeEntry: NodeEntry): boolean {
+    const prevNode = prevEntry[0] as TElement;
+    const curNode = curNodeEntry[0] as TElement;
+
+    if (
+      isDefined(curNode[KEY_LIST_STYLE_TYPE]) ||
+      isDefined(prevNode[KEY_LIST_STYLE_TYPE])
+    ) {
+      return false;
+    }
+
+    return shouldMergeNodesRemovePrevNode(prevEntry, curNodeEntry);
+  };
+};

packages/indent-list/src/withIndentList.spec.tsx

@@ -30,7 +30,10 @@ describe('normalizeIndentList', () => {
           <hp indent={1} listStyleType="decimal">
             1
           </hp>
-          <hp indent={1} listStyleType="decimal" listStart={2}>
+          <hp>
+            <cursor />
+          </hp>
+          <hp indent={1} listStyleType="decimal">
             1
           </hp>
         </editor>

packages/indent-list/src/withIndentList.ts

@@ -13,8 +13,11 @@ import {
   IndentListPlugin,
   KEY_LIST_STYLE_TYPE,
 } from './createIndentListPlugin';
-import { deleteBackwardIndentList } from './delete-backward/deleteBackwardIndentList';
 import { normalizeIndentList } from './normalizeIndentList';
+import {
+  deleteBackwardIndentList,
+  shouldMergeNodesRemovePrevNodeIndentList,
+} from './normalizers';
 import { normalizeIndentListStart } from './normalizers/normalizeIndentListStart';
 import { getNextIndentList } from './queries/getNextIndentList';
 import { getPreviousIndentList } from './queries/getPreviousIndentList';
@@ -35,6 +38,14 @@ export const withIndentList = <
 
   editor.deleteBackward = deleteBackwardIndentList(editor);
 
+  /**
+   * To prevent users without upgraded Slate version from experiencing anomalies.
+   */
+  if (!!editor.shouldMergeNodesRemovePrevNode) {
+    editor.shouldMergeNodesRemovePrevNode =
+      shouldMergeNodesRemovePrevNodeIndentList(editor);
+  }
+
   editor.apply = (operation) => {
     const { path } = operation as any;
 

yarn.lock

@@ -5901,7 +5901,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@udecode/plate-indent-list@npm:31.2.2, @udecode/plate-indent-list@workspace:^, @udecode/plate-indent-list@workspace:packages/indent-list":
+"@udecode/plate-indent-list@npm:31.4.0, @udecode/plate-indent-list@workspace:^, @udecode/plate-indent-list@workspace:packages/indent-list":
   version: 0.0.0-use.local
   resolution: "@udecode/plate-indent-list@workspace:packages/indent-list"
   dependencies:
@@ -6187,13 +6187,13 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@udecode/plate-serializer-csv@npm:31.3.3, @udecode/plate-serializer-csv@workspace:^, @udecode/plate-serializer-csv@workspace:packages/serializer-csv":
+"@udecode/plate-serializer-csv@npm:31.4.0, @udecode/plate-serializer-csv@workspace:^, @udecode/plate-serializer-csv@workspace:packages/serializer-csv":
   version: 0.0.0-use.local
   resolution: "@udecode/plate-serializer-csv@workspace:packages/serializer-csv"
   dependencies:
     "@types/papaparse": "npm:^5.3.14"
     "@udecode/plate-common": "workspace:^"
-    "@udecode/plate-table": "npm:31.3.3"
+    "@udecode/plate-table": "npm:31.4.0"
     papaparse: "npm:^5.4.1"
   peerDependencies:
     "@udecode/plate-common": ">=31.3.2"
@@ -6206,17 +6206,17 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@udecode/plate-serializer-docx@npm:31.3.3, @udecode/plate-serializer-docx@workspace:^, @udecode/plate-serializer-docx@workspace:packages/serializer-docx":
+"@udecode/plate-serializer-docx@npm:31.4.0, @udecode/plate-serializer-docx@workspace:^, @udecode/plate-serializer-docx@workspace:packages/serializer-docx":
   version: 0.0.0-use.local
   resolution: "@udecode/plate-serializer-docx@workspace:packages/serializer-docx"
   dependencies:
     "@udecode/plate-common": "workspace:^"
     "@udecode/plate-heading": "npm:31.0.0"
     "@udecode/plate-indent": "npm:31.1.0"
-    "@udecode/plate-indent-list": "npm:31.2.2"
+    "@udecode/plate-indent-list": "npm:31.4.0"
     "@udecode/plate-media": "npm:31.0.0"
     "@udecode/plate-paragraph": "npm:31.0.0"
-    "@udecode/plate-table": "npm:31.3.3"
+    "@udecode/plate-table": "npm:31.4.0"
     validator: "npm:^13.11.0"
   peerDependencies:
     "@udecode/plate-common": ">=31.3.2"
@@ -6247,7 +6247,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@udecode/plate-serializer-md@npm:31.3.4, @udecode/plate-serializer-md@workspace:^, @udecode/plate-serializer-md@workspace:packages/serializer-md":
+"@udecode/plate-serializer-md@npm:31.4.0, @udecode/plate-serializer-md@workspace:^, @udecode/plate-serializer-md@workspace:packages/serializer-md":
   version: 0.0.0-use.local
   resolution: "@udecode/plate-serializer-md@workspace:packages/serializer-md"
   dependencies:
@@ -6309,7 +6309,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@udecode/plate-table@npm:31.3.3, @udecode/plate-table@workspace:^, @udecode/plate-table@workspace:packages/table":
+"@udecode/plate-table@npm:31.4.0, @udecode/plate-table@workspace:^, @udecode/plate-table@workspace:packages/table":
   version: 0.0.0-use.local
   resolution: "@udecode/plate-table@workspace:packages/table"
   dependencies:
@@ -6335,7 +6335,7 @@ __metadata:
   languageName: unknown
   linkType: soft
 
-"@udecode/plate-toggle@npm:31.1.0, @udecode/plate-toggle@workspace:^, @udecode/plate-toggle@workspace:packages/toggle":
+"@udecode/plate-toggle@npm:31.4.0, @udecode/plate-toggle@workspace:^, @udecode/plate-toggle@workspace:packages/toggle":
   version: 0.0.0-use.local
   resolution: "@udecode/plate-toggle@workspace:packages/toggle"
   dependencies:
@@ -6464,7 +6464,7 @@ __metadata:
     "@udecode/plate-highlight": "npm:31.0.0"
     "@udecode/plate-horizontal-rule": "npm:31.0.0"
     "@udecode/plate-indent": "npm:31.1.0"
-    "@udecode/plate-indent-list": "npm:31.2.2"
+    "@udecode/plate-indent-list": "npm:31.4.0"
     "@udecode/plate-kbd": "npm:31.0.0"
     "@udecode/plate-line-height": "npm:31.0.0"
     "@udecode/plate-link": "npm:31.0.0"
@@ -6477,14 +6477,14 @@ __metadata:
     "@udecode/plate-reset-node": "npm:31.0.0"
     "@udecode/plate-resizable": "npm:31.0.0"
     "@udecode/plate-select": "npm:31.0.0"
-    "@udecode/plate-serializer-csv": "npm:31.3.3"
-    "@udecode/plate-serializer-docx": "npm:31.3.3"
+    "@udecode/plate-serializer-csv": "npm:31.4.0"
+    "@udecode/plate-serializer-docx": "npm:31.4.0"
     "@udecode/plate-serializer-html": "npm:31.1.0"
-    "@udecode/plate-serializer-md": "npm:31.3.4"
+    "@udecode/plate-serializer-md": "npm:31.4.0"
     "@udecode/plate-suggestion": "npm:31.0.0"
     "@udecode/plate-tabbable": "npm:31.0.0"
-    "@udecode/plate-table": "npm:31.3.3"
-    "@udecode/plate-toggle": "npm:31.1.0"
+    "@udecode/plate-table": "npm:31.4.0"
+    "@udecode/plate-toggle": "npm:31.4.0"
     "@udecode/plate-trailing-block": "npm:31.0.0"
   peerDependencies:
     react: ">=16.8.0"
@@ -18089,7 +18089,7 @@ __metadata:
     react-is: "npm:18.2.0"
     react-test-renderer: "npm:18.2.0"
     rimraf: "npm:^5.0.5"
-    slate: "npm:0.102.0"
+    slate: "npm:0.103.0"
     slate-history: "npm:0.100.0"
     slate-hyperscript: "npm:0.100.0"
     slate-react: "npm:0.102.0"
@@ -18561,6 +18561,17 @@ __metadata:
   languageName: node
   linkType: hard
 
+"slate@npm:0.103.0":
+  version: 0.103.0
+  resolution: "slate@npm:0.103.0"
+  dependencies:
+    immer: "npm:^10.0.3"
+    is-plain-object: "npm:^5.0.0"
+    tiny-warning: "npm:^1.0.3"
+  checksum: 10c0/5cde24650d71fb449382305c082310404560a73135510fc3d83bae680c5fc6e1db18347a58186f63efbc3342fd4ff4e447c134301f48683cdef312c87988ce0c
+  languageName: node
+  linkType: hard
+
 "slick@npm:^1.12.2":
   version: 1.12.2
   resolution: "slick@npm:1.12.2"