Traverse and other utils on top of React fiber tree
import React from "react";
import { render } from "react-dom";
import { findNodeByComponentName, Utils } from "react-fiber-traverse";
// Sample component
// Say, if SomeComponentName looks like this -
function SomeComponentName() {
return <div>Some text</div>;
}
// Render component
const rootElement = document.getElementById("root");
render(<SomeComponentName />, rootElement);
// Get root node
const rootFiberNode = Utils.getRootFiberNodeFromDOM(rootElement);
// Get component node
const someFiberNode = findNodeByComponentName(
rootFiberNode,
"SomeComponentName"
); // <- returns FiberNode for first usage of 'SomeComponentName'
console.log(someFiberNode.child.stateNode); // <- returns reference to the div
console.log(someFiberNode.child.stateNode.innerText); // <- returns 'Some text'$ npm install react-fiber-traverse --save
There are also UMD builds available via unpkg:
- https://unpkg.com/react-fiber-traverse/dist/react-fiber-traverse.umd.development.js
- https://unpkg.com/react-fiber-traverse/dist/react-fiber-traverse.umd.production.js
For the non-minified development version, make sure you have already included:
For the minified production version, make sure you have already included:
This package contains few utility functions which operate over react-fiber tree.
Overall characteristics are:
- Only read-only operations
- Support inversion of control
There are few categories of helpers, each with their variations:
- Find node(s)
- Traverse node
- Others - Check node type, find root node, etc.
Little more info is present in docs section.
Currently, it assumes that nodes are created by react 16.3+ with appropriate react-dom.
Because fiber nodes are internal to react and are supported by multiple renderers, this is an incorrect assumption to make. It should:
- support diff versions of react (which have fiber node, but slight variations of it)
- be renderer-agnostic (say, support react-fs-renderer) but with extra helpers for react-dom.
- heavily tested with all these variations (to know when internals have changed).
Docs are sparse at the moment. I plan on adding them soon.
Till then, the auto-generated (typedoc) docs available in docs folder might be of some help.
MIT