From 8fe3548f47e0f001742fb79ef6dc2082139e4c94 Mon Sep 17 00:00:00 2001 From: bendtherules Date: Thu, 8 Aug 2019 12:19:37 +0530 Subject: [PATCH] Add basic usage to readme --- README.md | 17 +++++++++++++---- 1 file changed, 13 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 3875411..847e7d9 100644 --- a/README.md +++ b/README.md @@ -9,11 +9,21 @@ ## Basic Usage -```jsx -import React from 'react' +```ts import { render } from 'react-dom' -render(, document.getElementById('root')) +import { findNodeByComponentName } from 'react-fiber-traverse' +import { getRootFiberNodeFromDOM } from 'react-fiber-traverse/utils' + +const rootElement = document.getElementById('root'); +render(, 'root'); + +const rootFiberNode = getRootFiberNodeFromDOM(rootElement); + +const someFiberNode = findNodeByComponentName(rootFiberNode, 'SomeComponentName'); // <- returns FiberNode for first usage of 'SomeComponentName' +// Say, if SomeComponentName renders (
Some text
) +someFiberNode.stateNode // <- returns reference to the div +someFiberNode.stateNode.innerText // <- returns 'Some text' ``` ## Live Examples @@ -50,7 +60,6 @@ For the non-minified development version, make sure you have already included: - [`React`](https://unpkg.com/react/umd/react.development.js) - [`ReactDOM`](https://unpkg.com/react-dom/umd/react-dom.development.js) -- [`PropTypes`](https://unpkg.com/prop-types/prop-types.js) For the minified production version, make sure you have already included: