bendtherules/react-fiber-traverse
1
0
Fork 0
mirror of https://github.com/bendtherules/react-fiber-traverse.git synced 2026-08-18 13:52:36 +00:00
Code Issues 25 Packages Projects Releases Wiki Activity

Docs - In findNode, move exmaples above note section

Browse Source
This commit is contained in:
bendtherules
2019-09-09 18:19:30 +05:30
parent 4824828b51
commit 6cffc96d60
1 changed files with 13 additions and 12 deletions
Download Patch File Download Diff File Expand all files Collapse all files
src/findNode.ts
+13 -12
View File
@@ -7,16 +7,16 @@ import { isNodeNotHtmlLike } from "./utils";
* Matches against class and function name, doesn't match html-like nodes. * Matches against class and function name, doesn't match html-like nodes.
* Returns null if no match is found. * 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 * @example
* ```js * ```js
* // returns FiberNode for first usage of 'AccordionMenu' * // returns FiberNode for first usage of 'AccordionMenu'
* findNodeByComponentName(startNode, "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,
@@ -52,17 +52,17 @@ function findNodeByComponentName(
* Matches against class and function by reference. * Matches against class and function by reference.
* Returns null if no match is found. * 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 * @example
* ```js * ```js
* // returns FiberNode for first usage of AccordionMenu * // returns FiberNode for first usage of AccordionMenu
* findNodeByComponent(startNode, 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,
@@ -101,14 +101,15 @@ function findNodeByComponent(
* Matches against class instances by reference. * Matches against class instances by reference.
* Returns null if no match is found. * 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 * @example
* ```js * ```js
* // menuRef=createRef(); <AccordionMenu ref={menuRef}> * // menuRef=createRef(); <AccordionMenu ref={menuRef}>
* findNodeByComponentRef(startNode, menuRef.current); * 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,