NodeApi.ancestor(root: Node, path: Path) => AncestorGet the node at a specific path, asserting that it is an ancestor node. If the specified node is not an ancestor node, throw an error.
Return a generator of all the ancestor nodes above a specific path. By default, the order is top-down, from highest to lowest ancestor in the tree, but you can pass the reverse: true option to go bottom-up.
Options: {reverse?: boolean}
Get the child of a node at the specified index.
Iterate over the children of a node at a specific path.
Options: {reverse?: boolean}
Get an entry for the common ancestor node of two paths. It might be a Text node, an Element, or the Editor itself.
For the common block ancestor, see selection.
Get the node at a specific path, asserting that it's a descendant node.
Return a generator of all the descendant node entries inside a root node. Each iteration will return a NodeEntry tuple consisting of [Node, Path].
Options: {from?: Path, to?: Path, reverse?: boolean, pass?: (node: NodeEntry => boolean)}
Return a generator of all the element nodes inside a root node. Each iteration will return an ElementEntry tuple consisting of [Element, Path]. If the root node is an element, it will be included in the iteration as well.
Options: {from?: Path, to?: Path, reverse?: boolean, pass?: (node: NodeEntry => boolean)}
Extract all properties from a Node except for its content-related fields (children for Element nodes and text for Text nodes).
// For an Element node
const element = {
type: "paragraph",
align: "center",
children: [{ text: "Try it out for yourself!" }],
};
const props = NodeApi.extractProps(element);
// Returns: { type: 'paragraph', align: "center" }
// For a Text node
const text = { text: "Hello", bold: true };
const props = NodeApi.extractProps(text);
// Returns: { bold: true }// For an Element node
const element = {
type: "paragraph",
align: "center",
children: [{ text: "Try it out for yourself!" }],
};
const props = NodeApi.extractProps(element);
// Returns: { type: 'paragraph', align: "center" }
// For a Text node
const text = { text: "Hello", bold: true };
const props = NodeApi.extractProps(text);
// Returns: { bold: true }Descend from path through first children until reaching a text node or an
ancestor with no children, and return that node entry.
Get the sliced fragment represented by the range.
NodeApi.findTextRanges(root: Node | NodeTextRangeRoot | NodeTextRangeView, query: NodeTextRangeQuery, options?) => readonly Range[]Find ranges for a text query inside text runs. Editor, read view, and transaction roots use their schema to join text through inline descendants without crossing block boundaries. String queries are literal. Use a regular expression or callback for custom matching.
Get the descendant node referred to by a specific path. If the path is an empty array, get the root node itself.
Get a descendant node at a specific path, returning undefined if the node does not exist. This is a safer alternative to NodeApi.get() as it won't throw an error if the path is invalid.
const node = NodeApi.getIf(root, [0, 1]);
if (node) {
// node exists at path [0, 1]
} else {
// no node exists at path [0, 1]
}const node = NodeApi.getIf(root, [0, 1]);
if (node) {
// node exists at path [0, 1]
} else {
// no node exists at path [0, 1]
}Descend from path through last children until reaching a text node or an
ancestor with no children, and return that node entry.
Get the node at a specific path, ensuring it's a leaf text node. If the node is not a leaf text node, throw an error.
Return a generator of the nodes in a branch of the tree, from a specific path. By default, the order is top-down, from the highest to the lowest node in the tree, but you can pass the reverse: true option to go bottom-up.
Options: {reverse?: boolean}
Return a generator of all the node entries of a root node. Each entry is returned as a [Node, Path] tuple, with the path referring to the node's position inside the root node.
Options: {from?: Path, to?: Path, reverse?: boolean, pass?: (node: NodeEntry => boolean)}
Get the parent of a node at a specific path.
Methods related to text leaves.
Get the concatenated text string of a node's content. Note that this will not include spaces or line breaks between block nodes. This is not intended as a user-facing string, but as a string for performing offset-related computations for a node.
Return a generator of all leaf text nodes in a root node.
Options: {from?: Path, to?: Path, reverse?: boolean, pass?: (node: NodeEntry => boolean)}
Methods used to check attributes of a node.
Check if a descendant node exists at a specific path.
Check if a node is an Editor or Element object.
Check if a node is an Editor object.
Check if a node is an Element object.
Check if a value implements the Node interface.
Check if a value is a list of Node objects.
Check if a node is a Text object.
Check a node with a predicate. The predicate receives the node's path and preserves type narrowing.
NodeApi.matches(node, (candidate, path) => {
return path.length === 1 && ElementApi.isElement(candidate)
}, path)NodeApi.matches(node, (candidate, path) => {
return path.length === 1 && ElementApi.isElement(candidate)
}, path)