traverse-dom v3.0.0

traverse-dom

Simple DOM traversal method with some tolerance for modification of the element tree during traversal. Intended to be more performant than NodeIterator (due to lack of setup cost), but less full-featured.

Installing traverse-dom via npm

$ npm install --save traverse-dom

Installing traverse-dom via yarn

$ yarn add traverse-dom

Usage

import { traverse } from 'traverse-dom';
traverse(myElement, (child) => { mutateElement(child) });

import { traverseMap } from 'traverse-dom';
const allNodeNames = traverseMap(myElement, (child) => child.nodeName);

API

traverse(element, callback, shouldRecurse=false)

Goes through all the child elements of the provided element and calls the callback with the current child. If shouldRecurse is true does a deep traversal. If shouldRecurse is a function it will be called on each element to provide fine control over what element's children to traverse.

usage example: moving elements outside of another element.

Arguments

1. element: Element - Element to traverse children of.
2. callback: (child: Element) => void - Callback to pass each child element.
3. shouldRecurse: boolean | (child: Element) => boolean = false - Set to traverse deeper than immediate children of element.

Returns

Element - Returns the same element the function was called with.

traverseNodes(node, callback, shouldRecurse=false)

Same as traverse but traverses nodes not just elements.

Arguments

1. node: Node - Node to traverse children of.
2. callback: (child: Node) => void - Callback to pass each child node.
3. shouldRecurse: boolean | (child: Node) => boolean = false - Set to traverse deeper than immediate children of node.

Returns

Node - Returns the same node the function was called with.

traverseMap

Creates an array of values by running each children of the passed node through the callback. Callback is invoked with the child node.

usage example: Collecting all the node names recursively.

Arguments

1. node: Node - Node to traverse children of.
2. callback: (child: Node) => T - The function invoked per iteration.
3. shouldRecurse: boolean | (child: Node) => boolean = false - Set to traverse deeper than immediate children of node.

Returns

Array<T> - Returns the new mapped array.

traverseReduce

Reduces the node's children to a value which is the accumulated result of running each node thru callback where each successive invocation is supplied the return value of the previous.

usage example: collecting all the node names recursively while filtering the result.

Arguments

1. node: Node - Node to traverse children of.
2. callback: (child: Node) => T - The function invoked per iteration.
3. acc: T - The initial value.
4. shouldRecurse: boolean | (child: Node) => boolean = false - Set to traverse deeper than immediate children of node.

Returns

T - Returns the accumulated value.

Contributing to traverse-dom

See the Contribution guide

Credits

Based on shmuga's npm module boilerplate