{
"$schema": "https://ui.shadcn.com/schema/registry-item.json",
"name": "api-slate-node-docs",
"title": "Node",
"description": "API reference for nodes in Plate.",
"files": [
{
"path": "../../content/docs/api/slate/node.mdx",
"content": "---\ntitle: Node\ndescription: API reference for nodes in Plate.\n---\n\nNodes 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.\n\n```ts\ntype TNode = Editor | TElement | TText;\n\ntype Descendant = Element | Text\ntype Ancestor = Editor | Element\n```\n\n- [Editor](/docs/api/slate/editor-api)\n- [Element](/docs/api/slate/element)\n- [Text](/docs/api/slate/text)\n\n## `NodeAPI`\n\n### `ancestor`\n\nGet the node at a specific path, asserting that it's an ancestor node.\n\n\n\n \n The root node to start from.\n \n \n The path to the ancestor node.\n \n\n\n\n The ancestor node if found, or `undefined` if not found.\n\n\n\n### `ancestors`\n\nReturn a generator of all the ancestor nodes above a specific path.\n\n\n\n \n The root node to start from.\n \n \n The path to get ancestors for.\n \n \n Options for ancestor retrieval.\n \n\n\n\n \n If true, returns ancestors top-down instead of bottom-up.\n \n\n\n, void, undefined>\">\n A generator of ancestor node entries.\n\n\n\n### `child`\n\nGet the child of a node at a specific index.\n\n\n\n \n The parent node.\n \n \n The index of the child.\n \n\n\n\n The child node if found, or `undefined` otherwise.\n\n\n\n### `children`\n\nIterate over the children of a node at a specific path.\n\n\n\n \n The root node.\n \n \n The path to the parent node.\n \n \n Options for iterating over children.\n \n\n\n\n \n If true, iterates in reverse order.\n \n \n Start index (inclusive).\n \n \n End index (exclusive).\n \n\n\n, void, undefined>\">\n A generator of child node entries.\n\n\n\n### `common`\n\nGet an entry for the common ancestor node of two paths.\n\n\n\n \n The root node.\n \n \n First path.\n \n \n Second path.\n \n\n\n | undefined\">\n The common ancestor entry if found, or `undefined` otherwise.\n\n\n\n### `descendant`\n\nGet the node at a specific path, asserting that it's a descendant node.\n\n\n\n \n The root node.\n \n \n The path to the descendant.\n \n\n\n\n The descendant node if found, or `undefined` otherwise.\n\n\n\n### `descendants`\n\nReturn a generator of all the descendant node entries inside a root node.\n\n\n\n \n The root node.\n \n \n Options for descendant retrieval.\n \n\n\n\n \n Starting path.\n \n \n Ending path.\n \n \n If true, iterates in reverse order.\n \n boolean\" optional>\n A function to filter descendants.\n \n\n\n, void, undefined>\">\n A generator of descendant node entries.\n\n\n\n### `elements`\n\nReturn a generator of all the element nodes inside a root node.\n\n\n\n \n The root node.\n \n \n Options for element retrieval.\n \n\n\n\n boolean\" optional>\n A function to filter elements.\n \n \n If true, iterates in reverse order.\n \n \n Starting path.\n \n \n Ending path.\n \n\n\n, void, undefined>\">\n A generator of element entries.\n\n\n\n### `first`\n\nGet the first node entry in a root node from a path.\n\n\n\n \n The root node.\n \n \n The path to the node.\n \n\n\n | undefined\">\n The first node entry if found, or `undefined` otherwise.\n\n\n\n### `firstChild`\n\nGet the first child node entry of a node.\n\n\n\n \n The parent node.\n \n \n The path to the parent node.\n \n\n\n | undefined\">\n The first child node entry if found, or `undefined` otherwise.\n\n\n\n### `firstText`\n\nGet the first text node entry of a node.\n\n\n\n \n The parent node.\n \n \n The path to the parent node.\n \n\n\n | undefined\">\n The first text node entry if found, or `undefined` otherwise.\n\n\n\n### `fragment`\n\nGet the sliced fragment represented by a range inside a root node.\n\n\n\n \n The root node.\n \n \n The range to slice.\n \n\n\n\n The sliced fragment.\n\n\n\n### `get`\n\nGet the descendant node referred to by a specific path.\n\n\n\n \n The root node.\n \n \n The path to the node.\n \n\n\n\n The node if found, or `undefined` otherwise.\n\n\n\n### `last`\n\nGet the last node entry in a root node from a path.\n\n\n\n \n The root node.\n \n \n The path to the node.\n \n\n\n | undefined\">\n The last node entry if found, or `undefined` otherwise.\n\n\n\n### `lastChild`\n\nGet the last child node entry of a node.\n\n\n\n \n The parent node.\n \n \n The path to the parent node.\n \n\n\n | undefined\">\n The last child node entry if found, or `undefined` otherwise.\n\n\n\n### `leaf`\n\nGet the node at a specific path, ensuring it's a leaf text node.\n\n\n\n \n The root node.\n \n \n The path to the node.\n \n\n\n\n The leaf node if found, or `undefined` otherwise.\n\n\n\n### `levels`\n\nReturn a generator of the in a branch of the tree, from a specific path.\n\n\n\n \n The root node.\n \n \n The path to the node.\n \n\n\n, void, undefined>\">\n A generator of node entries in a branch of the tree from a specific path.\n\n\n\n### `nodes`\n\nReturn a generator of all the node entries of a root node.\n\n\n\n \n The root node.\n \n \n Similar options to `descendants`.\n \n\n\n, void, undefined>\">\n A generator of node entries.\n\n\n\n### `parent`\n\nGet the parent of a node at a specific path.\n\n\n\n \n The root node.\n \n \n The path to the node.\n \n\n\n\n The parent node if found, or `undefined` otherwise.\n\n\n\n### `texts`\n\nReturn a generator of all leaf text nodes in a root node.\n\n\n\n \n The root node.\n \n \n Options for text node retrieval.\n \n\n\n, void, undefined>\">\n A generator of text node entries.\n\n\n\n### `extractProps`\n\nGet the props of a node.\n\n\n\n \n The node to extract props from.\n \n\n\n\">\n The props of the node.\n\n\n\n### `has`\n\nCheck if a descendant node exists at a specific path.\n\n\n\n \n The root node.\n \n \n The path to check.\n \n\n\n\n `true` if a node exists at the specified path, `false` otherwise.\n\n\n\n### `hasSingleChild`\n\nCheck if a node has a single child.\n\n\n\n \n The node to check.\n \n\n\n\n `true` if the node has a single child.\n\n\n\n### `isAncestor`\n\nCheck if a value implements the `Ancestor` interface.\n\n\n\n \n The value to check.\n \n\n\n\n `true` if the value implements the `Ancestor` interface.\n\n\n\n### `isDescendant`\n\nCheck if a value implements the `Descendant` interface.\n\n\n\n \n The value to check.\n \n\n\n\n `true` if the value implements the `Descendant` interface.\n\n\n\n### `isLastChild`\n\nCheck if a node is the last child of its parent.\n\n\n\n \n The root node.\n \n \n The path to the node.\n \n\n\n\n `true` if the node is the last child of its parent.\n\n\n\n### `isNode`\n\nCheck if a value implements the `TNode` interface.\n\n\n\n \n The value to check.\n \n\n\n\n `true` if the value implements the `TNode` interface.\n\n\n\n### `isNodeList`\n\nCheck if a value is a list of `Descendant` objects.\n\n\n\n \n The value to check.\n \n\n\n\n `true` if the value is a list of `Descendant` objects.\n\n\n\n### `matches`\n\nCheck if a node matches a set of props.\n\n\n\n \n The node to check.\n \n \">\n The properties to match against.\n \n\n\n\n `true` if the node matches the provided properties.\n\n\n\n### `string`\n\nGet the concatenated text string of a node's content.\n\n\n\n \n The node to get text from.\n \n\n\n\n The concatenated text content.\n\n\n\n## Types\n\n### `TNode`\n\n`Node` is a type alias for `TNode`.\n\n```ts\ntype TNode = Editor | TElement | TText;\n```\n\n### `NodeEntry`\n\n`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.\n\n\n\n \n The node itself.\n \n \n The path to the node.\n \n\n\n\n### `Descendant`\n\nThe `Descendant` union type represents nodes that are descendants in the tree.\n\n```ts\ntype Descendant = TElement | TText;\n```\n\n\n### `Ancestor`\n\nThe `Ancestor` union type represents nodes that are ancestors in the tree.\n\n```ts\ntype Ancestor = Editor | TElement;\n```\n\n### `NodeOf`\n\n\n\n \n The node to get the type of.\n \n\n\n\n The node type.\n\n\n\n### `NodeIn`\n\n\n\n \n The value to get node types from.\n \n\n\n\">\n All possible node types from the specified value.\n\n\n\n### `TNodeMatch`\n\n\n\n \n The node to match.\n \n\n\n\n `true` if the node matches the predicate.\n\n\n\n### `DescendantOf`\n\n\n\n \n The node to get descendant types from.\n \n\n\n\">\n All possible descendant node types from the specified root node.\n\n\n\n### `DescendantIn`\n\n\n\n \n The value to get descendant types from.\n \n\n\n\">\n All possible descendant node types from the specified value.\n\n\n\n### `ChildOf`\n\n\n\n \n The node to get the child type from.\n \n\n\n\">\n The child node type.\n\n\n\n### `AncestorOf`\n\n\n\n \n The node to get ancestor types from.\n \n\n\n\">\n All possible ancestor node types from the specified root node.\n\n\n\n### `AncestorIn`\n\n\n\n \n The value to get ancestor types from.\n \n\n\n\">\n All possible ancestor node types from the specified value.\n\n\n\n### `AncestorEntry`\n\nAncestor entries represent an ancestor node (Editor or Element) and its path.\n\n\n\n \n The Editor or Element node.\n \n \n The path to the ancestor.\n \n\n\n\n### `DescendantEntry`\n\nDescendant entries represent a descendant node (Element or Text) and its path.\n\n\n\n \n The Element or Text node.\n \n \n The path to the descendant.\n \n\n\n\n### `NodeChildEntry`\n\nNode child entries represent a child node and its path relative to its parent.\n\n\n\n \n The child node.\n \n \n The path to the child.\n \n\n",
"type": "registry:file",
"target": "content/docs/plate/api/slate/node.mdx"
}
],
"type": "registry:file"
}