docs

udecode · Dec 18, 2024 · 68a0f3a · 68a0f3a
1 parent 4c8ffab
commit 68a0f3a
Show file tree

Hide file tree

Showing 3 changed files with 26 additions and 0 deletions.
diff --git a/.changeset/friendly-cooks-add.md b/.changeset/friendly-cooks-add.md
@@ -0,0 +1,5 @@
+---
+'@udecode/slate-utils': patch
+---
+
+Add `getFirstNodeText`
diff --git a/.changeset/happy-buses-glow.md b/.changeset/happy-buses-glow.md
@@ -0,0 +1,5 @@
+---
+'@udecode/slate': patch
+---
+
+export type NodeTextsOptions
diff --git a/apps/www/content/docs/api/slate-utils.mdx b/apps/www/content/docs/api/slate-utils.mdx
@@ -130,6 +130,22 @@ Retrieves a consistent property value from a fragment of nodes.
   The consistent property value found in the fragment, or undefined if no consistent value is found.
 </APIReturns>
 
+### getFirstNodeText
+
+Gets the first text node from a node.
+
+<APIParameters>
+  <APIItem name="root" type="TNode">
+    The root node to search for text nodes.
+  </APIItem>
+  <APIItem name="options" type="NodeTextsOptions<N, R>" optional>
+    Options for getting node texts.
+  </APIItem>
+</APIParameters>
+<APIReturns>
+  Returns the first text node entry or `undefined` if no text nodes are found.
+</APIReturns>
+
 ### getLastChild
 
 Returns the last child of a node or `null` if no children.