mirror of
https://github.com/bendtherules/react-fiber-traverse.git
synced 2026-08-18 13:52:36 +00:00
Compare commits
43
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3d8c68639c | ||
|
|
fdfd267d95 | ||
|
|
c2a6000887 | ||
|
|
473d7cc38e | ||
|
|
1efcb67c56 | ||
|
|
f10c17bd53 | ||
|
|
e12438fd4f | ||
|
|
c92c64baa1 | ||
|
|
986f2c0aac | ||
|
|
ef593615ad | ||
|
|
2f28cd5eb0 | ||
|
|
c47a4dddbd | ||
|
|
051bb1f543 | ||
|
|
7b27f9c5b7 | ||
|
|
f5c37dc251 | ||
|
|
8c019a5fd2 | ||
|
|
be7ec5d869 | ||
|
|
6bb43e34e2 | ||
|
|
d630d21b23 | ||
|
|
693dd69d32 | ||
|
|
f01ae4fb2a | ||
|
|
1ef5941a9e | ||
|
|
e7e969cf65 | ||
|
|
8326ec5bf7 | ||
|
|
0bc8c1af99 | ||
|
|
aced1be6e8 | ||
|
|
492e69f4dd | ||
|
|
94ab7112f7 | ||
|
|
808ed790f3 | ||
|
|
817242dd25 | ||
|
|
827b282064 | ||
|
|
c71b9ad531 | ||
|
|
01e6932cd5 | ||
|
|
215153c516 | ||
|
|
fd6dad21ad | ||
|
|
30b1bfefea | ||
|
|
e870a92e4b | ||
|
|
6cffc96d60 | ||
|
|
4824828b51 | ||
|
|
5a2e7f1375 | ||
|
|
977a376cad | ||
|
|
21231fcb11 | ||
|
|
b09af700c9 |
+18
-18
@@ -1,36 +1,36 @@
|
|||||||
{
|
{
|
||||||
"dist/react-fiber-traverse.cjs.development.js": {
|
"dist/react-fiber-traverse.cjs.development.js": {
|
||||||
"bundled": 9674,
|
"bundled": 19424,
|
||||||
"minified": 4533,
|
"minified": 8388,
|
||||||
"gzipped": 1335
|
"gzipped": 2612
|
||||||
},
|
},
|
||||||
"dist/react-fiber-traverse.cjs.production.js": {
|
"dist/react-fiber-traverse.cjs.production.js": {
|
||||||
"bundled": 9674,
|
"bundled": 19424,
|
||||||
"minified": 4533,
|
"minified": 8388,
|
||||||
"gzipped": 1335
|
"gzipped": 2612
|
||||||
},
|
},
|
||||||
"dist/react-fiber-traverse.esm.js": {
|
"dist/react-fiber-traverse.esm.js": {
|
||||||
"bundled": 9312,
|
"bundled": 19124,
|
||||||
"minified": 4229,
|
"minified": 8112,
|
||||||
"gzipped": 1245,
|
"gzipped": 2537,
|
||||||
"treeshaked": {
|
"treeshaked": {
|
||||||
"rollup": {
|
"rollup": {
|
||||||
"code": 49,
|
"code": 31,
|
||||||
"import_statements": 49
|
"import_statements": 31
|
||||||
},
|
},
|
||||||
"webpack": {
|
"webpack": {
|
||||||
"code": 1066
|
"code": 1048
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"dist/react-fiber-traverse.umd.development.js": {
|
"dist/react-fiber-traverse.umd.development.js": {
|
||||||
"bundled": 34862,
|
"bundled": 34569,
|
||||||
"minified": 9669,
|
"minified": 11581,
|
||||||
"gzipped": 3394
|
"gzipped": 4230
|
||||||
},
|
},
|
||||||
"dist/react-fiber-traverse.umd.production.js": {
|
"dist/react-fiber-traverse.umd.production.js": {
|
||||||
"bundled": 34862,
|
"bundled": 34569,
|
||||||
"minified": 9669,
|
"minified": 11581,
|
||||||
"gzipped": 3394
|
"gzipped": 4230
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|||||||
Vendored
+2
-1
@@ -13,5 +13,6 @@
|
|||||||
"javascriptreact",
|
"javascriptreact",
|
||||||
"typescript",
|
"typescript",
|
||||||
"typescriptreact"
|
"typescriptreact"
|
||||||
]
|
],
|
||||||
|
"typescript.tsdk": "node_modules\\typescript\\lib"
|
||||||
}
|
}
|
||||||
@@ -6,6 +6,7 @@
|
|||||||
4. Build some demo
|
4. Build some demo
|
||||||
|
|
||||||
5. Add `findAllNodes` helpers which searches all usages of the components - by name or class
|
5. Add `findAllNodes` helpers which searches all usages of the components - by name or class
|
||||||
|
6. Allow using all methods without explicit root node. Find automatically, if not provided.
|
||||||
|
|
||||||
6. Fix getRootFiberNodeFromDOM and related helpers -
|
6. Fix getRootFiberNodeFromDOM and related helpers -
|
||||||
- .\_internalRoot is not present is 16.0.0 but present in 16.9.0
|
- .\_internalRoot is not present is 16.0.0 but present in 16.9.0
|
||||||
@@ -14,3 +15,14 @@
|
|||||||
|
|
||||||
7. Make it work with older React versions
|
7. Make it work with older React versions
|
||||||
8. Make it work with non React-DOM renderers
|
8. Make it work with non React-DOM renderers
|
||||||
|
|
||||||
|
9. Add test - traverseGenerator - siblings were traversed earlier, not now. Check input config.
|
||||||
|
|
||||||
|
10. Find node by CSS (query language) - Make it work for Class/Function reference also
|
||||||
|
11. Allow easy way to continue FiberNode select with CSS selector for dom node (handling Fragments)
|
||||||
|
|
||||||
|
12. Helper and filter by props and state
|
||||||
|
|
||||||
|
13. Fix es5, downLevelIteration with generator iteration
|
||||||
|
14. Tests for match
|
||||||
|
15. **Catch throw in generator**
|
||||||
@@ -80,6 +80,36 @@ For the minified production version, make sure you have already included:
|
|||||||
- [`React`](https://unpkg.com/react/umd/react.production.min.js)
|
- [`React`](https://unpkg.com/react/umd/react.production.min.js)
|
||||||
- [`ReactDOM`](https://unpkg.com/react-dom/umd/react-dom.production.min.js)
|
- [`ReactDOM`](https://unpkg.com/react-dom/umd/react-dom.production.min.js)
|
||||||
|
|
||||||
|
## Overview
|
||||||
|
|
||||||
|
This package contains few utility functions which operate over react-fiber tree.
|
||||||
|
|
||||||
|
Overall characteristics are:
|
||||||
|
1. Only read-only operations
|
||||||
|
2. Support inversion of control
|
||||||
|
|
||||||
|
There are few categories of helpers, each with their variations:
|
||||||
|
1. Find node(s)
|
||||||
|
2. Traverse node
|
||||||
|
3. Others - Check node type, find root node, etc.
|
||||||
|
|
||||||
|
Little more info is present in docs section.
|
||||||
|
|
||||||
|
## Concerns and improvements
|
||||||
|
|
||||||
|
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:
|
||||||
|
1. support diff versions of react (which have fiber node, but slight variations of it)
|
||||||
|
2. be renderer-agnostic (say, support react-fs-renderer) but with extra helpers for react-dom.
|
||||||
|
3. heavily tested with all these variations (to know when internals have changed).
|
||||||
|
|
||||||
|
## Docs
|
||||||
|
|
||||||
|
Docs are sparse at the moment. I plan on adding them soon.
|
||||||
|
|
||||||
|
Till then, the auto-generated (typedoc) docs available in [docs folder](./docs/globals.md) might be of some help.
|
||||||
|
|
||||||
## License
|
## License
|
||||||
|
|
||||||
MIT
|
MIT
|
||||||
|
|||||||
@@ -10,6 +10,7 @@
|
|||||||
|
|
||||||
* ["findNode"](modules/_findnode_.md)
|
* ["findNode"](modules/_findnode_.md)
|
||||||
* ["index"](modules/_index_.md)
|
* ["index"](modules/_index_.md)
|
||||||
|
* ["match"](modules/_match_.md)
|
||||||
* ["mocked-types/index"](modules/_mocked_types_index_.md)
|
* ["mocked-types/index"](modules/_mocked_types_index_.md)
|
||||||
* ["traverse"](modules/_traverse_.md)
|
* ["traverse"](modules/_traverse_.md)
|
||||||
* ["utils"](modules/_utils_.md)
|
* ["utils"](modules/_utils_.md)
|
||||||
@@ -347,7 +347,7 @@ ___
|
|||||||
|
|
||||||
• **_reactRootContainer**: *object*
|
• **_reactRootContainer**: *object*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L4)*
|
*Defined in [mocked-types/index.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L4)*
|
||||||
|
|
||||||
#### Type declaration:
|
#### Type declaration:
|
||||||
|
|
||||||
|
|||||||
@@ -24,7 +24,7 @@
|
|||||||
|
|
||||||
• **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
• **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:28](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L28)*
|
*Defined in [mocked-types/index.ts:28](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L28)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -32,7 +32,7 @@ ___
|
|||||||
|
|
||||||
• **elementType**: *`ComponentClass`*
|
• **elementType**: *`ComponentClass`*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:31](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L31)*
|
*Defined in [mocked-types/index.ts:31](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L31)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -40,7 +40,7 @@ ___
|
|||||||
|
|
||||||
• **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
• **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:29](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L29)*
|
*Defined in [mocked-types/index.ts:29](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L29)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
• **stateNode**: *`Component`*
|
• **stateNode**: *`Component`*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:34](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L34)*
|
*Defined in [mocked-types/index.ts:34](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L34)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -56,4 +56,4 @@ ___
|
|||||||
|
|
||||||
• **type**: *`ComponentClass`*
|
• **type**: *`ComponentClass`*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:32](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L32)*
|
*Defined in [mocked-types/index.ts:32](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L32)*
|
||||||
@@ -24,7 +24,7 @@
|
|||||||
|
|
||||||
• **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
• **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:18](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L18)*
|
*Defined in [mocked-types/index.ts:18](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L18)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -32,7 +32,7 @@ ___
|
|||||||
|
|
||||||
• **elementType**: *`FunctionComponent`*
|
• **elementType**: *`FunctionComponent`*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L21)*
|
*Defined in [mocked-types/index.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L21)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -40,7 +40,7 @@ ___
|
|||||||
|
|
||||||
• **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
• **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:19](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L19)*
|
*Defined in [mocked-types/index.ts:19](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L19)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
• **stateNode**: *null*
|
• **stateNode**: *null*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:24](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L24)*
|
*Defined in [mocked-types/index.ts:24](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L24)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -56,4 +56,4 @@ ___
|
|||||||
|
|
||||||
• **type**: *`FunctionComponent`*
|
• **type**: *`FunctionComponent`*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:22](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L22)*
|
*Defined in [mocked-types/index.ts:22](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L22)*
|
||||||
@@ -24,9 +24,9 @@
|
|||||||
|
|
||||||
• **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
• **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:38](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L38)*
|
*Defined in [mocked-types/index.ts:38](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L38)*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:48](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L48)*
|
*Defined in [mocked-types/index.ts:48](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L48)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -34,9 +34,9 @@ ___
|
|||||||
|
|
||||||
• **elementType**: *keyof IntrinsicElements*
|
• **elementType**: *keyof IntrinsicElements*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:41](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L41)*
|
*Defined in [mocked-types/index.ts:41](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L41)*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:51](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L51)*
|
*Defined in [mocked-types/index.ts:51](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L51)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -44,9 +44,9 @@ ___
|
|||||||
|
|
||||||
• **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
• **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:39](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L39)*
|
*Defined in [mocked-types/index.ts:39](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L39)*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:49](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L49)*
|
*Defined in [mocked-types/index.ts:49](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L49)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -54,9 +54,9 @@ ___
|
|||||||
|
|
||||||
• **stateNode**: *`HTMLElement`*
|
• **stateNode**: *`HTMLElement`*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:44](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L44)*
|
*Defined in [mocked-types/index.ts:44](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L44)*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:54](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L54)*
|
*Defined in [mocked-types/index.ts:54](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L54)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -64,6 +64,6 @@ ___
|
|||||||
|
|
||||||
• **type**: *keyof IntrinsicElements*
|
• **type**: *keyof IntrinsicElements*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:42](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L42)*
|
*Defined in [mocked-types/index.ts:42](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L42)*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:52](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L52)*
|
*Defined in [mocked-types/index.ts:52](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L52)*
|
||||||
@@ -24,7 +24,7 @@
|
|||||||
|
|
||||||
• **child**: *null*
|
• **child**: *null*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:58](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L58)*
|
*Defined in [mocked-types/index.ts:58](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L58)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -32,7 +32,7 @@ ___
|
|||||||
|
|
||||||
• **elementType**: *null*
|
• **elementType**: *null*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:61](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L61)*
|
*Defined in [mocked-types/index.ts:61](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L61)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -40,7 +40,7 @@ ___
|
|||||||
|
|
||||||
• **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
• **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:59](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L59)*
|
*Defined in [mocked-types/index.ts:59](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L59)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -48,7 +48,7 @@ ___
|
|||||||
|
|
||||||
• **stateNode**: *`Text`*
|
• **stateNode**: *`Text`*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:64](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L64)*
|
*Defined in [mocked-types/index.ts:64](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L64)*
|
||||||
|
|
||||||
___
|
___
|
||||||
|
|
||||||
@@ -56,4 +56,4 @@ ___
|
|||||||
|
|
||||||
• **type**: *null*
|
• **type**: *null*
|
||||||
|
|
||||||
*Defined in [mocked-types/index.ts:62](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L62)*
|
*Defined in [mocked-types/index.ts:62](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L62)*
|
||||||
@@ -0,0 +1,41 @@
|
|||||||
|
> **[react-fiber-traverse](../README.md)**
|
||||||
|
|
||||||
|
[Globals](../globals.md) / ["traverse"](../modules/_traverse_.md) / [TTraverseConfig](_traverse_.ttraverseconfig.md) /
|
||||||
|
|
||||||
|
# Interface: TTraverseConfig
|
||||||
|
|
||||||
|
## Hierarchy
|
||||||
|
|
||||||
|
* **TTraverseConfig**
|
||||||
|
|
||||||
|
## Index
|
||||||
|
|
||||||
|
### Properties
|
||||||
|
|
||||||
|
* [order](_traverse_.ttraverseconfig.md#optional-order)
|
||||||
|
* [skipSelfForStartNode](_traverse_.ttraverseconfig.md#optional-skipselfforstartnode)
|
||||||
|
* [skipSiblingForStartNode](_traverse_.ttraverseconfig.md#optional-skipsiblingforstartnode)
|
||||||
|
|
||||||
|
## Properties
|
||||||
|
|
||||||
|
### `Optional` order
|
||||||
|
|
||||||
|
• **order**? : *`Array<"self" | "child" | "sibling">`*
|
||||||
|
|
||||||
|
*Defined in [traverse.ts:5](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/traverse.ts#L5)*
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### `Optional` skipSelfForStartNode
|
||||||
|
|
||||||
|
• **skipSelfForStartNode**? : *undefined | false | true*
|
||||||
|
|
||||||
|
*Defined in [traverse.ts:7](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/traverse.ts#L7)*
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### `Optional` skipSiblingForStartNode
|
||||||
|
|
||||||
|
• **skipSiblingForStartNode**? : *undefined | false | true*
|
||||||
|
|
||||||
|
*Defined in [traverse.ts:6](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/traverse.ts#L6)*
|
||||||
+109
-23
@@ -8,34 +8,19 @@
|
|||||||
|
|
||||||
### Functions
|
### Functions
|
||||||
|
|
||||||
|
* [findAllNodesByComponentName](_findnode_.md#findallnodesbycomponentname)
|
||||||
* [findNodeByComponent](_findnode_.md#findnodebycomponent)
|
* [findNodeByComponent](_findnode_.md#findnodebycomponent)
|
||||||
* [findNodeByComponentName](_findnode_.md#findnodebycomponentname)
|
* [findNodeByComponentName](_findnode_.md#findnodebycomponentname)
|
||||||
* [findNodeByComponentRef](_findnode_.md#findnodebycomponentref)
|
* [findNodeByComponentRef](_findnode_.md#findnodebycomponentref)
|
||||||
|
* [findNodesByComponentName](_findnode_.md#findnodesbycomponentname)
|
||||||
|
|
||||||
## Functions
|
## Functions
|
||||||
|
|
||||||
### findNodeByComponent
|
### findAllNodesByComponentName
|
||||||
|
|
||||||
▸ **findNodeByComponent**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedClassOrFunction`: `React.ComponentType`): *[FiberNode](_mocked_types_index_.md#fibernode) | null*
|
▸ **findAllNodesByComponentName**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedName`: string, `traverseConfig?`: [TTraverseConfig](../interfaces/_traverse_.ttraverseconfig.md)): *`Array<FiberNode>`*
|
||||||
|
|
||||||
*Defined in [findNode.ts:32](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/findNode.ts#L32)*
|
*Defined in [findNode.ts:58](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/findNode.ts#L58)*
|
||||||
|
|
||||||
**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/18ea2e7/src/findNode.ts#L4)*
|
|
||||||
|
|
||||||
**Parameters:**
|
**Parameters:**
|
||||||
|
|
||||||
@@ -43,6 +28,74 @@ Name | Type |
|
|||||||
------ | ------ |
|
------ | ------ |
|
||||||
`node` | [FiberNode](_mocked_types_index_.md#fibernode) \| null |
|
`node` | [FiberNode](_mocked_types_index_.md#fibernode) \| null |
|
||||||
`expectedName` | string |
|
`expectedName` | string |
|
||||||
|
`traverseConfig?` | [TTraverseConfig](../interfaces/_traverse_.ttraverseconfig.md) |
|
||||||
|
|
||||||
|
**Returns:** *`Array<FiberNode>`*
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### findNodeByComponent
|
||||||
|
|
||||||
|
▸ **findNodeByComponent**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedClassOrFunction`: `React.ComponentType`, `traverseConfig?`: [TTraverseConfig](../interfaces/_traverse_.ttraverseconfig.md)): *[FiberNode](_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
|
*Defined in [findNode.ts:84](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/findNode.ts#L84)*
|
||||||
|
|
||||||
|
Find node by component (i.e. class or function by reference), till first match.
|
||||||
|
|
||||||
|
Matches against class and function by reference.
|
||||||
|
Returns null if no match is found.
|
||||||
|
|
||||||
|
**`example`**
|
||||||
|
```js
|
||||||
|
// returns FiberNode for first usage of AccordionMenu
|
||||||
|
findNodeByComponent(startNode, AccordionMenu);
|
||||||
|
```
|
||||||
|
|
||||||
|
**`note`** Medium chance of collision, medium data access needed.
|
||||||
|
This is safer than findNodeByComponentName, as different components with the same name won't collide.
|
||||||
|
But, two instances of the same component will still collide.
|
||||||
|
Needs access to component class or function.
|
||||||
|
|
||||||
|
**Parameters:**
|
||||||
|
|
||||||
|
Name | Type |
|
||||||
|
------ | ------ |
|
||||||
|
`node` | [FiberNode](_mocked_types_index_.md#fibernode) \| null |
|
||||||
|
`expectedClassOrFunction` | `React.ComponentType` |
|
||||||
|
`traverseConfig?` | [TTraverseConfig](../interfaces/_traverse_.ttraverseconfig.md) |
|
||||||
|
|
||||||
|
**Returns:** *[FiberNode](_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### findNodeByComponentName
|
||||||
|
|
||||||
|
▸ **findNodeByComponentName**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedName`: string, `traverseConfig?`: [TTraverseConfig](../interfaces/_traverse_.ttraverseconfig.md)): *[FiberNode](_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
|
*Defined in [findNode.ts:22](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/findNode.ts#L22)*
|
||||||
|
|
||||||
|
Find node by component name, till first match.
|
||||||
|
|
||||||
|
Matches against class and function name, doesn't match html-like nodes.
|
||||||
|
Returns null if no match is found.
|
||||||
|
|
||||||
|
**`example`**
|
||||||
|
```js
|
||||||
|
// returns FiberNode for first usage of 'AccordionMenu'
|
||||||
|
findNodeByComponentName(startNode, "AccordionMenu");
|
||||||
|
```
|
||||||
|
|
||||||
|
**`note`** Highest chance of collision, least data access needed.
|
||||||
|
Different components with same name will collide.
|
||||||
|
Needs access to component name.
|
||||||
|
|
||||||
|
**Parameters:**
|
||||||
|
|
||||||
|
Name | Type |
|
||||||
|
------ | ------ |
|
||||||
|
`node` | [FiberNode](_mocked_types_index_.md#fibernode) \| null |
|
||||||
|
`expectedName` | string |
|
||||||
|
`traverseConfig?` | [TTraverseConfig](../interfaces/_traverse_.ttraverseconfig.md) |
|
||||||
|
|
||||||
**Returns:** *[FiberNode](_mocked_types_index_.md#fibernode) | null*
|
**Returns:** *[FiberNode](_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
@@ -50,9 +103,23 @@ ___
|
|||||||
|
|
||||||
### findNodeByComponentRef
|
### findNodeByComponentRef
|
||||||
|
|
||||||
▸ **findNodeByComponentRef**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedClassInstance`: `Component`): *[FiberNode](_mocked_types_index_.md#fibernode) | null*
|
▸ **findNodeByComponentRef**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedClassInstance`: `Component`, `traverseConfig?`: [TTraverseConfig](../interfaces/_traverse_.ttraverseconfig.md)): *[FiberNode](_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
*Defined in [findNode.ts:63](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/findNode.ts#L63)*
|
*Defined in [findNode.ts:122](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/findNode.ts#L122)*
|
||||||
|
|
||||||
|
Find node by component instance ref, till first match.
|
||||||
|
|
||||||
|
Matches against class instances by reference.
|
||||||
|
Returns null if no match is found.
|
||||||
|
|
||||||
|
**`example`**
|
||||||
|
```js
|
||||||
|
// menuRef=createRef(); <AccordionMenu ref={menuRef}>
|
||||||
|
findNodeByComponentRef(startNode, menuRef.current);
|
||||||
|
```
|
||||||
|
|
||||||
|
**`note`** Least chance of collision, maximum data access needed.
|
||||||
|
Needs access to component instance (through React ref usually).
|
||||||
|
|
||||||
**Parameters:**
|
**Parameters:**
|
||||||
|
|
||||||
@@ -60,5 +127,24 @@ Name | Type |
|
|||||||
------ | ------ |
|
------ | ------ |
|
||||||
`node` | [FiberNode](_mocked_types_index_.md#fibernode) \| null |
|
`node` | [FiberNode](_mocked_types_index_.md#fibernode) \| null |
|
||||||
`expectedClassInstance` | `Component` |
|
`expectedClassInstance` | `Component` |
|
||||||
|
`traverseConfig?` | [TTraverseConfig](../interfaces/_traverse_.ttraverseconfig.md) |
|
||||||
|
|
||||||
**Returns:** *[FiberNode](_mocked_types_index_.md#fibernode) | null*
|
**Returns:** *[FiberNode](_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### findNodesByComponentName
|
||||||
|
|
||||||
|
▸ **findNodesByComponentName**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedName`: string, `traverseConfig?`: [TTraverseConfig](../interfaces/_traverse_.ttraverseconfig.md)): *`IterableIterator<FiberNode>`*
|
||||||
|
|
||||||
|
*Defined in [findNode.ts:41](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/findNode.ts#L41)*
|
||||||
|
|
||||||
|
**Parameters:**
|
||||||
|
|
||||||
|
Name | Type |
|
||||||
|
------ | ------ |
|
||||||
|
`node` | [FiberNode](_mocked_types_index_.md#fibernode) \| null |
|
||||||
|
`expectedName` | string |
|
||||||
|
`traverseConfig?` | [TTraverseConfig](../interfaces/_traverse_.ttraverseconfig.md) |
|
||||||
|
|
||||||
|
**Returns:** *`IterableIterator<FiberNode>`*
|
||||||
@@ -0,0 +1,64 @@
|
|||||||
|
> **[react-fiber-traverse](../README.md)**
|
||||||
|
|
||||||
|
[Globals](../globals.md) / ["match"](_match_.md) /
|
||||||
|
|
||||||
|
# External module: "match"
|
||||||
|
|
||||||
|
## Index
|
||||||
|
|
||||||
|
### Functions
|
||||||
|
|
||||||
|
* [matchAll](_match_.md#matchall)
|
||||||
|
* [matchFirst](_match_.md#matchfirst)
|
||||||
|
* [matchGenerator](_match_.md#matchgenerator)
|
||||||
|
|
||||||
|
## Functions
|
||||||
|
|
||||||
|
### matchAll
|
||||||
|
|
||||||
|
▸ **matchAll**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `match`: string | `CSSWhat.Selector`[][]): *`Array<FiberNode>`*
|
||||||
|
|
||||||
|
*Defined in [match.ts:115](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/match.ts#L115)*
|
||||||
|
|
||||||
|
**Parameters:**
|
||||||
|
|
||||||
|
Name | Type |
|
||||||
|
------ | ------ |
|
||||||
|
`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
|
||||||
|
`match` | string \| `CSSWhat.Selector`[][] |
|
||||||
|
|
||||||
|
**Returns:** *`Array<FiberNode>`*
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### matchFirst
|
||||||
|
|
||||||
|
▸ **matchFirst**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `match`: string | `CSSWhat.Selector`[][]): *[FiberNode](_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
|
*Defined in [match.ts:122](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/match.ts#L122)*
|
||||||
|
|
||||||
|
**Parameters:**
|
||||||
|
|
||||||
|
Name | Type |
|
||||||
|
------ | ------ |
|
||||||
|
`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
|
||||||
|
`match` | string \| `CSSWhat.Selector`[][] |
|
||||||
|
|
||||||
|
**Returns:** *[FiberNode](_mocked_types_index_.md#fibernode) | null*
|
||||||
|
|
||||||
|
___
|
||||||
|
|
||||||
|
### matchGenerator
|
||||||
|
|
||||||
|
▸ **matchGenerator**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `match`: string | `CSSWhat.Selector`[][]): *`IterableIterator<FiberNode>`*
|
||||||
|
|
||||||
|
*Defined in [match.ts:6](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/match.ts#L6)*
|
||||||
|
|
||||||
|
**Parameters:**
|
||||||
|
|
||||||
|
Name | Type |
|
||||||
|
------ | ------ |
|
||||||
|
`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
|
||||||
|
`match` | string \| `CSSWhat.Selector`[][] |
|
||||||
|
|
||||||
|
**Returns:** *`IterableIterator<FiberNode>`*
|
||||||
@@ -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)*
|
Ƭ **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/18ea2e7/src/mocked-types/index.ts#L11)*
|
*Defined in [mocked-types/index.ts:11](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/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)*
|
Ƭ **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/18ea2e7/src/mocked-types/index.ts#L67)*
|
*Defined in [mocked-types/index.ts:67](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/mocked-types/index.ts#L67)*
|
||||||
@@ -6,6 +6,10 @@
|
|||||||
|
|
||||||
## Index
|
## Index
|
||||||
|
|
||||||
|
### Interfaces
|
||||||
|
|
||||||
|
* [TTraverseConfig](../interfaces/_traverse_.ttraverseconfig.md)
|
||||||
|
|
||||||
### Functions
|
### Functions
|
||||||
|
|
||||||
* [traverse](_traverse_.md#traverse)
|
* [traverse](_traverse_.md#traverse)
|
||||||
@@ -15,9 +19,21 @@
|
|||||||
|
|
||||||
### traverse
|
### traverse
|
||||||
|
|
||||||
▸ **traverse**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `fn`: function): *void*
|
▸ **traverse**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `fn`: function, `traverseConfig?`: [TTraverseConfig](../interfaces/_traverse_.ttraverseconfig.md)): *void*
|
||||||
|
|
||||||
*Defined in [traverse.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/traverse.ts#L4)*
|
*Defined in [traverse.ts:146](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/traverse.ts#L146)*
|
||||||
|
|
||||||
|
Traverse nodes recursively in depth-first manner, starting from a start node.
|
||||||
|
|
||||||
|
This is the default and basic traversal function, 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:**
|
**Parameters:**
|
||||||
|
|
||||||
@@ -33,6 +49,8 @@ Name | Type |
|
|||||||
------ | ------ |
|
------ | ------ |
|
||||||
`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
|
`node` | [FiberNode](_mocked_types_index_.md#fibernode) |
|
||||||
|
|
||||||
|
▪`Optional` **traverseConfig**: *[TTraverseConfig](../interfaces/_traverse_.ttraverseconfig.md)*
|
||||||
|
|
||||||
**Returns:** *void*
|
**Returns:** *void*
|
||||||
|
|
||||||
___
|
___
|
||||||
@@ -41,7 +59,64 @@ ___
|
|||||||
|
|
||||||
▸ **traverseGenerator**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `__namedParameters`: object): *`IterableIterator<FiberNode>`*
|
▸ **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/18ea2e7/src/traverse.ts#L15)*
|
*Defined in [traverse.ts:69](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/traverse.ts#L69)*
|
||||||
|
|
||||||
|
Traverse nodes recursively using generators.
|
||||||
|
|
||||||
|
This is the advanced traverse function, which can be used used
|
||||||
|
to write other variants of traversal and find.
|
||||||
|
|
||||||
|
Type signature for generator.next first argument is `{ skipChild?: boolean; skipSibling?: boolean } | void `
|
||||||
|
Throw any error into the generator to finish the generator and let it cleanup its internals.
|
||||||
|
|
||||||
|
It allows inversion of control -
|
||||||
|
so, application code can decide to
|
||||||
|
1. change order of traversal,
|
||||||
|
2. skip some elements,
|
||||||
|
3. cancel traversal mid-way.
|
||||||
|
|
||||||
|
**`example`**
|
||||||
|
```js
|
||||||
|
// Basic use (for-of)
|
||||||
|
|
||||||
|
const nodeIterator = traverseGenerator(rootNode);
|
||||||
|
for (const node of nodeIterator) {
|
||||||
|
// do something with each node here
|
||||||
|
}
|
||||||
|
```
|
||||||
|
------
|
||||||
|
|
||||||
|
**`example`**
|
||||||
|
```js
|
||||||
|
// Breadth-first
|
||||||
|
|
||||||
|
// note the order below
|
||||||
|
const nodeIterator = traverseGenerator(rootNode, ["self", "sibling", "child"]);
|
||||||
|
// rest - same as above
|
||||||
|
```
|
||||||
|
-----
|
||||||
|
|
||||||
|
**`example`**
|
||||||
|
```js
|
||||||
|
// Get first 3 nodes and then stop the generator
|
||||||
|
|
||||||
|
const nodeIterator = traverseGenerator(rootNode);
|
||||||
|
|
||||||
|
var count = 0;
|
||||||
|
var next;
|
||||||
|
while (
|
||||||
|
count < 3 &&
|
||||||
|
!(next = nodeIterator.next()).done
|
||||||
|
) {
|
||||||
|
count++;
|
||||||
|
const node = next.value;
|
||||||
|
// do something with each node here
|
||||||
|
}
|
||||||
|
|
||||||
|
// Finish generator, to prevent memory leak
|
||||||
|
nodeIterator.throw(new Error());
|
||||||
|
```
|
||||||
|
-----
|
||||||
|
|
||||||
**Parameters:**
|
**Parameters:**
|
||||||
|
|
||||||
@@ -52,5 +127,7 @@ ___
|
|||||||
Name | Type | Default |
|
Name | Type | Default |
|
||||||
------ | ------ | ------ |
|
------ | ------ | ------ |
|
||||||
`order` | "self" \| "child" \| "sibling"[] | ["self", "child", "sibling"] |
|
`order` | "self" \| "child" \| "sibling"[] | ["self", "child", "sibling"] |
|
||||||
|
`skipSelfForStartNode` | boolean | false |
|
||||||
|
`skipSiblingForStartNode` | boolean | true |
|
||||||
|
|
||||||
**Returns:** *`IterableIterator<FiberNode>`*
|
**Returns:** *`IterableIterator<FiberNode>`*
|
||||||
@@ -24,7 +24,7 @@
|
|||||||
|
|
||||||
▸ **doesElementContainRootFiberNode**(`element`: `Element`): *boolean*
|
▸ **doesElementContainRootFiberNode**(`element`: `Element`): *boolean*
|
||||||
|
|
||||||
*Defined in [utils.ts:65](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L65)*
|
*Defined in [utils.ts:65](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/utils.ts#L65)*
|
||||||
|
|
||||||
**Parameters:**
|
**Parameters:**
|
||||||
|
|
||||||
@@ -40,7 +40,7 @@ ___
|
|||||||
|
|
||||||
▸ **getRootFiberNodeFromDOM**(`startElement?`: [Element](../interfaces/_mocked_types_index_.fibernodedomcontainer.md#element)): *[FiberNode](_mocked_types_index_.md#fibernode) | null*
|
▸ **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/18ea2e7/src/utils.ts#L82)*
|
*Defined in [utils.ts:82](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/utils.ts#L82)*
|
||||||
|
|
||||||
Util to find root React Fiber node from html DOM tree.
|
Util to find root React Fiber node from html DOM tree.
|
||||||
Returns null, if not found.SHould be called after ReactDOM.render is finished.
|
Returns null, if not found.SHould be called after ReactDOM.render is finished.
|
||||||
@@ -59,7 +59,7 @@ ___
|
|||||||
|
|
||||||
▸ **isConstructorComponentClass**(`ctr`: `React.ElementType` | null): *boolean*
|
▸ **isConstructorComponentClass**(`ctr`: `React.ElementType` | null): *boolean*
|
||||||
|
|
||||||
*Defined in [utils.ts:42](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L42)*
|
*Defined in [utils.ts:42](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/utils.ts#L42)*
|
||||||
|
|
||||||
**Parameters:**
|
**Parameters:**
|
||||||
|
|
||||||
@@ -75,7 +75,7 @@ ___
|
|||||||
|
|
||||||
▸ **isConstructorFunctionComponent**(`ctr`: `React.ElementType` | null): *boolean*
|
▸ **isConstructorFunctionComponent**(`ctr`: `React.ElementType` | null): *boolean*
|
||||||
|
|
||||||
*Defined in [utils.ts:59](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L59)*
|
*Defined in [utils.ts:59](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/utils.ts#L59)*
|
||||||
|
|
||||||
**Parameters:**
|
**Parameters:**
|
||||||
|
|
||||||
@@ -91,7 +91,7 @@ ___
|
|||||||
|
|
||||||
▸ **isConstructorHtmlLike**(`ctr`: `React.ElementType` | null): *boolean*
|
▸ **isConstructorHtmlLike**(`ctr`: `React.ElementType` | null): *boolean*
|
||||||
|
|
||||||
*Defined in [utils.ts:33](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L33)*
|
*Defined in [utils.ts:33](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/utils.ts#L33)*
|
||||||
|
|
||||||
**Parameters:**
|
**Parameters:**
|
||||||
|
|
||||||
@@ -107,7 +107,7 @@ ___
|
|||||||
|
|
||||||
▸ **isNodeComponentClass**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
|
▸ **isNodeComponentClass**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
|
||||||
|
|
||||||
*Defined in [utils.ts:27](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L27)*
|
*Defined in [utils.ts:27](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/utils.ts#L27)*
|
||||||
|
|
||||||
**Parameters:**
|
**Parameters:**
|
||||||
|
|
||||||
@@ -123,7 +123,7 @@ ___
|
|||||||
|
|
||||||
▸ **isNodeFunctionComponent**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
|
▸ **isNodeFunctionComponent**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
|
||||||
|
|
||||||
*Defined in [utils.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L21)*
|
*Defined in [utils.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/utils.ts#L21)*
|
||||||
|
|
||||||
**Parameters:**
|
**Parameters:**
|
||||||
|
|
||||||
@@ -139,7 +139,7 @@ ___
|
|||||||
|
|
||||||
▸ **isNodeHtmlLike**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
|
▸ **isNodeHtmlLike**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
|
||||||
|
|
||||||
*Defined in [utils.ts:11](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L11)*
|
*Defined in [utils.ts:11](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/utils.ts#L11)*
|
||||||
|
|
||||||
**Parameters:**
|
**Parameters:**
|
||||||
|
|
||||||
@@ -155,7 +155,7 @@ ___
|
|||||||
|
|
||||||
▸ **isNodeNotHtmlLike**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
|
▸ **isNodeNotHtmlLike**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean*
|
||||||
|
|
||||||
*Defined in [utils.ts:15](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L15)*
|
*Defined in [utils.ts:15](https://github.com/bendtherules/react-fiber-traverse/blob/c92c64b/src/utils.ts#L15)*
|
||||||
|
|
||||||
**Parameters:**
|
**Parameters:**
|
||||||
|
|
||||||
|
|||||||
Generated
+151
-69
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "react-fiber-traverse",
|
"name": "react-fiber-traverse",
|
||||||
"version": "0.0.7",
|
"version": "0.0.8",
|
||||||
"lockfileVersion": 1,
|
"lockfileVersion": 1,
|
||||||
"requires": true,
|
"requires": true,
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
@@ -1320,6 +1320,12 @@
|
|||||||
"defer-to-connect": "^1.0.1"
|
"defer-to-connect": "^1.0.1"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"@tootallnate/once": {
|
||||||
|
"version": "1.1.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/@tootallnate/once/-/once-1.1.2.tgz",
|
||||||
|
"integrity": "sha512-RbzJvlNzmRq5c3O09UipeuXno4tA1FE6ikOjxZK0tuxVv3412l64l5t1W5pj4+rJq9vpkm/kwiR07aZXnsKPxw==",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
"@types/babel__core": {
|
"@types/babel__core": {
|
||||||
"version": "7.1.2",
|
"version": "7.1.2",
|
||||||
"resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.1.2.tgz",
|
"resolved": "https://registry.npmjs.org/@types/babel__core/-/babel__core-7.1.2.tgz",
|
||||||
@@ -1825,12 +1831,12 @@
|
|||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"agent-base": {
|
"agent-base": {
|
||||||
"version": "4.3.0",
|
"version": "6.0.2",
|
||||||
"resolved": "https://registry.npmjs.org/agent-base/-/agent-base-4.3.0.tgz",
|
"resolved": "https://registry.npmjs.org/agent-base/-/agent-base-6.0.2.tgz",
|
||||||
"integrity": "sha512-salcGninV0nPrwpGNn4VTXBb1SOuXQBiqbrNXoeizJsHrsL6ERFM2Ne3JUSBWRE6aeNJI2ROP/WEEIDUiDe3cg==",
|
"integrity": "sha512-RZNwNclF7+MS/8bDg70amg32dyeZGZxiDuQmZxKLAlQjr3jGyLx+4Kkk58UO7D2QdgFIQCovuSuZESne6RG6XQ==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"es6-promisify": "^5.0.0"
|
"debug": "4"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"airbnb-prop-types": {
|
"airbnb-prop-types": {
|
||||||
@@ -2003,7 +2009,7 @@
|
|||||||
"argv": {
|
"argv": {
|
||||||
"version": "0.0.2",
|
"version": "0.0.2",
|
||||||
"resolved": "https://registry.npmjs.org/argv/-/argv-0.0.2.tgz",
|
"resolved": "https://registry.npmjs.org/argv/-/argv-0.0.2.tgz",
|
||||||
"integrity": "sha1-7L0W+JSbFXGDcRsb2jNPN4QBhas=",
|
"integrity": "sha512-dEamhpPEwRUBpLNHeuCm/v+g0anFByHahxodVO/BbAarHVBBg2MccCwf9K+o1Pof+2btdnkJelYVUWjW/VrATw==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"arr-diff": {
|
"arr-diff": {
|
||||||
@@ -3396,16 +3402,28 @@
|
|||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"codecov": {
|
"codecov": {
|
||||||
"version": "3.5.0",
|
"version": "3.8.3",
|
||||||
"resolved": "https://registry.npmjs.org/codecov/-/codecov-3.5.0.tgz",
|
"resolved": "https://registry.npmjs.org/codecov/-/codecov-3.8.3.tgz",
|
||||||
"integrity": "sha512-/OsWOfIHaQIr7aeZ4pY0UC1PZT6kimoKFOFYFNb6wxo3iw12nRrh+mNGH72rnXxNsq6SGfesVPizm/6Q3XqcFQ==",
|
"integrity": "sha512-Y8Hw+V3HgR7V71xWH2vQ9lyS358CbGCldWlJFR0JirqoGtOoas3R3/OclRTvgUYFK29mmJICDPauVKmpqbwhOA==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"argv": "^0.0.2",
|
"argv": "0.0.2",
|
||||||
"ignore-walk": "^3.0.1",
|
"ignore-walk": "3.0.4",
|
||||||
"js-yaml": "^3.13.1",
|
"js-yaml": "3.14.1",
|
||||||
"teeny-request": "^3.11.3",
|
"teeny-request": "7.1.1",
|
||||||
"urlgrey": "^0.4.4"
|
"urlgrey": "1.0.0"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"js-yaml": {
|
||||||
|
"version": "3.14.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/js-yaml/-/js-yaml-3.14.1.tgz",
|
||||||
|
"integrity": "sha512-okMH7OXXJ7YrN9Ok3/SXrnu4iX9yOk+25nqX4imS2npuvTYDmo/QEZoqwZkYaIDk3jVvBOTOIEgEhaLOynBS9g==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"argparse": "^1.0.7",
|
||||||
|
"esprima": "^4.0.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"collapse-white-space": {
|
"collapse-white-space": {
|
||||||
@@ -3775,13 +3793,20 @@
|
|||||||
"css-what": "2.1",
|
"css-what": "2.1",
|
||||||
"domutils": "1.5.1",
|
"domutils": "1.5.1",
|
||||||
"nth-check": "~1.0.1"
|
"nth-check": "~1.0.1"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"css-what": {
|
||||||
|
"version": "2.1.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/css-what/-/css-what-2.1.3.tgz",
|
||||||
|
"integrity": "sha512-a+EPoD+uZiNfh+5fxw2nO9QwFa6nJe2Or35fGY6Ipw1R3R4AGz1d1TEZrCegvw2YTmZ0jXirGYlzxxpYSHwpEg==",
|
||||||
|
"dev": true
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"css-what": {
|
"css-what": {
|
||||||
"version": "2.1.3",
|
"version": "3.2.0",
|
||||||
"resolved": "https://registry.npmjs.org/css-what/-/css-what-2.1.3.tgz",
|
"resolved": "https://registry.npmjs.org/css-what/-/css-what-3.2.0.tgz",
|
||||||
"integrity": "sha512-a+EPoD+uZiNfh+5fxw2nO9QwFa6nJe2Or35fGY6Ipw1R3R4AGz1d1TEZrCegvw2YTmZ0jXirGYlzxxpYSHwpEg==",
|
"integrity": "sha512-lukqnlbswsPmDZ5+ViDBCcrk+1fyPBA+ZoHSAQhRuEeXBKUb3Lj2kcTwMqoiFrJAnEeO9u3Oc8X617SUm3apYQ=="
|
||||||
"dev": true
|
|
||||||
},
|
},
|
||||||
"cssom": {
|
"cssom": {
|
||||||
"version": "0.3.8",
|
"version": "0.3.8",
|
||||||
@@ -4404,21 +4429,6 @@
|
|||||||
"is-symbol": "^1.0.2"
|
"is-symbol": "^1.0.2"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"es6-promise": {
|
|
||||||
"version": "4.2.8",
|
|
||||||
"resolved": "https://registry.npmjs.org/es6-promise/-/es6-promise-4.2.8.tgz",
|
|
||||||
"integrity": "sha512-HJDGx5daxeIvxdBxvG2cb9g4tEvwIk3i8+nhX0yGrYmZUzbkdg8QbDevheDB8gd0//uPj4c1EQua8Q+MViT0/w==",
|
|
||||||
"dev": true
|
|
||||||
},
|
|
||||||
"es6-promisify": {
|
|
||||||
"version": "5.0.0",
|
|
||||||
"resolved": "https://registry.npmjs.org/es6-promisify/-/es6-promisify-5.0.0.tgz",
|
|
||||||
"integrity": "sha1-UQnWLz5W6pZ8S2NQWu8IKRyKUgM=",
|
|
||||||
"dev": true,
|
|
||||||
"requires": {
|
|
||||||
"es6-promise": "^4.0.3"
|
|
||||||
}
|
|
||||||
},
|
|
||||||
"escape-string-regexp": {
|
"escape-string-regexp": {
|
||||||
"version": "1.0.5",
|
"version": "1.0.5",
|
||||||
"resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
|
"resolved": "https://registry.npmjs.org/escape-string-regexp/-/escape-string-regexp-1.0.5.tgz",
|
||||||
@@ -4943,6 +4953,23 @@
|
|||||||
"integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=",
|
"integrity": "sha1-PYpcZog6FqMMqGQ+hR8Zuqd5eRc=",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"fast-url-parser": {
|
||||||
|
"version": "1.1.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/fast-url-parser/-/fast-url-parser-1.1.3.tgz",
|
||||||
|
"integrity": "sha512-5jOCVXADYNuRkKFzNJ0dCCewsZiYo0dz8QNYljkOpFC6r2U4OBmKtvm/Tsuh4w1YYdDqDb31a8TVhBJ2OJKdqQ==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"punycode": "^1.3.2"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"punycode": {
|
||||||
|
"version": "1.4.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/punycode/-/punycode-1.4.1.tgz",
|
||||||
|
"integrity": "sha512-jmYNElW7yvO7TV33CjSmvSiE2yco3bV2czu/OzDKdMNVZQWfxCblURLhf+47syQRBntjfLdd/H0egrzIG+oaFQ==",
|
||||||
|
"dev": true
|
||||||
|
}
|
||||||
|
}
|
||||||
|
},
|
||||||
"fastq": {
|
"fastq": {
|
||||||
"version": "1.6.0",
|
"version": "1.6.0",
|
||||||
"resolved": "https://registry.npmjs.org/fastq/-/fastq-1.6.0.tgz",
|
"resolved": "https://registry.npmjs.org/fastq/-/fastq-1.6.0.tgz",
|
||||||
@@ -6007,9 +6034,9 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"handlebars": {
|
"handlebars": {
|
||||||
"version": "4.1.2",
|
"version": "4.5.3",
|
||||||
"resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.1.2.tgz",
|
"resolved": "https://registry.npmjs.org/handlebars/-/handlebars-4.5.3.tgz",
|
||||||
"integrity": "sha512-nvfrjqvt9xQ8Z/w0ijewdD/vvWDTOweBUm96NTr66Wfvo1mJenBLwcYmPs3TIBP5ruzYGD7Hx/DaM9RmhroGPw==",
|
"integrity": "sha512-3yPecJoJHK/4c6aZhSvxOyG4vJKDshV36VHp0iVCDVh7o9w2vwi3NSnL2MMPj3YdduqaBcu7cGbggJQM0br9xA==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"neo-async": "^2.6.0",
|
"neo-async": "^2.6.0",
|
||||||
@@ -6268,6 +6295,17 @@
|
|||||||
"integrity": "sha512-TcIMG3qeVLgDr1TEd2XvHaTnMPwYQUQMIBLy+5pLSDKYFc7UIqj39w8EGzZkaxoLv/l2K8HaI0t5AVA+YYgUew==",
|
"integrity": "sha512-TcIMG3qeVLgDr1TEd2XvHaTnMPwYQUQMIBLy+5pLSDKYFc7UIqj39w8EGzZkaxoLv/l2K8HaI0t5AVA+YYgUew==",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"http-proxy-agent": {
|
||||||
|
"version": "4.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/http-proxy-agent/-/http-proxy-agent-4.0.1.tgz",
|
||||||
|
"integrity": "sha512-k0zdNgqWTGA6aeIRVpvfVob4fL52dTfaehylg0Y4UvSySvOq/Y+BOyPrgpUrA7HylqvU8vIZGsRuXmspskV0Tg==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"@tootallnate/once": "1",
|
||||||
|
"agent-base": "6",
|
||||||
|
"debug": "4"
|
||||||
|
}
|
||||||
|
},
|
||||||
"http-signature": {
|
"http-signature": {
|
||||||
"version": "1.2.0",
|
"version": "1.2.0",
|
||||||
"resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz",
|
"resolved": "https://registry.npmjs.org/http-signature/-/http-signature-1.2.0.tgz",
|
||||||
@@ -6286,24 +6324,13 @@
|
|||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"https-proxy-agent": {
|
"https-proxy-agent": {
|
||||||
"version": "2.2.2",
|
"version": "5.0.1",
|
||||||
"resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-2.2.2.tgz",
|
"resolved": "https://registry.npmjs.org/https-proxy-agent/-/https-proxy-agent-5.0.1.tgz",
|
||||||
"integrity": "sha512-c8Ndjc9Bkpfx/vCJueCPy0jlP4ccCCSNDp8xwCZzPjKJUm+B+u9WX2x98Qx4n1PiMNTWo3D7KK5ifNV/yJyRzg==",
|
"integrity": "sha512-dFcAjpTQFgoLMzC2VwU+C/CbS7uRL0lWmxDITmqm7C+7F0Odmj6s9l6alZc6AELXhrnggM2CeWSXHGOdX2YtwA==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"agent-base": "^4.3.0",
|
"agent-base": "6",
|
||||||
"debug": "^3.1.0"
|
"debug": "4"
|
||||||
},
|
|
||||||
"dependencies": {
|
|
||||||
"debug": {
|
|
||||||
"version": "3.2.6",
|
|
||||||
"resolved": "https://registry.npmjs.org/debug/-/debug-3.2.6.tgz",
|
|
||||||
"integrity": "sha512-mel+jf7nrtEl5Pn1Qx46zARXKDpBbvzezse7p7LqINmdoIk8PYP5SySaxEmYv6TZ0JyEKA1hsCId6DIhgITtWQ==",
|
|
||||||
"dev": true,
|
|
||||||
"requires": {
|
|
||||||
"ms": "^2.1.1"
|
|
||||||
}
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"husky": {
|
"husky": {
|
||||||
@@ -6440,9 +6467,9 @@
|
|||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
"ignore-walk": {
|
"ignore-walk": {
|
||||||
"version": "3.0.1",
|
"version": "3.0.4",
|
||||||
"resolved": "https://registry.npmjs.org/ignore-walk/-/ignore-walk-3.0.1.tgz",
|
"resolved": "https://registry.npmjs.org/ignore-walk/-/ignore-walk-3.0.4.tgz",
|
||||||
"integrity": "sha512-DTVlMx3IYPe0/JJcYP7Gxg7ttZZu3IInhuEhbchuqneY9wWe5Ojy2mXLBaQFUQmo0AW2r3qG7m1mg86js+gnlQ==",
|
"integrity": "sha512-PY6Ii8o1jMRA1z4F2hRkH/xN59ox43DavKvD3oDpfurRlOJyAHpifIwpbdv1n4jt4ov0jSpw3kQ4GhJnpBL6WQ==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"minimatch": "^3.0.4"
|
"minimatch": "^3.0.4"
|
||||||
@@ -8754,10 +8781,37 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"node-fetch": {
|
"node-fetch": {
|
||||||
"version": "2.6.0",
|
"version": "2.6.7",
|
||||||
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.0.tgz",
|
"resolved": "https://registry.npmjs.org/node-fetch/-/node-fetch-2.6.7.tgz",
|
||||||
"integrity": "sha512-8dG4H5ujfvFiqDmVu9fQ5bOHUC15JMjMY/Zumv26oOvvVJjM67KF8koCWIabKQ1GJIa9r2mMZscBq/TbdOcmNA==",
|
"integrity": "sha512-ZjMPFEfVx5j+y2yF35Kzx5sF7kDzxuDj6ziH4FFbOp87zKDZNx8yExJIb05OGF4Nlt9IHFIMBkRl41VdvcNdbQ==",
|
||||||
"dev": true
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"whatwg-url": "^5.0.0"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"tr46": {
|
||||||
|
"version": "0.0.3",
|
||||||
|
"resolved": "https://registry.npmjs.org/tr46/-/tr46-0.0.3.tgz",
|
||||||
|
"integrity": "sha512-N3WMsuqV66lT30CrXNbEjx4GEwlow3v6rr4mCcv6prnfwhS01rkgyFdjPNBYd9br7LpXV1+Emh01fHnq2Gdgrw==",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"webidl-conversions": {
|
||||||
|
"version": "3.0.1",
|
||||||
|
"resolved": "https://registry.npmjs.org/webidl-conversions/-/webidl-conversions-3.0.1.tgz",
|
||||||
|
"integrity": "sha512-2JAn3z8AR6rjK8Sm8orRC0h/bcl/DqL7tRPdGZ4I1CjdF+EaMLmYxBHyXuKL849eucPFhvBoxMsflfOb8kxaeQ==",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
|
"whatwg-url": {
|
||||||
|
"version": "5.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/whatwg-url/-/whatwg-url-5.0.0.tgz",
|
||||||
|
"integrity": "sha512-saE57nupxk6v3HY35+jzBwYa0rKSy0XR8JSxZPwgLr7ys0IBzhGviA1/TUGJLmSVqs8pb9AnvICXEuOHLprYTw==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"tr46": "~0.0.3",
|
||||||
|
"webidl-conversions": "^3.0.0"
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
},
|
},
|
||||||
"node-int64": {
|
"node-int64": {
|
||||||
"version": "0.4.0",
|
"version": "0.4.0",
|
||||||
@@ -11336,6 +11390,15 @@
|
|||||||
"stream-shift": "^1.0.0"
|
"stream-shift": "^1.0.0"
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
|
"stream-events": {
|
||||||
|
"version": "1.0.5",
|
||||||
|
"resolved": "https://registry.npmjs.org/stream-events/-/stream-events-1.0.5.tgz",
|
||||||
|
"integrity": "sha512-E1GUzBSgvct8Jsb3v2X15pjzN1tYebtbLaMg+eBOUOAxgbLoSbT2NS91ckc5lJD1KfLjId+jXJRgo0qnV5Nerg==",
|
||||||
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"stubs": "^3.0.0"
|
||||||
|
}
|
||||||
|
},
|
||||||
"stream-http": {
|
"stream-http": {
|
||||||
"version": "2.8.3",
|
"version": "2.8.3",
|
||||||
"resolved": "https://registry.npmjs.org/stream-http/-/stream-http-2.8.3.tgz",
|
"resolved": "https://registry.npmjs.org/stream-http/-/stream-http-2.8.3.tgz",
|
||||||
@@ -11535,6 +11598,12 @@
|
|||||||
"integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=",
|
"integrity": "sha1-PFMZQukIwml8DsNEhYwobHygpgo=",
|
||||||
"dev": true
|
"dev": true
|
||||||
},
|
},
|
||||||
|
"stubs": {
|
||||||
|
"version": "3.0.0",
|
||||||
|
"resolved": "https://registry.npmjs.org/stubs/-/stubs-3.0.0.tgz",
|
||||||
|
"integrity": "sha512-PdHt7hHUJKxvTCgbKX9C1V/ftOcjJQgz8BZwNfV5c4B6dcGqlpelTbJ999jBGZ2jYiPAwcX5dP6oBwVlBlUbxw==",
|
||||||
|
"dev": true
|
||||||
|
},
|
||||||
"supports-color": {
|
"supports-color": {
|
||||||
"version": "5.5.0",
|
"version": "5.5.0",
|
||||||
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
|
"resolved": "https://registry.npmjs.org/supports-color/-/supports-color-5.5.0.tgz",
|
||||||
@@ -11668,14 +11737,24 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"teeny-request": {
|
"teeny-request": {
|
||||||
"version": "3.11.3",
|
"version": "7.1.1",
|
||||||
"resolved": "https://registry.npmjs.org/teeny-request/-/teeny-request-3.11.3.tgz",
|
"resolved": "https://registry.npmjs.org/teeny-request/-/teeny-request-7.1.1.tgz",
|
||||||
"integrity": "sha512-CKncqSF7sH6p4rzCgkb/z/Pcos5efl0DmolzvlqRQUNcpRIruOhY9+T1FsIlyEbfWd7MsFpodROOwHYh2BaXzw==",
|
"integrity": "sha512-iwY6rkW5DDGq8hE2YgNQlKbptYpY5Nn2xecjQiNjOXWbKzPGUfmeUBCSQbbr306d7Z7U2N0TPl+/SwYRfua1Dg==",
|
||||||
"dev": true,
|
"dev": true,
|
||||||
"requires": {
|
"requires": {
|
||||||
"https-proxy-agent": "^2.2.1",
|
"http-proxy-agent": "^4.0.0",
|
||||||
"node-fetch": "^2.2.0",
|
"https-proxy-agent": "^5.0.0",
|
||||||
"uuid": "^3.3.2"
|
"node-fetch": "^2.6.1",
|
||||||
|
"stream-events": "^1.0.5",
|
||||||
|
"uuid": "^8.0.0"
|
||||||
|
},
|
||||||
|
"dependencies": {
|
||||||
|
"uuid": {
|
||||||
|
"version": "8.3.2",
|
||||||
|
"resolved": "https://registry.npmjs.org/uuid/-/uuid-8.3.2.tgz",
|
||||||
|
"integrity": "sha512-+NYs2QeMWy+GWFOEm9xnn6HCDp0l7QBD7ml8zLUmJ+93Q5NF0NocErnwkTkXVFNiX3/fpC6afS8Dhb/gz7R7eg==",
|
||||||
|
"dev": true
|
||||||
|
}
|
||||||
}
|
}
|
||||||
},
|
},
|
||||||
"term-size": {
|
"term-size": {
|
||||||
@@ -12633,10 +12712,13 @@
|
|||||||
}
|
}
|
||||||
},
|
},
|
||||||
"urlgrey": {
|
"urlgrey": {
|
||||||
"version": "0.4.4",
|
"version": "1.0.0",
|
||||||
"resolved": "https://registry.npmjs.org/urlgrey/-/urlgrey-0.4.4.tgz",
|
"resolved": "https://registry.npmjs.org/urlgrey/-/urlgrey-1.0.0.tgz",
|
||||||
"integrity": "sha1-iS/pWWCAXoVRnxzUOJ8stMu3ZS8=",
|
"integrity": "sha512-hJfIzMPJmI9IlLkby8QrsCykQ+SXDeO2W5Q9QTW3QpqZVTx4a/K7p8/5q+/isD8vsbVaFgql/gvAoQCRQ2Cb5w==",
|
||||||
"dev": true
|
"dev": true,
|
||||||
|
"requires": {
|
||||||
|
"fast-url-parser": "^1.1.3"
|
||||||
|
}
|
||||||
},
|
},
|
||||||
"use": {
|
"use": {
|
||||||
"version": "3.1.1",
|
"version": "3.1.1",
|
||||||
|
|||||||
+4
-3
@@ -1,6 +1,6 @@
|
|||||||
{
|
{
|
||||||
"name": "react-fiber-traverse",
|
"name": "react-fiber-traverse",
|
||||||
"version": "0.0.7",
|
"version": "0.0.8",
|
||||||
"description": "Traverse and other utils on top of React fiber tree",
|
"description": "Traverse and other utils on top of React fiber tree",
|
||||||
"main": "dist/index.js",
|
"main": "dist/index.js",
|
||||||
"module": "dist/react-fiber-traverse.esm.js",
|
"module": "dist/react-fiber-traverse.esm.js",
|
||||||
@@ -37,7 +37,7 @@
|
|||||||
"test:src:watch": "npm run test:src -- --watch",
|
"test:src:watch": "npm run test:src -- --watch",
|
||||||
"test:umd": "jest --config ./scripts/jest/config.umd.js",
|
"test:umd": "jest --config ./scripts/jest/config.umd.js",
|
||||||
"test:umdprod": "jest --config ./scripts/jest/config.umdprod.js",
|
"test:umdprod": "jest --config ./scripts/jest/config.umdprod.js",
|
||||||
"test:src:debug": "node --inspect ./node_modules/jest/bin/jest.js --config ./scripts/jest/config.src.js",
|
"test:src:debug": "node --inspect ./node_modules/jest/bin/jest.js --runInBand --config ./scripts/jest/config.src.js",
|
||||||
"version": "run-s test authors docs && git add ."
|
"version": "run-s test authors docs && git add ."
|
||||||
},
|
},
|
||||||
"husky": {
|
"husky": {
|
||||||
@@ -66,6 +66,7 @@
|
|||||||
},
|
},
|
||||||
"dependencies": {
|
"dependencies": {
|
||||||
"@babel/runtime": "^7.5.4",
|
"@babel/runtime": "^7.5.4",
|
||||||
|
"css-what": "^3.2.0",
|
||||||
"prop-types": "^15.7.2"
|
"prop-types": "^15.7.2"
|
||||||
},
|
},
|
||||||
"devDependencies": {
|
"devDependencies": {
|
||||||
@@ -84,7 +85,7 @@
|
|||||||
"@typescript-eslint/parser": "1.12.0",
|
"@typescript-eslint/parser": "1.12.0",
|
||||||
"babel-core": "6.26.3",
|
"babel-core": "6.26.3",
|
||||||
"babel-plugin-transform-react-remove-prop-types": "0.4.24",
|
"babel-plugin-transform-react-remove-prop-types": "0.4.24",
|
||||||
"codecov": "3.5.0",
|
"codecov": "3.8.3",
|
||||||
"cp-cli": "2.0.0",
|
"cp-cli": "2.0.0",
|
||||||
"cross-env": "5.2.0",
|
"cross-env": "5.2.0",
|
||||||
"del-cli": "2.0.0",
|
"del-cli": "2.0.0",
|
||||||
|
|||||||
+108
-52
@@ -1,94 +1,150 @@
|
|||||||
import { FiberNode } from "./mocked-types";
|
import { FiberNode } from "./mocked-types";
|
||||||
|
import { traverseGenerator, TTraverseConfig } from "./traverse";
|
||||||
import { isNodeNotHtmlLike } from "./utils";
|
import { isNodeNotHtmlLike } from "./utils";
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Find node by component name, till first match.
|
||||||
|
*
|
||||||
|
* Matches against class and function name, doesn't match html-like nodes.
|
||||||
|
* Returns null if no match is found.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* ```js
|
||||||
|
* // returns FiberNode for first usage of 'AccordionMenu'
|
||||||
|
* findNodeByComponentName(startNode, "AccordionMenu");
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* @note Highest chance of collision, least data access needed.
|
||||||
|
* Different components with same name will collide.
|
||||||
|
* Needs access to component name.
|
||||||
|
*
|
||||||
|
*/
|
||||||
function findNodeByComponentName(
|
function findNodeByComponentName(
|
||||||
node: FiberNode | null,
|
node: FiberNode | null,
|
||||||
expectedName: string
|
expectedName: string,
|
||||||
|
traverseConfig?: TTraverseConfig
|
||||||
): FiberNode | null {
|
): FiberNode | null {
|
||||||
if (node === null) {
|
if (node === null) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (isNodeNotHtmlLike(node) && node.type.name === expectedName) {
|
const nodeIterator = traverseGenerator(node, traverseConfig);
|
||||||
return node;
|
for (const tmpNode of nodeIterator) {
|
||||||
}
|
if (isNodeNotHtmlLike(tmpNode) && tmpNode.type.name === expectedName) {
|
||||||
|
return tmpNode;
|
||||||
{
|
|
||||||
const returnVal = findNodeByComponentName(node.child, expectedName);
|
|
||||||
if (returnVal !== null) {
|
|
||||||
return returnVal;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
{
|
|
||||||
const returnVal = findNodeByComponentName(node.sibling, expectedName);
|
|
||||||
if (returnVal !== null) {
|
|
||||||
return returnVal;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
function* findNodesByComponentName(
|
||||||
|
node: FiberNode | null,
|
||||||
|
expectedName: string,
|
||||||
|
traverseConfig?: TTraverseConfig
|
||||||
|
): IterableIterator<FiberNode> {
|
||||||
|
if (node === null) {
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
const nodeIterator = traverseGenerator(node, traverseConfig);
|
||||||
|
for (const tmpNode of nodeIterator) {
|
||||||
|
if (isNodeNotHtmlLike(tmpNode) && tmpNode.type.name === expectedName) {
|
||||||
|
yield tmpNode;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function findAllNodesByComponentName(
|
||||||
|
node: FiberNode | null,
|
||||||
|
expectedName: string,
|
||||||
|
traverseConfig?: TTraverseConfig
|
||||||
|
): Array<FiberNode> {
|
||||||
|
return [...findNodesByComponentName(node, expectedName, traverseConfig)];
|
||||||
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Find node by component (i.e. class or function by reference), till first match.
|
||||||
|
*
|
||||||
|
* Matches against class and function by reference.
|
||||||
|
* Returns null if no match is found.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* ```js
|
||||||
|
* // returns FiberNode for first usage of AccordionMenu
|
||||||
|
* findNodeByComponent(startNode, AccordionMenu);
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* @note Medium chance of collision, medium data access needed.
|
||||||
|
* This is safer than findNodeByComponentName, as different components with the same name won't collide.
|
||||||
|
* But, two instances of the same component will still collide.
|
||||||
|
* Needs access to component class or function.
|
||||||
|
*
|
||||||
|
*/
|
||||||
function findNodeByComponent(
|
function findNodeByComponent(
|
||||||
node: FiberNode | null,
|
node: FiberNode | null,
|
||||||
expectedClassOrFunction: React.ComponentType
|
expectedClassOrFunction: React.ComponentType,
|
||||||
|
traverseConfig?: TTraverseConfig
|
||||||
): FiberNode | null {
|
): FiberNode | null {
|
||||||
if (node === null) {
|
if (node === null) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (isNodeNotHtmlLike(node) && node.type === expectedClassOrFunction) {
|
const nodeIterator = traverseGenerator(node, traverseConfig);
|
||||||
return node;
|
for (const tmpNode of nodeIterator) {
|
||||||
}
|
if (
|
||||||
|
isNodeNotHtmlLike(tmpNode) &&
|
||||||
{
|
tmpNode.type === expectedClassOrFunction
|
||||||
const returnVal = findNodeByComponent(node.child, expectedClassOrFunction);
|
) {
|
||||||
if (returnVal !== null) {
|
return tmpNode;
|
||||||
return returnVal;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
{
|
|
||||||
const returnVal = findNodeByComponent(
|
|
||||||
node.sibling,
|
|
||||||
expectedClassOrFunction
|
|
||||||
);
|
|
||||||
if (returnVal !== null) {
|
|
||||||
return returnVal;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Find node by component instance ref, till first match.
|
||||||
|
*
|
||||||
|
* Matches against class instances by reference.
|
||||||
|
* Returns null if no match is found.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* ```js
|
||||||
|
* // menuRef=createRef(); <AccordionMenu ref={menuRef}>
|
||||||
|
* findNodeByComponentRef(startNode, menuRef.current);
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
* @note Least chance of collision, maximum data access needed.
|
||||||
|
* Needs access to component instance (through React ref usually).
|
||||||
|
*
|
||||||
|
*/
|
||||||
function findNodeByComponentRef(
|
function findNodeByComponentRef(
|
||||||
node: FiberNode | null,
|
node: FiberNode | null,
|
||||||
expectedClassInstance: React.Component
|
expectedClassInstance: React.Component,
|
||||||
|
traverseConfig?: TTraverseConfig
|
||||||
): FiberNode | null {
|
): FiberNode | null {
|
||||||
if (node === null) {
|
if (node === null) {
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
if (isNodeNotHtmlLike(node) && node.stateNode === expectedClassInstance) {
|
const nodeIterator = traverseGenerator(node, traverseConfig);
|
||||||
return node;
|
for (const tmpNode of nodeIterator) {
|
||||||
}
|
if (
|
||||||
|
isNodeNotHtmlLike(tmpNode) &&
|
||||||
{
|
tmpNode.stateNode === expectedClassInstance
|
||||||
const returnVal = findNodeByComponentRef(node.child, expectedClassInstance);
|
) {
|
||||||
if (returnVal !== null) {
|
return tmpNode;
|
||||||
return returnVal;
|
|
||||||
}
|
|
||||||
}
|
|
||||||
{
|
|
||||||
const returnVal = findNodeByComponentRef(
|
|
||||||
node.sibling,
|
|
||||||
expectedClassInstance
|
|
||||||
);
|
|
||||||
if (returnVal !== null) {
|
|
||||||
return returnVal;
|
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
return null;
|
return null;
|
||||||
}
|
}
|
||||||
|
|
||||||
export { findNodeByComponentName, findNodeByComponent, findNodeByComponentRef };
|
export {
|
||||||
|
findNodeByComponentName,
|
||||||
|
findNodesByComponentName,
|
||||||
|
findAllNodesByComponentName,
|
||||||
|
findNodeByComponent,
|
||||||
|
findNodeByComponentRef
|
||||||
|
};
|
||||||
|
|||||||
@@ -4,6 +4,7 @@ import {
|
|||||||
findNodeByComponentRef,
|
findNodeByComponentRef,
|
||||||
findNodeByComponentName
|
findNodeByComponentName
|
||||||
} from "./findNode";
|
} from "./findNode";
|
||||||
|
import { matchGenerator, matchAll, matchFirst } from "./match";
|
||||||
import * as Utils from "./utils";
|
import * as Utils from "./utils";
|
||||||
|
|
||||||
export {
|
export {
|
||||||
@@ -12,5 +13,8 @@ export {
|
|||||||
findNodeByComponent,
|
findNodeByComponent,
|
||||||
findNodeByComponentRef,
|
findNodeByComponentRef,
|
||||||
findNodeByComponentName,
|
findNodeByComponentName,
|
||||||
|
matchGenerator,
|
||||||
|
matchAll,
|
||||||
|
matchFirst,
|
||||||
Utils
|
Utils
|
||||||
};
|
};
|
||||||
|
|||||||
+141
@@ -0,0 +1,141 @@
|
|||||||
|
import * as CSSWhat from "css-what";
|
||||||
|
import { traverseGenerator } from "./traverse";
|
||||||
|
import { FiberNode } from "./mocked-types";
|
||||||
|
import { isNodeNotHtmlLike } from "./utils";
|
||||||
|
|
||||||
|
function* matchGenerator(
|
||||||
|
node: FiberNode,
|
||||||
|
match: string | CSSWhat.Selector[][]
|
||||||
|
): IterableIterator<FiberNode> {
|
||||||
|
// Either parse match string or allow parsed match object as it is
|
||||||
|
let matchParsed: CSSWhat.Selector[][];
|
||||||
|
if (typeof match === "string") {
|
||||||
|
matchParsed = CSSWhat.parse(match, {
|
||||||
|
lowerCaseTags: false,
|
||||||
|
lowerCaseAttributeNames: false
|
||||||
|
});
|
||||||
|
} else {
|
||||||
|
matchParsed = match;
|
||||||
|
}
|
||||||
|
// If selector is a combination of multiple basic selectors (a, b),
|
||||||
|
// pass them separately to matchGenerator and combine their results one after another
|
||||||
|
const selectorsCount = matchParsed.length;
|
||||||
|
if (selectorsCount > 1) {
|
||||||
|
for (const selectorParsed of matchParsed) {
|
||||||
|
yield* matchGenerator(node, [selectorParsed]);
|
||||||
|
}
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
// For simple selector (matchParsed.length == 0), actual logic starts here
|
||||||
|
{
|
||||||
|
const parsedSelector = matchParsed[0];
|
||||||
|
if (parsedSelector.length === 0) {
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
|
||||||
|
let currentMatchingNodes: FiberNode[] = [node];
|
||||||
|
let currentMatchingSelectorPartIndex = 0;
|
||||||
|
let lastRelationshipSelectorPart: CSSWhat.Selector | undefined = undefined;
|
||||||
|
|
||||||
|
while (currentMatchingSelectorPartIndex < parsedSelector.length) {
|
||||||
|
const nextMatchingNodes: FiberNode[] = [];
|
||||||
|
|
||||||
|
for (const currentNode of currentMatchingNodes) {
|
||||||
|
const currentMatchingSelectorPart: CSSWhat.Selector =
|
||||||
|
parsedSelector[currentMatchingSelectorPartIndex];
|
||||||
|
if (["tag"].includes(currentMatchingSelectorPart.type)) {
|
||||||
|
const startParams = {
|
||||||
|
skipSelfForStartNode: true,
|
||||||
|
skipSiblingForStartNode: true
|
||||||
|
};
|
||||||
|
|
||||||
|
let nextParams: {
|
||||||
|
skipChild?: boolean;
|
||||||
|
skipSibling?: boolean;
|
||||||
|
} = {};
|
||||||
|
if (
|
||||||
|
lastRelationshipSelectorPart === undefined ||
|
||||||
|
lastRelationshipSelectorPart.type === "descendant"
|
||||||
|
) {
|
||||||
|
nextParams = { skipChild: false, skipSibling: false };
|
||||||
|
} else if (lastRelationshipSelectorPart.type === "child") {
|
||||||
|
// visit only first level of child
|
||||||
|
nextParams = { skipChild: true };
|
||||||
|
} else if (lastRelationshipSelectorPart.type === "sibling") {
|
||||||
|
// visit only siblings of start node
|
||||||
|
nextParams = { skipChild: true, skipSibling: true };
|
||||||
|
startParams.skipSiblingForStartNode = false;
|
||||||
|
}
|
||||||
|
|
||||||
|
const traverseIterator = traverseGenerator(currentNode, startParams);
|
||||||
|
|
||||||
|
// Handle supported non-traversal parts here
|
||||||
|
if (currentMatchingSelectorPart.type == "tag") {
|
||||||
|
let tmpNode: FiberNode;
|
||||||
|
while (
|
||||||
|
!({ value: tmpNode } = traverseIterator.next(nextParams)).done
|
||||||
|
) {
|
||||||
|
if (
|
||||||
|
isNodeNotHtmlLike(tmpNode) &&
|
||||||
|
tmpNode.type.name === currentMatchingSelectorPart.name
|
||||||
|
) {
|
||||||
|
nextMatchingNodes.push(tmpNode);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
}
|
||||||
|
// traverseIterator.throw &&
|
||||||
|
// traverseIterator.throw(new Error("cleanup"));
|
||||||
|
} else if (
|
||||||
|
["descendant", "child"].includes(currentMatchingSelectorPart.type)
|
||||||
|
) {
|
||||||
|
// Handle traversal parts here - Save for look back in next part
|
||||||
|
lastRelationshipSelectorPart = currentMatchingSelectorPart;
|
||||||
|
// Preserve currentMatchingNodes
|
||||||
|
nextMatchingNodes.push(...currentMatchingNodes);
|
||||||
|
} else {
|
||||||
|
// For unhandled parts
|
||||||
|
lastRelationshipSelectorPart = undefined;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
currentMatchingNodes = nextMatchingNodes;
|
||||||
|
currentMatchingSelectorPartIndex += 1;
|
||||||
|
}
|
||||||
|
|
||||||
|
for (const tmpNode of currentMatchingNodes) {
|
||||||
|
yield tmpNode;
|
||||||
|
}
|
||||||
|
|
||||||
|
return;
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
function matchAll(
|
||||||
|
node: FiberNode,
|
||||||
|
match: string | CSSWhat.Selector[][]
|
||||||
|
): Array<FiberNode> {
|
||||||
|
return [...matchGenerator(node, match)];
|
||||||
|
}
|
||||||
|
|
||||||
|
function matchFirst(
|
||||||
|
node: FiberNode,
|
||||||
|
match: string | CSSWhat.Selector[][]
|
||||||
|
): FiberNode | null {
|
||||||
|
const matchIterator = matchGenerator(node, match);
|
||||||
|
const firstResult = matchIterator.next();
|
||||||
|
|
||||||
|
// Cancel generator
|
||||||
|
matchIterator.throw && matchIterator.throw(new Error("Cleanup"));
|
||||||
|
|
||||||
|
// If match found, return that
|
||||||
|
if (!firstResult.done) {
|
||||||
|
return firstResult.value;
|
||||||
|
}
|
||||||
|
|
||||||
|
// Else return null
|
||||||
|
return null;
|
||||||
|
}
|
||||||
|
|
||||||
|
export { matchGenerator, matchAll, matchFirst };
|
||||||
@@ -44,16 +44,6 @@ export interface FiberNodeForInstrinsicElement {
|
|||||||
stateNode: HTMLElement;
|
stateNode: HTMLElement;
|
||||||
}
|
}
|
||||||
|
|
||||||
export interface FiberNodeForInstrinsicElement {
|
|
||||||
child: FiberNode | null;
|
|
||||||
sibling: FiberNode | null;
|
|
||||||
|
|
||||||
elementType: keyof JSX.IntrinsicElements;
|
|
||||||
type: keyof JSX.IntrinsicElements;
|
|
||||||
|
|
||||||
stateNode: HTMLElement;
|
|
||||||
}
|
|
||||||
|
|
||||||
export interface FiberNodeForTextNode {
|
export interface FiberNodeForTextNode {
|
||||||
child: null;
|
child: null;
|
||||||
sibling: FiberNode | null;
|
sibling: FiberNode | null;
|
||||||
|
|||||||
+112
-20
@@ -1,47 +1,114 @@
|
|||||||
// import { isNodeSimple } from './utils';
|
// import { isNodeSimple } from './utils';
|
||||||
import { FiberNode } from "./mocked-types";
|
import { FiberNode } from "./mocked-types";
|
||||||
|
|
||||||
function traverse(node: FiberNode, fn: (node: FiberNode) => any) {
|
interface TTraverseConfig {
|
||||||
fn.call(null, node);
|
order?: Array<"self" | "child" | "sibling">;
|
||||||
|
skipSiblingForStartNode?: boolean;
|
||||||
if (node.child !== null) {
|
skipSelfForStartNode?: boolean;
|
||||||
traverse(node.child, fn);
|
|
||||||
}
|
|
||||||
if (node.sibling !== null) {
|
|
||||||
traverse(node.sibling, fn);
|
|
||||||
}
|
|
||||||
}
|
}
|
||||||
|
|
||||||
|
/**
|
||||||
|
* Traverse nodes recursively using generators.
|
||||||
|
*
|
||||||
|
* This is the advanced traverse function, which can be used used
|
||||||
|
* to write other variants of traversal and find.
|
||||||
|
*
|
||||||
|
* Type signature for generator.next first argument is `{ skipChild?: boolean; skipSibling?: boolean } | void `
|
||||||
|
* Throw any error into the generator to finish the generator and let it cleanup its internals.
|
||||||
|
*
|
||||||
|
* It allows inversion of control -
|
||||||
|
* so, application code can decide to
|
||||||
|
* 1. change order of traversal,
|
||||||
|
* 2. skip some elements,
|
||||||
|
* 3. cancel traversal mid-way.
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* ```js
|
||||||
|
* // Basic use (for-of)
|
||||||
|
*
|
||||||
|
* const nodeIterator = traverseGenerator(rootNode);
|
||||||
|
* for (const node of nodeIterator) {
|
||||||
|
* // do something with each node here
|
||||||
|
* }
|
||||||
|
* ```
|
||||||
|
* ------
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* ```js
|
||||||
|
* // Breadth-first
|
||||||
|
*
|
||||||
|
* // note the order below
|
||||||
|
* const nodeIterator = traverseGenerator(rootNode, ["self", "sibling", "child"]);
|
||||||
|
* // rest - same as above
|
||||||
|
* ```
|
||||||
|
* -----
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* ```js
|
||||||
|
* // Get first 3 nodes and then stop the generator
|
||||||
|
*
|
||||||
|
* const nodeIterator = traverseGenerator(rootNode);
|
||||||
|
*
|
||||||
|
* var count = 0;
|
||||||
|
* var next;
|
||||||
|
* while (
|
||||||
|
* count < 3 &&
|
||||||
|
* !(next = nodeIterator.next()).done
|
||||||
|
* ) {
|
||||||
|
* count++;
|
||||||
|
* const node = next.value;
|
||||||
|
* // do something with each node here
|
||||||
|
* }
|
||||||
|
*
|
||||||
|
* // Finish generator, to prevent memory leak
|
||||||
|
* nodeIterator.throw(new Error());
|
||||||
|
* ```
|
||||||
|
* -----
|
||||||
|
*
|
||||||
|
*/
|
||||||
function* traverseGenerator(
|
function* traverseGenerator(
|
||||||
node: FiberNode,
|
node: FiberNode,
|
||||||
{
|
{
|
||||||
order = ["self", "child", "sibling"]
|
order = ["self", "child", "sibling"],
|
||||||
}: { order?: Array<"self" | "child" | "sibling"> } = {}
|
skipSiblingForStartNode = true,
|
||||||
|
skipSelfForStartNode = false
|
||||||
|
}: TTraverseConfig = {}
|
||||||
): IterableIterator<FiberNode> {
|
): IterableIterator<FiberNode> {
|
||||||
let skipChild = false,
|
let skipChild = false,
|
||||||
skipSibling = false;
|
skipSibling = skipSiblingForStartNode,
|
||||||
|
skipSelf = skipSelfForStartNode;
|
||||||
|
|
||||||
function* traverseSelf() {
|
function* traverseSelf() {
|
||||||
const controlInput:
|
if (!skipSelf) {
|
||||||
| { skipChild: boolean; skipSibling: boolean }
|
const controlInput:
|
||||||
| undefined = yield node;
|
| { skipChild?: boolean; skipSibling?: boolean }
|
||||||
|
| undefined = yield node;
|
||||||
|
|
||||||
if (controlInput !== undefined) {
|
if (controlInput !== undefined) {
|
||||||
({ skipChild = skipChild, skipSibling = skipSibling } = controlInput);
|
({ skipChild = skipChild, skipSibling = skipSibling } = controlInput);
|
||||||
|
}
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function* traverseChild() {
|
function* traverseChild() {
|
||||||
if (!skipChild && node.child !== null) {
|
if (!skipChild && node.child !== null) {
|
||||||
const nextNode = node.child;
|
const nextNode = node.child;
|
||||||
yield* traverseGenerator(nextNode, { order });
|
yield* traverseGenerator(nextNode, {
|
||||||
|
order,
|
||||||
|
skipSiblingForStartNode: false,
|
||||||
|
skipSelfForStartNode: false
|
||||||
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
function* traverseSibling() {
|
function* traverseSibling() {
|
||||||
if (!skipSibling && node.sibling !== null) {
|
if (!skipSibling && node.sibling !== null) {
|
||||||
const nextNode = node.sibling;
|
const nextNode = node.sibling;
|
||||||
yield* traverseGenerator(nextNode, { order });
|
yield* traverseGenerator(nextNode, {
|
||||||
|
order,
|
||||||
|
skipSiblingForStartNode: false,
|
||||||
|
skipSelfForStartNode: false
|
||||||
|
});
|
||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
@@ -62,4 +129,29 @@ function* traverseGenerator(
|
|||||||
}
|
}
|
||||||
}
|
}
|
||||||
|
|
||||||
export { traverse, traverseGenerator };
|
/**
|
||||||
|
* Traverse nodes recursively in depth-first manner, starting from a start node.
|
||||||
|
*
|
||||||
|
* This is the default and basic traversal function, 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 {@link traverseGenerator}
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* ```js
|
||||||
|
* // calls fn for each node inside startNode
|
||||||
|
* traverse(startNode, fn);
|
||||||
|
* ```
|
||||||
|
*
|
||||||
|
*/
|
||||||
|
function traverse(
|
||||||
|
node: FiberNode,
|
||||||
|
fn: (node: FiberNode) => any,
|
||||||
|
traverseConfig?: TTraverseConfig
|
||||||
|
) {
|
||||||
|
const nodeIterator = traverseGenerator(node, traverseConfig);
|
||||||
|
for (const tmpNode of nodeIterator) {
|
||||||
|
fn.call(null, tmpNode);
|
||||||
|
}
|
||||||
|
}
|
||||||
|
|
||||||
|
export { traverse, traverseGenerator, TTraverseConfig };
|
||||||
|
|||||||
+1
-1
@@ -89,7 +89,7 @@ function getRootFiberNodeFromDOM(startElement?: Element): FiberNode | null {
|
|||||||
}
|
}
|
||||||
|
|
||||||
let returnFiberNode = null;
|
let returnFiberNode = null;
|
||||||
for (const childNode of startElement.children) {
|
for (const childNode of [].slice.call(startElement.children)) {
|
||||||
returnFiberNode = getRootFiberNodeFromDOM(childNode);
|
returnFiberNode = getRootFiberNodeFromDOM(childNode);
|
||||||
if (returnFiberNode !== null) {
|
if (returnFiberNode !== null) {
|
||||||
return returnFiberNode;
|
return returnFiberNode;
|
||||||
|
|||||||
@@ -0,0 +1,139 @@
|
|||||||
|
import * as React from "react";
|
||||||
|
|
||||||
|
// Import stuff from src
|
||||||
|
import {
|
||||||
|
// matchGenerator,
|
||||||
|
matchAll
|
||||||
|
// matchFirst
|
||||||
|
} from "../src";
|
||||||
|
|
||||||
|
import {
|
||||||
|
FiberNodeForComponentClass
|
||||||
|
// FiberNodeForInstrinsicElement,
|
||||||
|
// FiberNodeForFunctionComponent
|
||||||
|
} from "../src/mocked-types";
|
||||||
|
|
||||||
|
// Import test helpers and sample components
|
||||||
|
import { mountAndGetRootNode } from "./utils/mountInEnzyme";
|
||||||
|
import {
|
||||||
|
// createClassComponents,
|
||||||
|
// createFunctionComponents,
|
||||||
|
createClassComponent,
|
||||||
|
createClassComponents
|
||||||
|
} from "./utils/createComponent";
|
||||||
|
|
||||||
|
describe("matchGenerator", () => {
|
||||||
|
let container: HTMLDivElement;
|
||||||
|
|
||||||
|
beforeEach(() => {
|
||||||
|
container = document.body.appendChild(document.createElement("div"));
|
||||||
|
});
|
||||||
|
|
||||||
|
afterEach(() => {
|
||||||
|
document.body.removeChild(container);
|
||||||
|
});
|
||||||
|
|
||||||
|
describe("basic", () => {
|
||||||
|
it("should work for depth=1 class", () => {
|
||||||
|
const C1 = createClassComponent("C1");
|
||||||
|
function CRoot() {
|
||||||
|
return <C1 />;
|
||||||
|
}
|
||||||
|
const rootNode = mountAndGetRootNode(CRoot, container);
|
||||||
|
|
||||||
|
const nodes = matchAll(rootNode, "C1");
|
||||||
|
|
||||||
|
// Can't be zero, in any case
|
||||||
|
expect(nodes.length).not.toBe(0);
|
||||||
|
// Check that only one node is yielded
|
||||||
|
expect(nodes.length).toBe(1);
|
||||||
|
// Check that type is correct
|
||||||
|
expect((nodes[0] as FiberNodeForComponentClass).type).toBe(C1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should work for depth=2 class", () => {
|
||||||
|
const [C1, C2] = createClassComponents(["C1", "C2"]);
|
||||||
|
function CRoot() {
|
||||||
|
return (
|
||||||
|
<C1>
|
||||||
|
<C2 />
|
||||||
|
</C1>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const rootNode = mountAndGetRootNode(CRoot, container);
|
||||||
|
|
||||||
|
const nodes = matchAll(rootNode, "C2");
|
||||||
|
|
||||||
|
// Can't be zero, in any case
|
||||||
|
expect(nodes.length).not.toBe(0);
|
||||||
|
// Check that only one node is yielded
|
||||||
|
expect(nodes.length).toBe(1);
|
||||||
|
// Check that type is correct
|
||||||
|
expect((nodes[0] as FiberNodeForComponentClass).type).toBe(C2);
|
||||||
|
expect((nodes[0] as FiberNodeForComponentClass).type).not.toBe(C1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should work for depth=2 class with descendant selector", () => {
|
||||||
|
const [C1, C2] = createClassComponents(["C1", "C2"]);
|
||||||
|
function CRoot() {
|
||||||
|
return (
|
||||||
|
<C1>
|
||||||
|
<C2 />
|
||||||
|
</C1>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const rootNode = mountAndGetRootNode(CRoot, container);
|
||||||
|
|
||||||
|
const nodes = matchAll(rootNode, "C1 C2");
|
||||||
|
|
||||||
|
// Can't be zero, in any case
|
||||||
|
expect(nodes.length).not.toBe(0);
|
||||||
|
// Check that only one node is yielded
|
||||||
|
expect(nodes.length).toBe(1);
|
||||||
|
// Check that type is correct
|
||||||
|
expect((nodes[0] as FiberNodeForComponentClass).type).toBe(C2);
|
||||||
|
expect((nodes[0] as FiberNodeForComponentClass).type).not.toBe(C1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should work for depth=2 class with child selector", () => {
|
||||||
|
const [C1, C2] = createClassComponents(["C1", "C2"]);
|
||||||
|
function CRoot() {
|
||||||
|
return (
|
||||||
|
<C1>
|
||||||
|
<C2 />
|
||||||
|
</C1>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const rootNode = mountAndGetRootNode(CRoot, container);
|
||||||
|
|
||||||
|
const nodes = matchAll(rootNode, "C1>C2");
|
||||||
|
|
||||||
|
// Can't be zero, in any case
|
||||||
|
expect(nodes.length).not.toBe(0);
|
||||||
|
// Check that only one node is yielded
|
||||||
|
expect(nodes.length).toBe(1);
|
||||||
|
// Check that type is correct
|
||||||
|
expect((nodes[0] as FiberNodeForComponentClass).type).toBe(C2);
|
||||||
|
expect((nodes[0] as FiberNodeForComponentClass).type).not.toBe(C1);
|
||||||
|
});
|
||||||
|
|
||||||
|
it("should not work with child selector for nth-level descendant", () => {
|
||||||
|
const [C1, C2, C3] = createClassComponents(["C1", "C2", "C3"]);
|
||||||
|
function CRoot() {
|
||||||
|
return (
|
||||||
|
<C1>
|
||||||
|
<C2>
|
||||||
|
<C3 />
|
||||||
|
</C2>
|
||||||
|
</C1>
|
||||||
|
);
|
||||||
|
}
|
||||||
|
const rootNode = mountAndGetRootNode(CRoot, container);
|
||||||
|
|
||||||
|
const nodes = matchAll(rootNode, "C1>C3");
|
||||||
|
|
||||||
|
// No matcch found
|
||||||
|
expect(nodes.length).toBe(0);
|
||||||
|
});
|
||||||
|
});
|
||||||
|
});
|
||||||
+2
-1
@@ -17,7 +17,8 @@
|
|||||||
"removeComments": true,
|
"removeComments": true,
|
||||||
"sourceMap": true,
|
"sourceMap": true,
|
||||||
"strict": true,
|
"strict": true,
|
||||||
"target": "es6"
|
"target": "es5",
|
||||||
|
"downlevelIteration": true
|
||||||
},
|
},
|
||||||
"exclude": ["node_modules", "dist"],
|
"exclude": ["node_modules", "dist"],
|
||||||
"include": ["src"]
|
"include": ["src"]
|
||||||
|
|||||||
Reference in New Issue
Block a user