Add built docs

2026-08-18 13:52:36 +00:00 · 2019-08-04 00:59:49 +05:30
parent b78906a629
commit 054c50b6f5
11 changed files with 625 additions and 0 deletions
@@ -0,0 +1,75 @@
+> **[react-fiber-traverse](README.md)**
+
+[Globals](globals.md) /
+
+# react-fiber-traverse
+
+[![npm version][npmv-image]][npmv-url]
+[![build status][travis-image]][travis-url]
+[![coverage status][codecov-image]][codecov-url]
+[![npm downloads][npmd-image]][npmd-url]
+
+> Traverse and other utils on top of React fiber tree
+
+## Basic Usage
+
+```jsx
+import React from 'react'
+import { render } from 'react-dom'
+
+render(, document.getElementById('root'))
+```
+
+## Live Examples
+
+- [Basic Usage](https://codesandbox.io/)
+- [API Example](https://codesandbox.io/)
+- [UMD Build (Development)](https://codesandbox.io/)
+- [UMD Build (Production)](https://codesandbox.io/)
+
+## API
+
+**Props**
+
+- `foo` - Something something.
+- `bar` - _Optional_ Something something. Defaults to `null`.
+
+**Example**
+
+```jsx
+```
+
+## Installation
+
+```
+$ npm install react-fiber-traverse --save
+```
+
+There are also UMD builds available via [unpkg](https://unpkg.com/):
+
+- 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:
+
+- [`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:
+
+- [`React`](https://unpkg.com/react/umd/react.production.min.js)
+- [`ReactDOM`](https://unpkg.com/react-dom/umd/react-dom.production.min.js)
+
+## License
+
+MIT
+
+[travis-image]: https://img.shields.io/travis/bendtherules/react-fiber-traverse/master.svg?style=flat-square
+[travis-url]: https://travis-ci.org/bendtherules/react-fiber-traverse
+[codecov-image]: https://img.shields.io/codecov/c/github/bendtherules/react-fiber-traverse.svg?style=flat-square
+[codecov-url]: https://codecov.io/gh/bendtherules/react-fiber-traverse
+[npmv-image]: https://img.shields.io/npm/v/react-fiber-traverse.svg?style=flat-square
+[npmv-url]: https://www.npmjs.com/package/react-fiber-traverse
+[npmd-image]: https://img.shields.io/npm/dm/react-fiber-traverse.svg?style=flat-square
+[npmd-url]: https://www.npmjs.com/package/react-fiber-traverse
@@ -0,0 +1,15 @@
+> **[react-fiber-traverse](README.md)**
+
+[Globals](globals.md) /
+
+# react-fiber-traverse
+
+## Index
+
+### External modules
+
+* ["findNode"](modules/_findnode_.md)
+* ["index"](modules/_index_.md)
+* ["mocked-types/index"](modules/_mocked_types_index_.md)
+* ["traverse"](modules/_traverse_.md)
+* ["utils"](modules/_utils_.md)
@@ -0,0 +1,59 @@
+> **[react-fiber-traverse](../README.md)**
+
+[Globals](../globals.md) / ["mocked-types/index"](../modules/_mocked_types_index_.md) / [FiberNodeForComponentClass](_mocked_types_index_.fibernodeforcomponentclass.md) /
+
+# Interface: FiberNodeForComponentClass
+
+## Hierarchy
+
+* **FiberNodeForComponentClass**
+
+## Index
+
+### Properties
+
+* [child](_mocked_types_index_.fibernodeforcomponentclass.md#child)
+* [elementType](_mocked_types_index_.fibernodeforcomponentclass.md#elementtype)
+* [sibling](_mocked_types_index_.fibernodeforcomponentclass.md#sibling)
+* [stateNode](_mocked_types_index_.fibernodeforcomponentclass.md#statenode)
+* [type](_mocked_types_index_.fibernodeforcomponentclass.md#type)
+
+## Properties
+
+###  child
+
+• **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
+
+*Defined in [mocked-types/index.ts:20](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L20)*
+
+___
+
+###  elementType
+
+• **elementType**: *`ComponentClass`*
+
+*Defined in [mocked-types/index.ts:23](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L23)*
+
+___
+
+###  sibling
+
+• **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
+
+*Defined in [mocked-types/index.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L21)*
+
+___
+
+###  stateNode
+
+• **stateNode**: *`Component`*
+
+*Defined in [mocked-types/index.ts:26](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L26)*
+
+___
+
+###  type
+
+• **type**: *`ComponentClass`*
+
+*Defined in [mocked-types/index.ts:24](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L24)*
@@ -0,0 +1,59 @@
+> **[react-fiber-traverse](../README.md)**
+
+[Globals](../globals.md) / ["mocked-types/index"](../modules/_mocked_types_index_.md) / [FiberNodeForFunctionComponent](_mocked_types_index_.fibernodeforfunctioncomponent.md) /
+
+# Interface: FiberNodeForFunctionComponent
+
+## Hierarchy
+
+* **FiberNodeForFunctionComponent**
+
+## Index
+
+### Properties
+
+* [child](_mocked_types_index_.fibernodeforfunctioncomponent.md#child)
+* [elementType](_mocked_types_index_.fibernodeforfunctioncomponent.md#elementtype)
+* [sibling](_mocked_types_index_.fibernodeforfunctioncomponent.md#sibling)
+* [stateNode](_mocked_types_index_.fibernodeforfunctioncomponent.md#statenode)
+* [type](_mocked_types_index_.fibernodeforfunctioncomponent.md#type)
+
+## Properties
+
+###  child
+
+• **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
+
+*Defined in [mocked-types/index.ts:10](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L10)*
+
+___
+
+###  elementType
+
+• **elementType**: *`FunctionComponent`*
+
+*Defined in [mocked-types/index.ts:13](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L13)*
+
+___
+
+###  sibling
+
+• **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
+
+*Defined in [mocked-types/index.ts:11](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L11)*
+
+___
+
+###  stateNode
+
+• **stateNode**: *null*
+
+*Defined in [mocked-types/index.ts:16](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L16)*
+
+___
+
+###  type
+
+• **type**: *`FunctionComponent`*
+
+*Defined in [mocked-types/index.ts:14](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L14)*
@@ -0,0 +1,69 @@
+> **[react-fiber-traverse](../README.md)**
+
+[Globals](../globals.md) / ["mocked-types/index"](../modules/_mocked_types_index_.md) / [FiberNodeForInstrinsicElement](_mocked_types_index_.fibernodeforinstrinsicelement.md) /
+
+# Interface: FiberNodeForInstrinsicElement
+
+## Hierarchy
+
+* **FiberNodeForInstrinsicElement**
+
+## Index
+
+### Properties
+
+* [child](_mocked_types_index_.fibernodeforinstrinsicelement.md#child)
+* [elementType](_mocked_types_index_.fibernodeforinstrinsicelement.md#elementtype)
+* [sibling](_mocked_types_index_.fibernodeforinstrinsicelement.md#sibling)
+* [stateNode](_mocked_types_index_.fibernodeforinstrinsicelement.md#statenode)
+* [type](_mocked_types_index_.fibernodeforinstrinsicelement.md#type)
+
+## Properties
+
+###  child
+
+• **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
+
+*Defined in [mocked-types/index.ts:30](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L30)*
+
+*Defined in [mocked-types/index.ts:40](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L40)*
+
+___
+
+###  elementType
+
+• **elementType**: *keyof IntrinsicElements*
+
+*Defined in [mocked-types/index.ts:33](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L33)*
+
+*Defined in [mocked-types/index.ts:43](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L43)*
+
+___
+
+###  sibling
+
+• **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
+
+*Defined in [mocked-types/index.ts:31](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L31)*
+
+*Defined in [mocked-types/index.ts:41](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L41)*
+
+___
+
+###  stateNode
+
+• **stateNode**: *`HTMLElement`*
+
+*Defined in [mocked-types/index.ts:36](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L36)*
+
+*Defined in [mocked-types/index.ts:46](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L46)*
+
+___
+
+###  type
+
+• **type**: *keyof IntrinsicElements*
+
+*Defined in [mocked-types/index.ts:34](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L34)*
+
+*Defined in [mocked-types/index.ts:44](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L44)*
@@ -0,0 +1,59 @@
+> **[react-fiber-traverse](../README.md)**
+
+[Globals](../globals.md) / ["mocked-types/index"](../modules/_mocked_types_index_.md) / [FiberNodeForTextNode](_mocked_types_index_.fibernodefortextnode.md) /
+
+# Interface: FiberNodeForTextNode
+
+## Hierarchy
+
+* **FiberNodeForTextNode**
+
+## Index
+
+### Properties
+
+* [child](_mocked_types_index_.fibernodefortextnode.md#child)
+* [elementType](_mocked_types_index_.fibernodefortextnode.md#elementtype)
+* [sibling](_mocked_types_index_.fibernodefortextnode.md#sibling)
+* [stateNode](_mocked_types_index_.fibernodefortextnode.md#statenode)
+* [type](_mocked_types_index_.fibernodefortextnode.md#type)
+
+## Properties
+
+###  child
+
+• **child**: *null*
+
+*Defined in [mocked-types/index.ts:50](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L50)*
+
+___
+
+###  elementType
+
+• **elementType**: *null*
+
+*Defined in [mocked-types/index.ts:53](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L53)*
+
+___
+
+###  sibling
+
+• **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
+
+*Defined in [mocked-types/index.ts:51](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L51)*
+
+___
+
+###  stateNode
+
+• **stateNode**: *`Text`*
+
+*Defined in [mocked-types/index.ts:56](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L56)*
+
+___
+
+###  type
+
+• **type**: *null*
+
+*Defined in [mocked-types/index.ts:54](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L54)*
@@ -0,0 +1,64 @@
+> **[react-fiber-traverse](../README.md)**
+
+[Globals](../globals.md) / ["findNode"](_findnode_.md) /
+
+# External module: "findNode"
+
+## Index
+
+### Functions
+
+* [findNodeByComponent](_findnode_.md#findnodebycomponent)
+* [findNodeByComponentName](_findnode_.md#findnodebycomponentname)
+* [findNodeByComponentRef](_findnode_.md#findnodebycomponentref)
+
+## Functions
+
+###  findNodeByComponent
+
+▸ **findNodeByComponent**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedClassOrFunction`: `React.ComponentType`): *[FiberNode](_mocked_types_index_.md#fibernode) | null*
+
+*Defined in [findNode.ts:32](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/findNode.ts#L32)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`node` | [FiberNode](_mocked_types_index_.md#fibernode) \| null |
+`expectedClassOrFunction` | `React.ComponentType` |
+
+**Returns:** *[FiberNode](_mocked_types_index_.md#fibernode) | null*
+
+___
+
+###  findNodeByComponentName
+
+▸ **findNodeByComponentName**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedName`: string): *[FiberNode](_mocked_types_index_.md#fibernode) | null*
+
+*Defined in [findNode.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/findNode.ts#L4)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`node` | [FiberNode](_mocked_types_index_.md#fibernode) \| null |
+`expectedName` | string |
+
+**Returns:** *[FiberNode](_mocked_types_index_.md#fibernode) | null*
+
+___
+
+###  findNodeByComponentRef
+
+▸ **findNodeByComponentRef**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedClassInstance`: `Component`): *[FiberNode](_mocked_types_index_.md#fibernode) | null*
+
+*Defined in [findNode.ts:63](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/findNode.ts#L63)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`node` | [FiberNode](_mocked_types_index_.md#fibernode) \| null |
+`expectedClassInstance` | `Component` |
+
+**Returns:** *[FiberNode](_mocked_types_index_.md#fibernode) | null*
@@ -0,0 +1,5 @@
+> **[react-fiber-traverse](../README.md)**
+
+[Globals](../globals.md) / ["index"](_index_.md) /
+
+# External module: "index"
@@ -0,0 +1,35 @@
+> **[react-fiber-traverse](../README.md)**
+
+[Globals](../globals.md) / ["mocked-types/index"](_mocked_types_index_.md) /
+
+# External module: "mocked-types/index"
+
+## Index
+
+### Interfaces
+
+* [FiberNodeForComponentClass](../interfaces/_mocked_types_index_.fibernodeforcomponentclass.md)
+* [FiberNodeForFunctionComponent](../interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md)
+* [FiberNodeForInstrinsicElement](../interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md)
+* [FiberNodeForTextNode](../interfaces/_mocked_types_index_.fibernodefortextnode.md)
+
+### Type aliases
+
+* [FiberNode](_mocked_types_index_.md#fibernode)
+* [FiberNodeisHTMLLike](_mocked_types_index_.md#fibernodeishtmllike)
+
+## Type aliases
+
+###  FiberNode
+
+Ƭ **FiberNode**: *[FiberNodeForComponentClass](../interfaces/_mocked_types_index_.fibernodeforcomponentclass.md) | [FiberNodeForFunctionComponent](../interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md) | [FiberNodeForInstrinsicElement](../interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md) | [FiberNodeForTextNode](../interfaces/_mocked_types_index_.fibernodefortextnode.md)*
+
+*Defined in [mocked-types/index.ts:3](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L3)*
+
+___
+
+###  FiberNodeisHTMLLike
+
+Ƭ **FiberNodeisHTMLLike**: *[FiberNodeForInstrinsicElement](../interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md) | [FiberNodeForTextNode](../interfaces/_mocked_types_index_.fibernodefortextnode.md)*
+
+*Defined in [mocked-types/index.ts:59](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L59)*
@@ -0,0 +1,56 @@
+> **[react-fiber-traverse](../README.md)**
+
+[Globals](../globals.md) / ["traverse"](_traverse_.md) /
+
+# External module: "traverse"
+
+## Index
+
+### Functions
+
+* [traverse](_traverse_.md#traverse)
+* [traverseGenerator](_traverse_.md#traversegenerator)
+
+## Functions
+
+###  traverse
+
+▸ **traverse**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `fn`: function): *void*
+
+*Defined in [traverse.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/traverse.ts#L4)*
+
+**Parameters:**
+
+▪ **node**: *[FiberNode](_mocked_types_index_.md#fibernode)*
+
+▪ **fn**: *function*
+
+▸ (`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *any*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
+
+**Returns:** *void*
+
+___
+
+###  traverseGenerator
+
+▸ **traverseGenerator**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `__namedParameters`: object): *`IterableIterator<FiberNode>`*
+
+*Defined in [traverse.ts:15](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/traverse.ts#L15)*
+
+**Parameters:**
+
+▪ **node**: *[FiberNode](_mocked_types_index_.md#fibernode)*
+
+▪`Default value`  **__namedParameters**: *object*=  {}
+
+Name | Type | Default |
+------ | ------ | ------ |
+`order` | "self" \| "child" \| "sibling"[] |  ["self", "child", "sibling"] |
+
+**Returns:** *`IterableIterator<FiberNode>`*
@@ -0,0 +1,129 @@
+> **[react-fiber-traverse](../README.md)**
+
+[Globals](../globals.md) / ["utils"](_utils_.md) /
+
+# External module: "utils"
+
+## Index
+
+### Functions
+
+* [isConstructorComponentClass](_utils_.md#isconstructorcomponentclass)
+* [isConstructorFunctionComponent](_utils_.md#isconstructorfunctioncomponent)
+* [isConstructorHtmlLike](_utils_.md#isconstructorhtmllike)
+* [isNodeComponentClass](_utils_.md#isnodecomponentclass)
+* [isNodeFunctionComponent](_utils_.md#isnodefunctioncomponent)
+* [isNodeHtmlLike](_utils_.md#isnodehtmllike)
+* [isNodeNotHtmlLike](_utils_.md#isnodenothtmllike)
+
+## Functions
+
+###  isConstructorComponentClass
+
+▸ **isConstructorComponentClass**(`ctr`: `React.ElementType`): *boolean*
+
+*Defined in [utils.ts:40](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L40)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`ctr` | `React.ElementType` |
+
+**Returns:** *boolean*
+
+___
+
+###  isConstructorFunctionComponent
+
+▸ **isConstructorFunctionComponent**(`ctr`: `React.ElementType`): *boolean*
+
+*Defined in [utils.ts:57](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L57)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`ctr` | `React.ElementType` |
+
+**Returns:** *boolean*
+
+___
+
+###  isConstructorHtmlLike
+
+▸ **isConstructorHtmlLike**(`ctr`: `React.ElementType`): *boolean*
+
+*Defined in [utils.ts:31](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L31)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`ctr` | `React.ElementType` |
+
+**Returns:** *boolean*
+
+___
+
+###  isNodeComponentClass
+
+▸ **isNodeComponentClass**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
+
+*Defined in [utils.ts:25](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L25)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
+
+**Returns:** *boolean*
+
+___
+
+###  isNodeFunctionComponent
+
+▸ **isNodeFunctionComponent**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
+
+*Defined in [utils.ts:19](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L19)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
+
+**Returns:** *boolean*
+
+___
+
+###  isNodeHtmlLike
+
+▸ **isNodeHtmlLike**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
+
+*Defined in [utils.ts:9](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L9)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
+
+**Returns:** *boolean*
+
+___
+
+###  isNodeNotHtmlLike
+
+▸ **isNodeNotHtmlLike**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
+
+*Defined in [utils.ts:13](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L13)*
+
+**Parameters:**
+
+Name | Type |
+------ | ------ |
+`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
+
+**Returns:** *boolean*