react-fiber-traverse/docs/modules/_utils_.md

react-fiber-traverse

Globals / "utils" /

External module: "utils"

Index

Functions

• doesElementContainRootFiberNode
• getRootFiberNodeFromDOM
• isConstructorComponentClass
• isConstructorFunctionComponent
• isConstructorHtmlLike
• isNodeComponentClass
• isNodeFunctionComponent
• isNodeHtmlLike
• isNodeNotHtmlLike

Functions

doesElementContainRootFiberNode

▸ doesElementContainRootFiberNode(element: Element): boolean

Defined in utils.ts:65

Parameters:

Name	Type
element	Element

Returns: boolean

---

getRootFiberNodeFromDOM

▸ getRootFiberNodeFromDOM(startElement?: Element): FiberNode | null

Defined in utils.ts:82

Util to find root React Fiber node from html DOM tree. Returns null, if not found.SHould be called after ReactDOM.render is finished.

Parameters:

Name	Type	Description
startElement?	Element	Starting DOM element to seach from. If not found, it checks inside its child nodes. Defaults to document.body

Returns: FiberNode | null

---

isConstructorComponentClass

▸ isConstructorComponentClass(ctr: React.ElementType | null): boolean

Defined in utils.ts:42

Parameters:

Name	Type
ctr	React.ElementType | null

Returns: boolean

---

isConstructorFunctionComponent

▸ isConstructorFunctionComponent(ctr: React.ElementType | null): boolean

Defined in utils.ts:59

Parameters:

Name	Type
ctr	React.ElementType | null

Returns: boolean

---

isConstructorHtmlLike

▸ isConstructorHtmlLike(ctr: React.ElementType | null): boolean

Defined in utils.ts:33

Parameters:

Name	Type
ctr	React.ElementType | null

Returns: boolean

---

isNodeComponentClass

▸ isNodeComponentClass(node: FiberNode): boolean

Defined in utils.ts:27

Parameters:

Name	Type
node	FiberNode

Returns: boolean

---

isNodeFunctionComponent

▸ isNodeFunctionComponent(node: FiberNode): boolean

Defined in utils.ts:21

Parameters:

Name	Type
node	FiberNode

Returns: boolean

---

isNodeHtmlLike

▸ isNodeHtmlLike(node: FiberNode): boolean

Defined in utils.ts:11

Parameters:

Name	Type
node	FiberNode

Returns: boolean

---

isNodeNotHtmlLike

▸ isNodeNotHtmlLike(node: FiberNode): boolean

Defined in utils.ts:15

Parameters:

Name	Type
node	FiberNode

Returns: boolean