3.4 KiB
Globals / "findNode" /
External module: "findNode"
Index
Functions
Functions
findNodeByComponent
▸ findNodeByComponent(node: FiberNode | null, expectedClassOrFunction: React.ComponentType): FiberNode | null
Defined in findNode.ts:67
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.
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.
example
// returns FiberNode for first usage of AccordionMenu
findNodeByComponent(startNode, AccordionMenu);
Parameters:
| Name | Type |
|---|---|
node |
FiberNode | null |
expectedClassOrFunction |
React.ComponentType |
Returns: FiberNode | null
findNodeByComponentName
▸ findNodeByComponentName(node: FiberNode | null, expectedName: string): FiberNode | null
Defined in findNode.ts:21
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.
note Highest chance of collision, least data access needed.
Different components with same name will collide.
Needs access to component name.
example
// returns FiberNode for first usage of 'AccordionMenu'
findNodeByComponentName(startNode, "AccordionMenu");
Parameters:
| Name | Type |
|---|---|
node |
FiberNode | null |
expectedName |
string |
Returns: FiberNode | null
findNodeByComponentRef
▸ findNodeByComponentRef(node: FiberNode | null, expectedClassInstance: Component): FiberNode | null
Defined in findNode.ts:113
Find node by component instance ref, till first match.
Matches against class instances by reference. Returns null if no match is found.
note Least chance of collision, maximum data access needed.
Needs access to component instance (through React ref usually).
example
// menuRef=createRef(); <AccordionMenu ref={menuRef}>
findNodeByComponentRef(startNode, menuRef.current);
Parameters:
| Name | Type |
|---|---|
node |
FiberNode | null |
expectedClassInstance |
Component |
Returns: FiberNode | null