Add hanging option to unsetNodes (#5189)

Since this really just calls setNodes, it seems like it should offer the same options. Without this change, doing something like applying a mark to the contents of a selected block with `hanging` works one way, while trying to do the reverse (remove the mark) cannot include the "hang".
ianstormtaylor · Nov 17, 2022 · fbc9838 · fbc9838
1 parent 6909a8f
commit fbc9838
Show file tree

Hide file tree

Showing 3 changed files with 8 additions and 1 deletion.
diff --git a/.changeset/light-moose-jam.md b/.changeset/light-moose-jam.md
@@ -0,0 +1,5 @@
+---
+'slate': patch
+---
+
+Add hanging option to unsetNodes so it matches setNodes
diff --git a/docs/api/transforms.md b/docs/api/transforms.md
@@ -101,7 +101,7 @@ Options supported: `NodeOptions & {hanging?: boolean, split?: boolean}`. For `op
 
 Unset properties of nodes at the specified location. If no location is specified, use the selection.
 
-Options supported: `NodeOptions & {split?: boolean}`. For `options.mode`, `'all'` is also supported.
+Options supported: `NodeOptions & {hanging?: boolean, split?: boolean}`. For `options.mode`, `'all'` is also supported.
 
 #### `Transforms.liftNodes(editor: Editor, options?)`
 

diff --git a/packages/slate/src/transforms/node.ts b/packages/slate/src/transforms/node.ts
@@ -100,6 +100,7 @@ export interface NodeTransforms {
       at?: Location
       match?: NodeMatch<T>
       mode?: MaximizeMode
+      hanging?: boolean
       split?: boolean
       voids?: boolean
     }
@@ -825,6 +826,7 @@ export const NodeTransforms: NodeTransforms = {
       at?: Location
       match?: NodeMatch<T>
       mode?: MaximizeMode
+      hanging?: boolean
       split?: boolean
       voids?: boolean
     } = {}