4f:I[314491,["/_next/static/immutable/chunks/3arlv5bvukoo2.js","/_next/static/immutable/chunks/39v64hmfyo-sr.js","/_next/static/immutable/chunks/2nvof3-29tvc3.js","/_next/static/immutable/chunks/3tjobt77z_9dj.js","/_next/static/immutable/chunks/04j_o97cgxn2x.js","/_next/static/immutable/chunks/3upr08c9vtj8w.js","/_next/static/immutable/chunks/1ww0328si-u8x.js","/_next/static/immutable/chunks/11mfl5ymqld9-.js","/_next/static/immutable/chunks/2xxcqy6ppds3l.js","/_next/static/immutable/chunks/3j06ow7w40nxu.js","/_next/static/immutable/chunks/31nn7jwsjvqii.js","/_next/static/immutable/chunks/43_s7jweyypoh.js","/_next/static/immutable/chunks/0p6vao205o1jc.js","/_next/static/immutable/chunks/1_kyvgkyokw92.js","/_next/static/immutable/chunks/1lo-zn37dolb5.js","/_next/static/immutable/chunks/1v8k6yxw1rg0u.js"],"FilesView"] 50:T446d,--- title: Node description: API reference for nodes in Plate. --- Nodes are the building blocks of Plate documents. It can either be the Editor root node (highest), an Element node, or a Text node (lowest). This API provides utilities for interacting with nodes, including traversing, querying, and extracting data. ```ts type TNode = Editor | TElement | TText; type Descendant = Element | Text type Ancestor = Editor | Element ``` - [Editor](/docs/api/slate/editor-api) - [Element](/docs/api/slate/element) - [Text](/docs/api/slate/text) ## `NodeAPI` ### `ancestor` Get the node at a specific path, asserting that it's an ancestor node. The root node to start from. The path to the ancestor node. The ancestor node if found, or `undefined` if not found. ### `ancestors` Return a generator of all the ancestor nodes above a specific path. The root node to start from. The path to get ancestors for. Options for ancestor retrieval. If true, returns ancestors top-down instead of bottom-up. A generator of ancestor node entries. ### `child` Get the child of a node at a specific index. The parent node. The index of the child. The child node if found, or `undefined` otherwise. ### `children` Iterate over the children of a node at a specific path. The root node. The path to the parent node. Options for iterating over children. If true, iterates in reverse order. Start index (inclusive). End index (exclusive). A generator of child node entries. ### `common` Get an entry for the common ancestor node of two paths. The root node. First path. Second path. The common ancestor entry if found, or `undefined` otherwise. ### `descendant` Get the node at a specific path, asserting that it's a descendant node. The root node. The path to the descendant. The descendant node if found, or `undefined` otherwise. ### `descendants` Return a generator of all the descendant node entries inside a root node. The root node. Options for descendant retrieval. Starting path. Ending path. If true, iterates in reverse order. A function to filter descendants. A generator of descendant node entries. ### `elements` Return a generator of all the element nodes inside a root node. The root node. Options for element retrieval. A function to filter elements. If true, iterates in reverse order. Starting path. Ending path. A generator of element entries. ### `first` Get the first node entry in a root node from a path. The root node. The path to the node. The first node entry if found, or `undefined` otherwise. ### `firstChild` Get the first child node entry of a node. The parent node. The path to the parent node. The first child node entry if found, or `undefined` otherwise. ### `firstText` Get the first text node entry of a node. The parent node. The path to the parent node. The first text node entry if found, or `undefined` otherwise. ### `fragment` Get the sliced fragment represented by a range inside a root node. The root node. The range to slice. The sliced fragment. ### `get` Get the descendant node referred to by a specific path. The root node. The path to the node. The node if found, or `undefined` otherwise. ### `last` Get the last node entry in a root node from a path. The root node. The path to the node. The last node entry if found, or `undefined` otherwise. ### `lastChild` Get the last child node entry of a node. The parent node. The path to the parent node. The last child node entry if found, or `undefined` otherwise. ### `leaf` Get the node at a specific path, ensuring it's a leaf text node. The root node. The path to the node. The leaf node if found, or `undefined` otherwise. ### `levels` Return a generator of the in a branch of the tree, from a specific path. The root node. The path to the node. A generator of node entries in a branch of the tree from a specific path. ### `nodes` Return a generator of all the node entries of a root node. The root node. Similar options to `descendants`. A generator of node entries. ### `parent` Get the parent of a node at a specific path. The root node. The path to the node. The parent node if found, or `undefined` otherwise. ### `texts` Return a generator of all leaf text nodes in a root node. The root node. Options for text node retrieval. A generator of text node entries. ### `extractProps` Get the props of a node. The node to extract props from. The props of the node. ### `has` Check if a descendant node exists at a specific path. The root node. The path to check. `true` if a node exists at the specified path, `false` otherwise. ### `hasSingleChild` Check if a node has a single child. The node to check. `true` if the node has a single child. ### `isAncestor` Check if a value implements the `Ancestor` interface. The value to check. `true` if the value implements the `Ancestor` interface. ### `isDescendant` Check if a value implements the `Descendant` interface. The value to check. `true` if the value implements the `Descendant` interface. ### `isLastChild` Check if a node is the last child of its parent. The root node. The path to the node. `true` if the node is the last child of its parent. ### `isNode` Check if a value implements the `TNode` interface. The value to check. `true` if the value implements the `TNode` interface. ### `isNodeList` Check if a value is a list of `Descendant` objects. The value to check. `true` if the value is a list of `Descendant` objects. ### `matches` Check if a node matches a set of props. The node to check. The properties to match against. `true` if the node matches the provided properties. ### `string` Get the concatenated text string of a node's content. The node to get text from. The concatenated text content. ## Types ### `TNode` `Node` is a type alias for `TNode`. ```ts type TNode = Editor | TElement | TText; ``` ### `NodeEntry` `NodeEntry` objects are returned when iterating over the nodes in a Plate document tree. They consist of an array with two elements: the `TNode` and its `Path` relative to the root node in the document. The node itself. The path to the node. ### `Descendant` The `Descendant` union type represents nodes that are descendants in the tree. ```ts type Descendant = TElement | TText; ``` ### `Ancestor` The `Ancestor` union type represents nodes that are ancestors in the tree. ```ts type Ancestor = Editor | TElement; ``` ### `NodeOf` The node to get the type of. The node type. ### `NodeIn` The value to get node types from. All possible node types from the specified value. ### `TNodeMatch` The node to match. `true` if the node matches the predicate. ### `DescendantOf` The node to get descendant types from. All possible descendant node types from the specified root node. ### `DescendantIn` The value to get descendant types from. All possible descendant node types from the specified value. ### `ChildOf` The node to get the child type from. The child node type. ### `AncestorOf` The node to get ancestor types from. All possible ancestor node types from the specified root node. ### `AncestorIn` The value to get ancestor types from. All possible ancestor node types from the specified value. ### `AncestorEntry` Ancestor entries represent an ancestor node (Editor or Element) and its path. The Editor or Element node. The path to the ancestor. ### `DescendantEntry` Descendant entries represent a descendant node (Element or Text) and its path. The Element or Text node. The path to the descendant. ### `NodeChildEntry` Node child entries represent a child node and its path relative to its parent. The child node. The path to the child. 4e:["$","div",null,{"className":"mt-3 flex min-h-0 min-w-0 flex-1 flex-col gap-3","children":[null,["$","$L4f",null,{"files":[{"path":"../../content/docs/api/slate/node.mdx","content":"$50","type":"registry:file","target":"content/docs/plate/api/slate/node.mdx"}],"className":"h-[70svh] min-h-80"}]]}]