diff --git a/docs/interfaces/_mocked_types_index_.fibernodedomcontainer.md b/docs/interfaces/_mocked_types_index_.fibernodedomcontainer.md index 7ed2af4..f2d5749 100644 --- a/docs/interfaces/_mocked_types_index_.fibernodedomcontainer.md +++ b/docs/interfaces/_mocked_types_index_.fibernodedomcontainer.md @@ -347,7 +347,7 @@ ___ • **_reactRootContainer**: *object* -*Defined in [mocked-types/index.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L4)* +*Defined in [mocked-types/index.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L4)* #### Type declaration: diff --git a/docs/interfaces/_mocked_types_index_.fibernodeforcomponentclass.md b/docs/interfaces/_mocked_types_index_.fibernodeforcomponentclass.md index aa88d0c..d8cdb07 100644 --- a/docs/interfaces/_mocked_types_index_.fibernodeforcomponentclass.md +++ b/docs/interfaces/_mocked_types_index_.fibernodeforcomponentclass.md @@ -24,7 +24,7 @@ • **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:28](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L28)* +*Defined in [mocked-types/index.ts:28](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L28)* ___ @@ -32,7 +32,7 @@ ___ • **elementType**: *`ComponentClass`* -*Defined in [mocked-types/index.ts:31](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L31)* +*Defined in [mocked-types/index.ts:31](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L31)* ___ @@ -40,7 +40,7 @@ ___ • **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:29](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L29)* +*Defined in [mocked-types/index.ts:29](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L29)* ___ @@ -48,7 +48,7 @@ ___ • **stateNode**: *`Component`* -*Defined in [mocked-types/index.ts:34](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L34)* +*Defined in [mocked-types/index.ts:34](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L34)* ___ @@ -56,4 +56,4 @@ ___ • **type**: *`ComponentClass`* -*Defined in [mocked-types/index.ts:32](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L32)* \ No newline at end of file +*Defined in [mocked-types/index.ts:32](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L32)* \ No newline at end of file diff --git a/docs/interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md b/docs/interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md index 9fbb7b2..ce78060 100644 --- a/docs/interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md +++ b/docs/interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md @@ -24,7 +24,7 @@ • **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:18](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L18)* +*Defined in [mocked-types/index.ts:18](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L18)* ___ @@ -32,7 +32,7 @@ ___ • **elementType**: *`FunctionComponent`* -*Defined in [mocked-types/index.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L21)* +*Defined in [mocked-types/index.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L21)* ___ @@ -40,7 +40,7 @@ ___ • **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:19](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L19)* +*Defined in [mocked-types/index.ts:19](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L19)* ___ @@ -48,7 +48,7 @@ ___ • **stateNode**: *null* -*Defined in [mocked-types/index.ts:24](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L24)* +*Defined in [mocked-types/index.ts:24](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L24)* ___ @@ -56,4 +56,4 @@ ___ • **type**: *`FunctionComponent`* -*Defined in [mocked-types/index.ts:22](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L22)* \ No newline at end of file +*Defined in [mocked-types/index.ts:22](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L22)* \ No newline at end of file diff --git a/docs/interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md b/docs/interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md index 4d59db5..1252e1f 100644 --- a/docs/interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md +++ b/docs/interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md @@ -24,9 +24,9 @@ • **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:38](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L38)* +*Defined in [mocked-types/index.ts:38](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L38)* -*Defined in [mocked-types/index.ts:48](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L48)* +*Defined in [mocked-types/index.ts:48](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L48)* ___ @@ -34,9 +34,9 @@ ___ • **elementType**: *keyof IntrinsicElements* -*Defined in [mocked-types/index.ts:41](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L41)* +*Defined in [mocked-types/index.ts:41](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L41)* -*Defined in [mocked-types/index.ts:51](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L51)* +*Defined in [mocked-types/index.ts:51](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L51)* ___ @@ -44,9 +44,9 @@ ___ • **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:39](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L39)* +*Defined in [mocked-types/index.ts:39](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L39)* -*Defined in [mocked-types/index.ts:49](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L49)* +*Defined in [mocked-types/index.ts:49](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L49)* ___ @@ -54,9 +54,9 @@ ___ • **stateNode**: *`HTMLElement`* -*Defined in [mocked-types/index.ts:44](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L44)* +*Defined in [mocked-types/index.ts:44](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L44)* -*Defined in [mocked-types/index.ts:54](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L54)* +*Defined in [mocked-types/index.ts:54](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L54)* ___ @@ -64,6 +64,6 @@ ___ • **type**: *keyof IntrinsicElements* -*Defined in [mocked-types/index.ts:42](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L42)* +*Defined in [mocked-types/index.ts:42](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L42)* -*Defined in [mocked-types/index.ts:52](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L52)* \ No newline at end of file +*Defined in [mocked-types/index.ts:52](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L52)* \ No newline at end of file diff --git a/docs/interfaces/_mocked_types_index_.fibernodefortextnode.md b/docs/interfaces/_mocked_types_index_.fibernodefortextnode.md index bef2c15..10e0ba8 100644 --- a/docs/interfaces/_mocked_types_index_.fibernodefortextnode.md +++ b/docs/interfaces/_mocked_types_index_.fibernodefortextnode.md @@ -24,7 +24,7 @@ • **child**: *null* -*Defined in [mocked-types/index.ts:58](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L58)* +*Defined in [mocked-types/index.ts:58](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L58)* ___ @@ -32,7 +32,7 @@ ___ • **elementType**: *null* -*Defined in [mocked-types/index.ts:61](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L61)* +*Defined in [mocked-types/index.ts:61](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L61)* ___ @@ -40,7 +40,7 @@ ___ • **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:59](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L59)* +*Defined in [mocked-types/index.ts:59](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L59)* ___ @@ -48,7 +48,7 @@ ___ • **stateNode**: *`Text`* -*Defined in [mocked-types/index.ts:64](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L64)* +*Defined in [mocked-types/index.ts:64](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L64)* ___ @@ -56,4 +56,4 @@ ___ • **type**: *null* -*Defined in [mocked-types/index.ts:62](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L62)* \ No newline at end of file +*Defined in [mocked-types/index.ts:62](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L62)* \ No newline at end of file diff --git a/docs/modules/_findnode_.md b/docs/modules/_findnode_.md index 1bfc2de..b9d4ca5 100644 --- a/docs/modules/_findnode_.md +++ b/docs/modules/_findnode_.md @@ -18,7 +18,7 @@ ▸ **findNodeByComponent**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedClassOrFunction`: `React.ComponentType`): *[FiberNode](_mocked_types_index_.md#fibernode) | null* -*Defined in [findNode.ts:67](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/findNode.ts#L67)* +*Defined in [findNode.ts:67](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/findNode.ts#L67)* Find node by component (i.e. class or function by reference), till first match. @@ -51,7 +51,7 @@ ___ ▸ **findNodeByComponentName**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedName`: string): *[FiberNode](_mocked_types_index_.md#fibernode) | null* -*Defined in [findNode.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/findNode.ts#L21)* +*Defined in [findNode.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/findNode.ts#L21)* Find node by component name, till first match. @@ -83,7 +83,7 @@ ___ ▸ **findNodeByComponentRef**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedClassInstance`: `Component`): *[FiberNode](_mocked_types_index_.md#fibernode) | null* -*Defined in [findNode.ts:114](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/findNode.ts#L114)* +*Defined in [findNode.ts:114](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/findNode.ts#L114)* Find node by component instance ref, till first match. diff --git a/docs/modules/_mocked_types_index_.md b/docs/modules/_mocked_types_index_.md index c2239dc..90fd289 100644 --- a/docs/modules/_mocked_types_index_.md +++ b/docs/modules/_mocked_types_index_.md @@ -25,7 +25,7 @@ Ƭ **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:11](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L11)* +*Defined in [mocked-types/index.ts:11](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L11)* ___ @@ -33,4 +33,4 @@ ___ Ƭ **FiberNodeisHTMLLike**: *[FiberNodeForInstrinsicElement](../interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md) | [FiberNodeForTextNode](../interfaces/_mocked_types_index_.fibernodefortextnode.md)* -*Defined in [mocked-types/index.ts:67](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/mocked-types/index.ts#L67)* \ No newline at end of file +*Defined in [mocked-types/index.ts:67](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/mocked-types/index.ts#L67)* \ No newline at end of file diff --git a/docs/modules/_traverse_.md b/docs/modules/_traverse_.md index 6e3d4c8..37a740d 100644 --- a/docs/modules/_traverse_.md +++ b/docs/modules/_traverse_.md @@ -17,7 +17,19 @@ ▸ **traverse**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `fn`: function): *void* -*Defined in [traverse.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/traverse.ts#L4)* +*Defined in [traverse.ts:19](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/traverse.ts#L19)* + +Traverse nodes recursively in depth-first manner, starting from a start node. + +This is the default and basic traversal method, which covers basic use cases. +You can't do advanced things like change the order of traversal, skip or cancel traversal after any node, etc. +For more advanced usecases, see [traverseGenerator](_traverse_.md#traversegenerator) + +**`example`** +```js +// calls fn for each node inside startNode +traverse(startNode, fn); +``` **Parameters:** @@ -41,7 +53,7 @@ ___ ▸ **traverseGenerator**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `__namedParameters`: object): *`IterableIterator`* -*Defined in [traverse.ts:15](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/traverse.ts#L15)* +*Defined in [traverse.ts:30](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/traverse.ts#L30)* **Parameters:** diff --git a/docs/modules/_utils_.md b/docs/modules/_utils_.md index 3e1a891..1e3da70 100644 --- a/docs/modules/_utils_.md +++ b/docs/modules/_utils_.md @@ -24,7 +24,7 @@ ▸ **doesElementContainRootFiberNode**(`element`: `Element`): *boolean* -*Defined in [utils.ts:65](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/utils.ts#L65)* +*Defined in [utils.ts:65](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/utils.ts#L65)* **Parameters:** @@ -40,7 +40,7 @@ ___ ▸ **getRootFiberNodeFromDOM**(`startElement?`: [Element](../interfaces/_mocked_types_index_.fibernodedomcontainer.md#element)): *[FiberNode](_mocked_types_index_.md#fibernode) | null* -*Defined in [utils.ts:82](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/utils.ts#L82)* +*Defined in [utils.ts:82](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/utils.ts#L82)* Util to find root React Fiber node from html DOM tree. Returns null, if not found.SHould be called after ReactDOM.render is finished. @@ -59,7 +59,7 @@ ___ ▸ **isConstructorComponentClass**(`ctr`: `React.ElementType` | null): *boolean* -*Defined in [utils.ts:42](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/utils.ts#L42)* +*Defined in [utils.ts:42](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/utils.ts#L42)* **Parameters:** @@ -75,7 +75,7 @@ ___ ▸ **isConstructorFunctionComponent**(`ctr`: `React.ElementType` | null): *boolean* -*Defined in [utils.ts:59](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/utils.ts#L59)* +*Defined in [utils.ts:59](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/utils.ts#L59)* **Parameters:** @@ -91,7 +91,7 @@ ___ ▸ **isConstructorHtmlLike**(`ctr`: `React.ElementType` | null): *boolean* -*Defined in [utils.ts:33](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/utils.ts#L33)* +*Defined in [utils.ts:33](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/utils.ts#L33)* **Parameters:** @@ -107,7 +107,7 @@ ___ ▸ **isNodeComponentClass**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean* -*Defined in [utils.ts:27](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/utils.ts#L27)* +*Defined in [utils.ts:27](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/utils.ts#L27)* **Parameters:** @@ -123,7 +123,7 @@ ___ ▸ **isNodeFunctionComponent**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean* -*Defined in [utils.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/utils.ts#L21)* +*Defined in [utils.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/utils.ts#L21)* **Parameters:** @@ -139,7 +139,7 @@ ___ ▸ **isNodeHtmlLike**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean* -*Defined in [utils.ts:11](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/utils.ts#L11)* +*Defined in [utils.ts:11](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/utils.ts#L11)* **Parameters:** @@ -155,7 +155,7 @@ ___ ▸ **isNodeNotHtmlLike**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean* -*Defined in [utils.ts:15](https://github.com/bendtherules/react-fiber-traverse/blob/6cffc96/src/utils.ts#L15)* +*Defined in [utils.ts:15](https://github.com/bendtherules/react-fiber-traverse/blob/fd6dad2/src/utils.ts#L15)* **Parameters:**