diff --git a/README.md b/README.md index a930238..2057f1c 100644 --- a/README.md +++ b/README.md @@ -76,6 +76,38 @@ For the minified production version, make sure you have already included: - [`React`](https://unpkg.com/react/umd/react.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 MIT diff --git a/docs/README.md b/docs/README.md index bb6f801..e879761 100644 --- a/docs/README.md +++ b/docs/README.md @@ -13,20 +13,40 @@ ## Basic Usage -```jsx -import React from 'react' -import { render } from 'react-dom' +```ts +import React from "react"; +import { render } from "react-dom"; + +import { findNodeByComponentName, Utils } from "react-fiber-traverse"; + +// Sample component +// Say, if SomeComponentName looks like this - +function SomeComponentName() { + return
Some text
; +} + +// Render component +const rootElement = document.getElementById("root"); +render(, rootElement); + +// Get root node +const rootFiberNode = Utils.getRootFiberNodeFromDOM(rootElement); + +// Get component node +const someFiberNode = findNodeByComponentName( + rootFiberNode, + "SomeComponentName" +); // <- returns FiberNode for first usage of 'SomeComponentName' + +console.log(someFiberNode.child.stateNode); // <- returns reference to the div +console.log(someFiberNode.child.stateNode.innerText); // <- returns 'Some text' -render(, document.getElementById('root')) ``` ## Live Examples -- [Basic Usage](https://codesandbox.io/) -- [API Example](https://codesandbox.io/) -- [UMD Build (Development)](https://codesandbox.io/) -- [UMD Build (Production)](https://codesandbox.io/) - +- [Basic Usage](https://codesandbox.io/s/react-example-x82zk?expanddevtools=1&fontsize=14) + ## Installation @@ -54,7 +74,6 @@ For the non-minified development version, make sure you have already included: - [`React`](https://unpkg.com/react/umd/react.development.js) - [`ReactDOM`](https://unpkg.com/react-dom/umd/react-dom.development.js) -- [`PropTypes`](https://unpkg.com/prop-types/prop-types.js) For the minified production version, make sure you have already included: diff --git a/docs/interfaces/_mocked_types_index_.fibernodedomcontainer.md b/docs/interfaces/_mocked_types_index_.fibernodedomcontainer.md new file mode 100644 index 0000000..3ba9267 --- /dev/null +++ b/docs/interfaces/_mocked_types_index_.fibernodedomcontainer.md @@ -0,0 +1,2406 @@ +> **[react-fiber-traverse](../README.md)** + +[Globals](../globals.md) / ["mocked-types/index"](../modules/_mocked_types_index_.md) / [FiberNodeDOMContainer](_mocked_types_index_.fibernodedomcontainer.md) / + +# Interface: FiberNodeDOMContainer + +## Hierarchy + +* `Element` + + * **FiberNodeDOMContainer** + +## Index + +### Properties + +* [ATTRIBUTE_NODE](_mocked_types_index_.fibernodedomcontainer.md#attribute_node) +* [CDATA_SECTION_NODE](_mocked_types_index_.fibernodedomcontainer.md#cdata_section_node) +* [COMMENT_NODE](_mocked_types_index_.fibernodedomcontainer.md#comment_node) +* [DOCUMENT_FRAGMENT_NODE](_mocked_types_index_.fibernodedomcontainer.md#document_fragment_node) +* [DOCUMENT_NODE](_mocked_types_index_.fibernodedomcontainer.md#document_node) +* [DOCUMENT_POSITION_CONTAINED_BY](_mocked_types_index_.fibernodedomcontainer.md#document_position_contained_by) +* [DOCUMENT_POSITION_CONTAINS](_mocked_types_index_.fibernodedomcontainer.md#document_position_contains) +* [DOCUMENT_POSITION_DISCONNECTED](_mocked_types_index_.fibernodedomcontainer.md#document_position_disconnected) +* [DOCUMENT_POSITION_FOLLOWING](_mocked_types_index_.fibernodedomcontainer.md#document_position_following) +* [DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC](_mocked_types_index_.fibernodedomcontainer.md#document_position_implementation_specific) +* [DOCUMENT_POSITION_PRECEDING](_mocked_types_index_.fibernodedomcontainer.md#document_position_preceding) +* [DOCUMENT_TYPE_NODE](_mocked_types_index_.fibernodedomcontainer.md#document_type_node) +* [ELEMENT_NODE](_mocked_types_index_.fibernodedomcontainer.md#element_node) +* [ENTITY_NODE](_mocked_types_index_.fibernodedomcontainer.md#entity_node) +* [ENTITY_REFERENCE_NODE](_mocked_types_index_.fibernodedomcontainer.md#entity_reference_node) +* [Element](_mocked_types_index_.fibernodedomcontainer.md#element) +* [NOTATION_NODE](_mocked_types_index_.fibernodedomcontainer.md#notation_node) +* [PROCESSING_INSTRUCTION_NODE](_mocked_types_index_.fibernodedomcontainer.md#processing_instruction_node) +* [TEXT_NODE](_mocked_types_index_.fibernodedomcontainer.md#text_node) +* [_reactRootContainer](_mocked_types_index_.fibernodedomcontainer.md#_reactrootcontainer) +* [assignedSlot](_mocked_types_index_.fibernodedomcontainer.md#assignedslot) +* [attributes](_mocked_types_index_.fibernodedomcontainer.md#attributes) +* [baseURI](_mocked_types_index_.fibernodedomcontainer.md#baseuri) +* [childElementCount](_mocked_types_index_.fibernodedomcontainer.md#childelementcount) +* [childNodes](_mocked_types_index_.fibernodedomcontainer.md#childnodes) +* [children](_mocked_types_index_.fibernodedomcontainer.md#children) +* [classList](_mocked_types_index_.fibernodedomcontainer.md#classlist) +* [className](_mocked_types_index_.fibernodedomcontainer.md#classname) +* [clientHeight](_mocked_types_index_.fibernodedomcontainer.md#clientheight) +* [clientLeft](_mocked_types_index_.fibernodedomcontainer.md#clientleft) +* [clientTop](_mocked_types_index_.fibernodedomcontainer.md#clienttop) +* [clientWidth](_mocked_types_index_.fibernodedomcontainer.md#clientwidth) +* [firstChild](_mocked_types_index_.fibernodedomcontainer.md#firstchild) +* [firstElementChild](_mocked_types_index_.fibernodedomcontainer.md#firstelementchild) +* [id](_mocked_types_index_.fibernodedomcontainer.md#id) +* [innerHTML](_mocked_types_index_.fibernodedomcontainer.md#innerhtml) +* [isConnected](_mocked_types_index_.fibernodedomcontainer.md#isconnected) +* [lastChild](_mocked_types_index_.fibernodedomcontainer.md#lastchild) +* [lastElementChild](_mocked_types_index_.fibernodedomcontainer.md#lastelementchild) +* [localName](_mocked_types_index_.fibernodedomcontainer.md#localname) +* [namespaceURI](_mocked_types_index_.fibernodedomcontainer.md#namespaceuri) +* [nextElementSibling](_mocked_types_index_.fibernodedomcontainer.md#nextelementsibling) +* [nextSibling](_mocked_types_index_.fibernodedomcontainer.md#nextsibling) +* [nodeName](_mocked_types_index_.fibernodedomcontainer.md#nodename) +* [nodeType](_mocked_types_index_.fibernodedomcontainer.md#nodetype) +* [nodeValue](_mocked_types_index_.fibernodedomcontainer.md#nodevalue) +* [onfullscreenchange](_mocked_types_index_.fibernodedomcontainer.md#onfullscreenchange) +* [onfullscreenerror](_mocked_types_index_.fibernodedomcontainer.md#onfullscreenerror) +* [outerHTML](_mocked_types_index_.fibernodedomcontainer.md#outerhtml) +* [ownerDocument](_mocked_types_index_.fibernodedomcontainer.md#ownerdocument) +* [parentElement](_mocked_types_index_.fibernodedomcontainer.md#parentelement) +* [parentNode](_mocked_types_index_.fibernodedomcontainer.md#parentnode) +* [prefix](_mocked_types_index_.fibernodedomcontainer.md#prefix) +* [previousElementSibling](_mocked_types_index_.fibernodedomcontainer.md#previouselementsibling) +* [previousSibling](_mocked_types_index_.fibernodedomcontainer.md#previoussibling) +* [scrollHeight](_mocked_types_index_.fibernodedomcontainer.md#scrollheight) +* [scrollLeft](_mocked_types_index_.fibernodedomcontainer.md#scrollleft) +* [scrollTop](_mocked_types_index_.fibernodedomcontainer.md#scrolltop) +* [scrollWidth](_mocked_types_index_.fibernodedomcontainer.md#scrollwidth) +* [shadowRoot](_mocked_types_index_.fibernodedomcontainer.md#shadowroot) +* [slot](_mocked_types_index_.fibernodedomcontainer.md#slot) +* [tagName](_mocked_types_index_.fibernodedomcontainer.md#tagname) +* [textContent](_mocked_types_index_.fibernodedomcontainer.md#textcontent) + +### Methods + +* [addEventListener](_mocked_types_index_.fibernodedomcontainer.md#addeventlistener) +* [after](_mocked_types_index_.fibernodedomcontainer.md#after) +* [animate](_mocked_types_index_.fibernodedomcontainer.md#animate) +* [append](_mocked_types_index_.fibernodedomcontainer.md#append) +* [appendChild](_mocked_types_index_.fibernodedomcontainer.md#appendchild) +* [attachShadow](_mocked_types_index_.fibernodedomcontainer.md#attachshadow) +* [before](_mocked_types_index_.fibernodedomcontainer.md#before) +* [cloneNode](_mocked_types_index_.fibernodedomcontainer.md#clonenode) +* [closest](_mocked_types_index_.fibernodedomcontainer.md#closest) +* [compareDocumentPosition](_mocked_types_index_.fibernodedomcontainer.md#comparedocumentposition) +* [contains](_mocked_types_index_.fibernodedomcontainer.md#contains) +* [dispatchEvent](_mocked_types_index_.fibernodedomcontainer.md#dispatchevent) +* [getAnimations](_mocked_types_index_.fibernodedomcontainer.md#getanimations) +* [getAttribute](_mocked_types_index_.fibernodedomcontainer.md#getattribute) +* [getAttributeNS](_mocked_types_index_.fibernodedomcontainer.md#getattributens) +* [getAttributeNames](_mocked_types_index_.fibernodedomcontainer.md#getattributenames) +* [getAttributeNode](_mocked_types_index_.fibernodedomcontainer.md#getattributenode) +* [getAttributeNodeNS](_mocked_types_index_.fibernodedomcontainer.md#getattributenodens) +* [getBoundingClientRect](_mocked_types_index_.fibernodedomcontainer.md#getboundingclientrect) +* [getClientRects](_mocked_types_index_.fibernodedomcontainer.md#getclientrects) +* [getElementsByClassName](_mocked_types_index_.fibernodedomcontainer.md#getelementsbyclassname) +* [getElementsByTagName](_mocked_types_index_.fibernodedomcontainer.md#getelementsbytagname) +* [getElementsByTagNameNS](_mocked_types_index_.fibernodedomcontainer.md#getelementsbytagnamens) +* [getRootNode](_mocked_types_index_.fibernodedomcontainer.md#getrootnode) +* [hasAttribute](_mocked_types_index_.fibernodedomcontainer.md#hasattribute) +* [hasAttributeNS](_mocked_types_index_.fibernodedomcontainer.md#hasattributens) +* [hasAttributes](_mocked_types_index_.fibernodedomcontainer.md#hasattributes) +* [hasChildNodes](_mocked_types_index_.fibernodedomcontainer.md#haschildnodes) +* [hasPointerCapture](_mocked_types_index_.fibernodedomcontainer.md#haspointercapture) +* [insertAdjacentElement](_mocked_types_index_.fibernodedomcontainer.md#insertadjacentelement) +* [insertAdjacentHTML](_mocked_types_index_.fibernodedomcontainer.md#insertadjacenthtml) +* [insertAdjacentText](_mocked_types_index_.fibernodedomcontainer.md#insertadjacenttext) +* [insertBefore](_mocked_types_index_.fibernodedomcontainer.md#insertbefore) +* [isDefaultNamespace](_mocked_types_index_.fibernodedomcontainer.md#isdefaultnamespace) +* [isEqualNode](_mocked_types_index_.fibernodedomcontainer.md#isequalnode) +* [isSameNode](_mocked_types_index_.fibernodedomcontainer.md#issamenode) +* [lookupNamespaceURI](_mocked_types_index_.fibernodedomcontainer.md#lookupnamespaceuri) +* [lookupPrefix](_mocked_types_index_.fibernodedomcontainer.md#lookupprefix) +* [matches](_mocked_types_index_.fibernodedomcontainer.md#matches) +* [msGetRegionContent](_mocked_types_index_.fibernodedomcontainer.md#msgetregioncontent) +* [normalize](_mocked_types_index_.fibernodedomcontainer.md#normalize) +* [prepend](_mocked_types_index_.fibernodedomcontainer.md#prepend) +* [querySelector](_mocked_types_index_.fibernodedomcontainer.md#queryselector) +* [querySelectorAll](_mocked_types_index_.fibernodedomcontainer.md#queryselectorall) +* [releasePointerCapture](_mocked_types_index_.fibernodedomcontainer.md#releasepointercapture) +* [remove](_mocked_types_index_.fibernodedomcontainer.md#remove) +* [removeAttribute](_mocked_types_index_.fibernodedomcontainer.md#removeattribute) +* [removeAttributeNS](_mocked_types_index_.fibernodedomcontainer.md#removeattributens) +* [removeAttributeNode](_mocked_types_index_.fibernodedomcontainer.md#removeattributenode) +* [removeChild](_mocked_types_index_.fibernodedomcontainer.md#removechild) +* [removeEventListener](_mocked_types_index_.fibernodedomcontainer.md#removeeventlistener) +* [replaceChild](_mocked_types_index_.fibernodedomcontainer.md#replacechild) +* [replaceWith](_mocked_types_index_.fibernodedomcontainer.md#replacewith) +* [requestFullscreen](_mocked_types_index_.fibernodedomcontainer.md#requestfullscreen) +* [requestPointerLock](_mocked_types_index_.fibernodedomcontainer.md#requestpointerlock) +* [scroll](_mocked_types_index_.fibernodedomcontainer.md#scroll) +* [scrollBy](_mocked_types_index_.fibernodedomcontainer.md#scrollby) +* [scrollIntoView](_mocked_types_index_.fibernodedomcontainer.md#scrollintoview) +* [scrollTo](_mocked_types_index_.fibernodedomcontainer.md#scrollto) +* [setAttribute](_mocked_types_index_.fibernodedomcontainer.md#setattribute) +* [setAttributeNS](_mocked_types_index_.fibernodedomcontainer.md#setattributens) +* [setAttributeNode](_mocked_types_index_.fibernodedomcontainer.md#setattributenode) +* [setAttributeNodeNS](_mocked_types_index_.fibernodedomcontainer.md#setattributenodens) +* [setPointerCapture](_mocked_types_index_.fibernodedomcontainer.md#setpointercapture) +* [toggleAttribute](_mocked_types_index_.fibernodedomcontainer.md#toggleattribute) +* [webkitMatchesSelector](_mocked_types_index_.fibernodedomcontainer.md#webkitmatchesselector) + +## Properties + +### ATTRIBUTE_NODE + +• **ATTRIBUTE_NODE**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10760 + +___ + +### CDATA_SECTION_NODE + +• **CDATA_SECTION_NODE**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10761 + +___ + +### COMMENT_NODE + +• **COMMENT_NODE**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10762 + +___ + +### DOCUMENT_FRAGMENT_NODE + +• **DOCUMENT_FRAGMENT_NODE**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10763 + +___ + +### DOCUMENT_NODE + +• **DOCUMENT_NODE**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10764 + +___ + +### DOCUMENT_POSITION_CONTAINED_BY + +• **DOCUMENT_POSITION_CONTAINED_BY**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10765 + +___ + +### DOCUMENT_POSITION_CONTAINS + +• **DOCUMENT_POSITION_CONTAINS**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10766 + +___ + +### DOCUMENT_POSITION_DISCONNECTED + +• **DOCUMENT_POSITION_DISCONNECTED**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10767 + +___ + +### DOCUMENT_POSITION_FOLLOWING + +• **DOCUMENT_POSITION_FOLLOWING**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10768 + +___ + +### DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC + +• **DOCUMENT_POSITION_IMPLEMENTATION_SPECIFIC**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10769 + +___ + +### DOCUMENT_POSITION_PRECEDING + +• **DOCUMENT_POSITION_PRECEDING**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10770 + +___ + +### DOCUMENT_TYPE_NODE + +• **DOCUMENT_TYPE_NODE**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10771 + +___ + +### ELEMENT_NODE + +• **ELEMENT_NODE**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10772 + +___ + +### ENTITY_NODE + +• **ENTITY_NODE**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10773 + +___ + +### ENTITY_REFERENCE_NODE + +• **ENTITY_REFERENCE_NODE**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10774 + +___ + +### Element + +• **Element**: *object* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5063 + +#### Type declaration: + +* **new __type**(): *`Element`* + +* **prototype**: *`Element`* + +___ + +### NOTATION_NODE + +• **NOTATION_NODE**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10775 + +___ + +### PROCESSING_INSTRUCTION_NODE + +• **PROCESSING_INSTRUCTION_NODE**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10776 + +___ + +### TEXT_NODE + +• **TEXT_NODE**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10777 + +___ + +### _reactRootContainer + +• **_reactRootContainer**: *object* + +*Defined in [mocked-types/index.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L4)* + +#### Type declaration: + +* **_internalRoot**(): *object* + + * **current**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* + +___ + +### assignedSlot + +• **assignedSlot**: *`HTMLSlotElement` | null* + +*Inherited from void* + +*Overrides void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4903 + +___ + +### attributes + +• **attributes**: *`NamedNodeMap`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4904 + +___ + +### baseURI + +• **baseURI**: *string* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10661 + +Returns node's node document's document base URL. + +___ + +### childElementCount + +• **childElementCount**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:11147 + +___ + +### childNodes + +• **childNodes**: *`NodeListOf`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10665 + +Returns the children. + +___ + +### children + +• **children**: *`HTMLCollection`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:11151 + +Returns the child elements. + +___ + +### classList + +• **classList**: *`DOMTokenList`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4909 + +Allows for manipulation of element's class content attribute as a +set of whitespace-separated tokens through a DOMTokenList object. + +___ + +### className + +• **className**: *string* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4914 + +Returns the value of element's class content attribute. Can be set +to change it. + +___ + +### clientHeight + +• **clientHeight**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4915 + +___ + +### clientLeft + +• **clientLeft**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4916 + +___ + +### clientTop + +• **clientTop**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4917 + +___ + +### clientWidth + +• **clientWidth**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4918 + +___ + +### firstChild + +• **firstChild**: *`ChildNode` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10669 + +Returns the first child. + +___ + +### firstElementChild + +• **firstElementChild**: *`Element` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:11155 + +Returns the first child that is an element, and null otherwise. + +___ + +### id + +• **id**: *string* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4923 + +Returns the value of element's id content attribute. Can be set to +change it. + +___ + +### innerHTML + +• **innerHTML**: *string* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:9483 + +___ + +### isConnected + +• **isConnected**: *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10673 + +Returns true if node is connected and false otherwise. + +___ + +### lastChild + +• **lastChild**: *`ChildNode` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10677 + +Returns the last child. + +___ + +### lastElementChild + +• **lastElementChild**: *`Element` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:11159 + +Returns the last child that is an element, and null otherwise. + +___ + +### localName + +• **localName**: *string* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4927 + +Returns the local name. + +___ + +### namespaceURI + +• **namespaceURI**: *string | null* + +*Inherited from void* + +*Overrides void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4931 + +Returns the namespace. + +___ + +### nextElementSibling + +• **nextElementSibling**: *`Element` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10885 + +Returns the first following sibling that +is an element, and null otherwise. + +___ + +### nextSibling + +• **nextSibling**: *`ChildNode` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10683 + +Returns the next sibling. + +___ + +### nodeName + +• **nodeName**: *string* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10706 + +Returns a string appropriate for the type of node, as +follows: +Element +Its HTML-uppercased qualified name. +Attr +Its qualified name. +Text +"#text". +CDATASection +"#cdata-section". +ProcessingInstruction +Its target. +Comment +"#comment". +Document +"#document". +DocumentType +Its name. +DocumentFragment +"#document-fragment". + +___ + +### nodeType + +• **nodeType**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10707 + +___ + +### nodeValue + +• **nodeValue**: *string | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10708 + +___ + +### onfullscreenchange + +• **onfullscreenchange**: *function | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4932 + +___ + +### onfullscreenerror + +• **onfullscreenerror**: *function | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4933 + +___ + +### outerHTML + +• **outerHTML**: *string* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4934 + +___ + +### ownerDocument + +• **ownerDocument**: *`Document` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10713 + +Returns the node document. +Returns null for documents. + +___ + +### parentElement + +• **parentElement**: *`HTMLElement` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10717 + +Returns the parent element. + +___ + +### parentNode + +• **parentNode**: *`Node` & `ParentNode` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10721 + +Returns the parent. + +___ + +### prefix + +• **prefix**: *string | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4938 + +Returns the namespace prefix. + +___ + +### previousElementSibling + +• **previousElementSibling**: *`Element` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10890 + +Returns the first preceding sibling that +is an element, and null otherwise. + +___ + +### previousSibling + +• **previousSibling**: *`Node` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10725 + +Returns the previous sibling. + +___ + +### scrollHeight + +• **scrollHeight**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4939 + +___ + +### scrollLeft + +• **scrollLeft**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4940 + +___ + +### scrollTop + +• **scrollTop**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4941 + +___ + +### scrollWidth + +• **scrollWidth**: *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4942 + +___ + +### shadowRoot + +• **shadowRoot**: *`ShadowRoot` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4946 + +Returns element's shadow root, if any, and if shadow root's mode is "open", and null otherwise. + +___ + +### slot + +• **slot**: *string* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4951 + +Returns the value of element's slot content attribute. Can be set to +change it. + +___ + +### tagName + +• **tagName**: *string* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4955 + +Returns the HTML-uppercased qualified name. + +___ + +### textContent + +• **textContent**: *string | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10726 + +## Methods + +### addEventListener + +▸ **addEventListener**<**K**>(`type`: `K`, `listener`: function, `options?`: boolean | `AddEventListenerOptions`): *void* + +*Inherited from void* + +*Overrides void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5057 + +**Type parameters:** + +▪ **K**: *keyof ElementEventMap* + +**Parameters:** + +▪ **type**: *`K`* + +▪ **listener**: *function* + +▸ (`this`: `Element`, `ev`: `ElementEventMap[K]`): *any* + +**Parameters:** + +Name | Type | +------ | ------ | +`this` | `Element` | +`ev` | `ElementEventMap[K]` | + +▪`Optional` **options**: *boolean | `AddEventListenerOptions`* + +**Returns:** *void* + +▸ **addEventListener**(`type`: string, `listener`: `EventListenerOrEventListenerObject`, `options?`: boolean | `AddEventListenerOptions`): *void* + +*Inherited from void* + +*Overrides void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5058 + +**Parameters:** + +Name | Type | +------ | ------ | +`type` | string | +`listener` | `EventListenerOrEventListenerObject` | +`options?` | boolean \| `AddEventListenerOptions` | + +**Returns:** *void* + +___ + +### after + +▸ **after**(...`nodes`: string | `Node`[]): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:3320 + +Inserts nodes just after node, while replacing strings in nodes with equivalent Text nodes. +Throws a "HierarchyRequestError" DOMException if the constraints of +the node tree are violated. + +**Parameters:** + +Name | Type | +------ | ------ | +`...nodes` | string \| `Node`[] | + +**Returns:** *void* + +___ + +### animate + +▸ **animate**(`keyframes`: `Keyframe`[] | `PropertyIndexedKeyframes` | null, `options?`: number | `KeyframeAnimationOptions`): *`Animation`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:1815 + +**Parameters:** + +Name | Type | +------ | ------ | +`keyframes` | `Keyframe`[] \| `PropertyIndexedKeyframes` \| null | +`options?` | number \| `KeyframeAnimationOptions` | + +**Returns:** *`Animation`* + +___ + +### append + +▸ **append**(...`nodes`: string | `Node`[]): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:11166 + +Inserts nodes after the last child of node, while replacing +strings in nodes with equivalent Text nodes. +Throws a "HierarchyRequestError" DOMException if the constraints of +the node tree are violated. + +**Parameters:** + +Name | Type | +------ | ------ | +`...nodes` | string \| `Node`[] | + +**Returns:** *void* + +___ + +### appendChild + +▸ **appendChild**<**T**>(`newChild`: `T`): *`T`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10727 + +**Type parameters:** + +▪ **T**: *`Node`* + +**Parameters:** + +Name | Type | +------ | ------ | +`newChild` | `T` | + +**Returns:** *`T`* + +___ + +### attachShadow + +▸ **attachShadow**(`init`: `ShadowRootInit`): *`ShadowRoot`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4959 + +Creates a shadow root for element and returns it. + +**Parameters:** + +Name | Type | +------ | ------ | +`init` | `ShadowRootInit` | + +**Returns:** *`ShadowRoot`* + +___ + +### before + +▸ **before**(...`nodes`: string | `Node`[]): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:3326 + +Inserts nodes just before node, while replacing strings in nodes with equivalent Text nodes. +Throws a "HierarchyRequestError" DOMException if the constraints of +the node tree are violated. + +**Parameters:** + +Name | Type | +------ | ------ | +`...nodes` | string \| `Node`[] | + +**Returns:** *void* + +___ + +### cloneNode + +▸ **cloneNode**(`deep?`: undefined | false | true): *`Node`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10731 + +Returns a copy of node. If deep is true, the copy also includes the node's descendants. + +**Parameters:** + +Name | Type | +------ | ------ | +`deep?` | undefined \| false \| true | + +**Returns:** *`Node`* + +___ + +### closest + +▸ **closest**<**K**>(`selector`: `K`): *`HTMLElementTagNameMap[K]` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4963 + +Returns the first (starting at element) inclusive ancestor that matches selectors, and null otherwise. + +**Type parameters:** + +▪ **K**: *keyof HTMLElementTagNameMap* + +**Parameters:** + +Name | Type | +------ | ------ | +`selector` | `K` | + +**Returns:** *`HTMLElementTagNameMap[K]` | null* + +▸ **closest**<**K**>(`selector`: `K`): *`SVGElementTagNameMap[K]` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4964 + +**Type parameters:** + +▪ **K**: *keyof SVGElementTagNameMap* + +**Parameters:** + +Name | Type | +------ | ------ | +`selector` | `K` | + +**Returns:** *`SVGElementTagNameMap[K]` | null* + +▸ **closest**(`selector`: string): *`Element` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4965 + +**Parameters:** + +Name | Type | +------ | ------ | +`selector` | string | + +**Returns:** *`Element` | null* + +___ + +### compareDocumentPosition + +▸ **compareDocumentPosition**(`other`: `Node`): *number* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10732 + +**Parameters:** + +Name | Type | +------ | ------ | +`other` | `Node` | + +**Returns:** *number* + +___ + +### contains + +▸ **contains**(`other`: `Node` | null): *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10736 + +Returns true if other is an inclusive descendant of node, and false otherwise. + +**Parameters:** + +Name | Type | +------ | ------ | +`other` | `Node` \| null | + +**Returns:** *boolean* + +___ + +### dispatchEvent + +▸ **dispatchEvent**(`event`: `Event`): *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5226 + +Dispatches a synthetic event event to target and returns true +if either event's cancelable attribute value is false or its preventDefault() method was not invoked, and false otherwise. + +**Parameters:** + +Name | Type | +------ | ------ | +`event` | `Event` | + +**Returns:** *boolean* + +___ + +### getAnimations + +▸ **getAnimations**(): *`Animation`[]* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:1816 + +**Returns:** *`Animation`[]* + +___ + +### getAttribute + +▸ **getAttribute**(`qualifiedName`: string): *string | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4969 + +Returns element's first attribute whose qualified name is qualifiedName, and null if there is no such attribute otherwise. + +**Parameters:** + +Name | Type | +------ | ------ | +`qualifiedName` | string | + +**Returns:** *string | null* + +___ + +### getAttributeNS + +▸ **getAttributeNS**(`namespace`: string | null, `localName`: string): *string | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4974 + +Returns element's attribute whose namespace is namespace and local name is localName, and null if there is +no such attribute otherwise. + +**Parameters:** + +Name | Type | +------ | ------ | +`namespace` | string \| null | +`localName` | string | + +**Returns:** *string | null* + +___ + +### getAttributeNames + +▸ **getAttributeNames**(): *string[]* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4979 + +Returns the qualified names of all element's attributes. +Can contain duplicates. + +**Returns:** *string[]* + +___ + +### getAttributeNode + +▸ **getAttributeNode**(`name`: string): *`Attr` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4980 + +**Parameters:** + +Name | Type | +------ | ------ | +`name` | string | + +**Returns:** *`Attr` | null* + +___ + +### getAttributeNodeNS + +▸ **getAttributeNodeNS**(`namespaceURI`: string, `localName`: string): *`Attr` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4981 + +**Parameters:** + +Name | Type | +------ | ------ | +`namespaceURI` | string | +`localName` | string | + +**Returns:** *`Attr` | null* + +___ + +### getBoundingClientRect + +▸ **getBoundingClientRect**(): *`ClientRect` | `DOMRect`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4982 + +**Returns:** *`ClientRect` | `DOMRect`* + +___ + +### getClientRects + +▸ **getClientRects**(): *`ClientRectList` | `DOMRectList`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4983 + +**Returns:** *`ClientRectList` | `DOMRectList`* + +___ + +### getElementsByClassName + +▸ **getElementsByClassName**(`classNames`: string): *`HTMLCollectionOf`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4984 + +**Parameters:** + +Name | Type | +------ | ------ | +`classNames` | string | + +**Returns:** *`HTMLCollectionOf`* + +___ + +### getElementsByTagName + +▸ **getElementsByTagName**<**K**>(`qualifiedName`: `K`): *`HTMLCollectionOf`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4985 + +**Type parameters:** + +▪ **K**: *keyof HTMLElementTagNameMap* + +**Parameters:** + +Name | Type | +------ | ------ | +`qualifiedName` | `K` | + +**Returns:** *`HTMLCollectionOf`* + +▸ **getElementsByTagName**<**K**>(`qualifiedName`: `K`): *`HTMLCollectionOf`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4986 + +**Type parameters:** + +▪ **K**: *keyof SVGElementTagNameMap* + +**Parameters:** + +Name | Type | +------ | ------ | +`qualifiedName` | `K` | + +**Returns:** *`HTMLCollectionOf`* + +▸ **getElementsByTagName**(`qualifiedName`: string): *`HTMLCollectionOf`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4987 + +**Parameters:** + +Name | Type | +------ | ------ | +`qualifiedName` | string | + +**Returns:** *`HTMLCollectionOf`* + +___ + +### getElementsByTagNameNS + +▸ **getElementsByTagNameNS**(`namespaceURI`: "http://www.w3.org/1999/xhtml", `localName`: string): *`HTMLCollectionOf`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4988 + +**Parameters:** + +Name | Type | +------ | ------ | +`namespaceURI` | "http://www.w3.org/1999/xhtml" | +`localName` | string | + +**Returns:** *`HTMLCollectionOf`* + +▸ **getElementsByTagNameNS**(`namespaceURI`: "http://www.w3.org/2000/svg", `localName`: string): *`HTMLCollectionOf`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4989 + +**Parameters:** + +Name | Type | +------ | ------ | +`namespaceURI` | "http://www.w3.org/2000/svg" | +`localName` | string | + +**Returns:** *`HTMLCollectionOf`* + +▸ **getElementsByTagNameNS**(`namespaceURI`: string, `localName`: string): *`HTMLCollectionOf`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4990 + +**Parameters:** + +Name | Type | +------ | ------ | +`namespaceURI` | string | +`localName` | string | + +**Returns:** *`HTMLCollectionOf`* + +___ + +### getRootNode + +▸ **getRootNode**(`options?`: `GetRootNodeOptions`): *`Node`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10740 + +Returns node's shadow-including root. + +**Parameters:** + +Name | Type | +------ | ------ | +`options?` | `GetRootNodeOptions` | + +**Returns:** *`Node`* + +___ + +### hasAttribute + +▸ **hasAttribute**(`qualifiedName`: string): *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4994 + +Returns true if element has an attribute whose qualified name is qualifiedName, and false otherwise. + +**Parameters:** + +Name | Type | +------ | ------ | +`qualifiedName` | string | + +**Returns:** *boolean* + +___ + +### hasAttributeNS + +▸ **hasAttributeNS**(`namespace`: string | null, `localName`: string): *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:4998 + +Returns true if element has an attribute whose namespace is namespace and local name is localName. + +**Parameters:** + +Name | Type | +------ | ------ | +`namespace` | string \| null | +`localName` | string | + +**Returns:** *boolean* + +___ + +### hasAttributes + +▸ **hasAttributes**(): *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5002 + +Returns true if element has attributes, and false otherwise. + +**Returns:** *boolean* + +___ + +### hasChildNodes + +▸ **hasChildNodes**(): *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10744 + +Returns whether node has children. + +**Returns:** *boolean* + +___ + +### hasPointerCapture + +▸ **hasPointerCapture**(`pointerId`: number): *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5003 + +**Parameters:** + +Name | Type | +------ | ------ | +`pointerId` | number | + +**Returns:** *boolean* + +___ + +### insertAdjacentElement + +▸ **insertAdjacentElement**(`position`: `InsertPosition`, `insertedElement`: `Element`): *`Element` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5004 + +**Parameters:** + +Name | Type | +------ | ------ | +`position` | `InsertPosition` | +`insertedElement` | `Element` | + +**Returns:** *`Element` | null* + +___ + +### insertAdjacentHTML + +▸ **insertAdjacentHTML**(`where`: `InsertPosition`, `html`: string): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5005 + +**Parameters:** + +Name | Type | +------ | ------ | +`where` | `InsertPosition` | +`html` | string | + +**Returns:** *void* + +___ + +### insertAdjacentText + +▸ **insertAdjacentText**(`where`: `InsertPosition`, `text`: string): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5006 + +**Parameters:** + +Name | Type | +------ | ------ | +`where` | `InsertPosition` | +`text` | string | + +**Returns:** *void* + +___ + +### insertBefore + +▸ **insertBefore**<**T**>(`newChild`: `T`, `refChild`: `Node` | null): *`T`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10745 + +**Type parameters:** + +▪ **T**: *`Node`* + +**Parameters:** + +Name | Type | +------ | ------ | +`newChild` | `T` | +`refChild` | `Node` \| null | + +**Returns:** *`T`* + +___ + +### isDefaultNamespace + +▸ **isDefaultNamespace**(`namespace`: string | null): *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10746 + +**Parameters:** + +Name | Type | +------ | ------ | +`namespace` | string \| null | + +**Returns:** *boolean* + +___ + +### isEqualNode + +▸ **isEqualNode**(`otherNode`: `Node` | null): *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10750 + +Returns whether node and otherNode have the same properties. + +**Parameters:** + +Name | Type | +------ | ------ | +`otherNode` | `Node` \| null | + +**Returns:** *boolean* + +___ + +### isSameNode + +▸ **isSameNode**(`otherNode`: `Node` | null): *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10751 + +**Parameters:** + +Name | Type | +------ | ------ | +`otherNode` | `Node` \| null | + +**Returns:** *boolean* + +___ + +### lookupNamespaceURI + +▸ **lookupNamespaceURI**(`prefix`: string | null): *string | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10752 + +**Parameters:** + +Name | Type | +------ | ------ | +`prefix` | string \| null | + +**Returns:** *string | null* + +___ + +### lookupPrefix + +▸ **lookupPrefix**(`namespace`: string | null): *string | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10753 + +**Parameters:** + +Name | Type | +------ | ------ | +`namespace` | string \| null | + +**Returns:** *string | null* + +___ + +### matches + +▸ **matches**(`selectors`: string): *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5010 + +Returns true if matching selectors against element's root yields element, and false otherwise. + +**Parameters:** + +Name | Type | +------ | ------ | +`selectors` | string | + +**Returns:** *boolean* + +___ + +### msGetRegionContent + +▸ **msGetRegionContent**(): *any* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5011 + +**Returns:** *any* + +___ + +### normalize + +▸ **normalize**(): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10757 + +Removes empty exclusive Text nodes and concatenates the data of remaining contiguous exclusive Text nodes into the first of their nodes. + +**Returns:** *void* + +___ + +### prepend + +▸ **prepend**(...`nodes`: string | `Node`[]): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:11173 + +Inserts nodes before the first child of node, while +replacing strings in nodes with equivalent Text nodes. +Throws a "HierarchyRequestError" DOMException if the constraints of +the node tree are violated. + +**Parameters:** + +Name | Type | +------ | ------ | +`...nodes` | string \| `Node`[] | + +**Returns:** *void* + +___ + +### querySelector + +▸ **querySelector**<**K**>(`selectors`: `K`): *`HTMLElementTagNameMap[K]` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:11178 + +Returns the first element that is a descendant of node that +matches selectors. + +**Type parameters:** + +▪ **K**: *keyof HTMLElementTagNameMap* + +**Parameters:** + +Name | Type | +------ | ------ | +`selectors` | `K` | + +**Returns:** *`HTMLElementTagNameMap[K]` | null* + +▸ **querySelector**<**K**>(`selectors`: `K`): *`SVGElementTagNameMap[K]` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:11179 + +**Type parameters:** + +▪ **K**: *keyof SVGElementTagNameMap* + +**Parameters:** + +Name | Type | +------ | ------ | +`selectors` | `K` | + +**Returns:** *`SVGElementTagNameMap[K]` | null* + +▸ **querySelector**<**E**>(`selectors`: string): *`E` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:11180 + +**Type parameters:** + +▪ **E**: *`Element`* + +**Parameters:** + +Name | Type | +------ | ------ | +`selectors` | string | + +**Returns:** *`E` | null* + +___ + +### querySelectorAll + +▸ **querySelectorAll**<**K**>(`selectors`: `K`): *`NodeListOf`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:11185 + +Returns all element descendants of node that +match selectors. + +**Type parameters:** + +▪ **K**: *keyof HTMLElementTagNameMap* + +**Parameters:** + +Name | Type | +------ | ------ | +`selectors` | `K` | + +**Returns:** *`NodeListOf`* + +▸ **querySelectorAll**<**K**>(`selectors`: `K`): *`NodeListOf`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:11186 + +**Type parameters:** + +▪ **K**: *keyof SVGElementTagNameMap* + +**Parameters:** + +Name | Type | +------ | ------ | +`selectors` | `K` | + +**Returns:** *`NodeListOf`* + +▸ **querySelectorAll**<**E**>(`selectors`: string): *`NodeListOf`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:11187 + +**Type parameters:** + +▪ **E**: *`Element`* + +**Parameters:** + +Name | Type | +------ | ------ | +`selectors` | string | + +**Returns:** *`NodeListOf`* + +___ + +### releasePointerCapture + +▸ **releasePointerCapture**(`pointerId`: number): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5012 + +**Parameters:** + +Name | Type | +------ | ------ | +`pointerId` | number | + +**Returns:** *void* + +___ + +### remove + +▸ **remove**(): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:3330 + +Removes node. + +**Returns:** *void* + +___ + +### removeAttribute + +▸ **removeAttribute**(`qualifiedName`: string): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5016 + +Removes element's first attribute whose qualified name is qualifiedName. + +**Parameters:** + +Name | Type | +------ | ------ | +`qualifiedName` | string | + +**Returns:** *void* + +___ + +### removeAttributeNS + +▸ **removeAttributeNS**(`namespace`: string | null, `localName`: string): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5020 + +Removes element's attribute whose namespace is namespace and local name is localName. + +**Parameters:** + +Name | Type | +------ | ------ | +`namespace` | string \| null | +`localName` | string | + +**Returns:** *void* + +___ + +### removeAttributeNode + +▸ **removeAttributeNode**(`attr`: `Attr`): *`Attr`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5021 + +**Parameters:** + +Name | Type | +------ | ------ | +`attr` | `Attr` | + +**Returns:** *`Attr`* + +___ + +### removeChild + +▸ **removeChild**<**T**>(`oldChild`: `T`): *`T`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10758 + +**Type parameters:** + +▪ **T**: *`Node`* + +**Parameters:** + +Name | Type | +------ | ------ | +`oldChild` | `T` | + +**Returns:** *`T`* + +___ + +### removeEventListener + +▸ **removeEventListener**<**K**>(`type`: `K`, `listener`: function, `options?`: boolean | `EventListenerOptions`): *void* + +*Inherited from void* + +*Overrides void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5059 + +**Type parameters:** + +▪ **K**: *keyof ElementEventMap* + +**Parameters:** + +▪ **type**: *`K`* + +▪ **listener**: *function* + +▸ (`this`: `Element`, `ev`: `ElementEventMap[K]`): *any* + +**Parameters:** + +Name | Type | +------ | ------ | +`this` | `Element` | +`ev` | `ElementEventMap[K]` | + +▪`Optional` **options**: *boolean | `EventListenerOptions`* + +**Returns:** *void* + +▸ **removeEventListener**(`type`: string, `listener`: `EventListenerOrEventListenerObject`, `options?`: boolean | `EventListenerOptions`): *void* + +*Inherited from void* + +*Overrides void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5060 + +**Parameters:** + +Name | Type | +------ | ------ | +`type` | string | +`listener` | `EventListenerOrEventListenerObject` | +`options?` | boolean \| `EventListenerOptions` | + +**Returns:** *void* + +___ + +### replaceChild + +▸ **replaceChild**<**T**>(`newChild`: `Node`, `oldChild`: `T`): *`T`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:10759 + +**Type parameters:** + +▪ **T**: *`Node`* + +**Parameters:** + +Name | Type | +------ | ------ | +`newChild` | `Node` | +`oldChild` | `T` | + +**Returns:** *`T`* + +___ + +### replaceWith + +▸ **replaceWith**(...`nodes`: string | `Node`[]): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:3336 + +Replaces node with nodes, while replacing strings in nodes with equivalent Text nodes. +Throws a "HierarchyRequestError" DOMException if the constraints of +the node tree are violated. + +**Parameters:** + +Name | Type | +------ | ------ | +`...nodes` | string \| `Node`[] | + +**Returns:** *void* + +___ + +### requestFullscreen + +▸ **requestFullscreen**(`options?`: `FullscreenOptions`): *`Promise`* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5030 + +Displays element fullscreen and resolves promise when done. +When supplied, options's navigationUI member indicates whether showing +navigation UI while in fullscreen is preferred or not. If set to "show", navigation +simplicity is preferred over screen space, and if set to "hide", more screen space +is preferred. User agents are always free to honor user preference over the application's. The +default value "auto" indicates no application preference. + +**Parameters:** + +Name | Type | +------ | ------ | +`options?` | `FullscreenOptions` | + +**Returns:** *`Promise`* + +___ + +### requestPointerLock + +▸ **requestPointerLock**(): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5031 + +**Returns:** *void* + +___ + +### scroll + +▸ **scroll**(`options?`: `ScrollToOptions`): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5032 + +**Parameters:** + +Name | Type | +------ | ------ | +`options?` | `ScrollToOptions` | + +**Returns:** *void* + +▸ **scroll**(`x`: number, `y`: number): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5033 + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### scrollBy + +▸ **scrollBy**(`options?`: `ScrollToOptions`): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5034 + +**Parameters:** + +Name | Type | +------ | ------ | +`options?` | `ScrollToOptions` | + +**Returns:** *void* + +▸ **scrollBy**(`x`: number, `y`: number): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5035 + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### scrollIntoView + +▸ **scrollIntoView**(`arg?`: boolean | `ScrollIntoViewOptions`): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5036 + +**Parameters:** + +Name | Type | +------ | ------ | +`arg?` | boolean \| `ScrollIntoViewOptions` | + +**Returns:** *void* + +___ + +### scrollTo + +▸ **scrollTo**(`options?`: `ScrollToOptions`): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5037 + +**Parameters:** + +Name | Type | +------ | ------ | +`options?` | `ScrollToOptions` | + +**Returns:** *void* + +▸ **scrollTo**(`x`: number, `y`: number): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5038 + +**Parameters:** + +Name | Type | +------ | ------ | +`x` | number | +`y` | number | + +**Returns:** *void* + +___ + +### setAttribute + +▸ **setAttribute**(`qualifiedName`: string, `value`: string): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5042 + +Sets the value of element's first attribute whose qualified name is qualifiedName to value. + +**Parameters:** + +Name | Type | +------ | ------ | +`qualifiedName` | string | +`value` | string | + +**Returns:** *void* + +___ + +### setAttributeNS + +▸ **setAttributeNS**(`namespace`: string | null, `qualifiedName`: string, `value`: string): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5046 + +Sets the value of element's attribute whose namespace is namespace and local name is localName to value. + +**Parameters:** + +Name | Type | +------ | ------ | +`namespace` | string \| null | +`qualifiedName` | string | +`value` | string | + +**Returns:** *void* + +___ + +### setAttributeNode + +▸ **setAttributeNode**(`attr`: `Attr`): *`Attr` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5047 + +**Parameters:** + +Name | Type | +------ | ------ | +`attr` | `Attr` | + +**Returns:** *`Attr` | null* + +___ + +### setAttributeNodeNS + +▸ **setAttributeNodeNS**(`attr`: `Attr`): *`Attr` | null* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5048 + +**Parameters:** + +Name | Type | +------ | ------ | +`attr` | `Attr` | + +**Returns:** *`Attr` | null* + +___ + +### setPointerCapture + +▸ **setPointerCapture**(`pointerId`: number): *void* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5049 + +**Parameters:** + +Name | Type | +------ | ------ | +`pointerId` | number | + +**Returns:** *void* + +___ + +### toggleAttribute + +▸ **toggleAttribute**(`qualifiedName`: string, `force?`: undefined | false | true): *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5055 + +If force is not given, "toggles" qualifiedName, removing it if it is +present and adding it if it is not present. If force is true, adds qualifiedName. If force is false, removes qualifiedName. +Returns true if qualifiedName is now present, and false otherwise. + +**Parameters:** + +Name | Type | +------ | ------ | +`qualifiedName` | string | +`force?` | undefined \| false \| true | + +**Returns:** *boolean* + +___ + +### webkitMatchesSelector + +▸ **webkitMatchesSelector**(`selectors`: string): *boolean* + +*Inherited from void* + +Defined in /Users/abhas.b/Documents/Code/Personal/react-fiber-traverse/node_modules/typescript/lib/lib.dom.d.ts:5056 + +**Parameters:** + +Name | Type | +------ | ------ | +`selectors` | string | + +**Returns:** *boolean* \ No newline at end of file diff --git a/docs/interfaces/_mocked_types_index_.fibernodeforcomponentclass.md b/docs/interfaces/_mocked_types_index_.fibernodeforcomponentclass.md index bb9d50a..979ed48 100644 --- a/docs/interfaces/_mocked_types_index_.fibernodeforcomponentclass.md +++ b/docs/interfaces/_mocked_types_index_.fibernodeforcomponentclass.md @@ -24,7 +24,7 @@ • **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:20](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L20)* +*Defined in [mocked-types/index.ts:28](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L28)* ___ @@ -32,7 +32,7 @@ ___ • **elementType**: *`ComponentClass`* -*Defined in [mocked-types/index.ts:23](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L23)* +*Defined in [mocked-types/index.ts:31](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L31)* ___ @@ -40,7 +40,7 @@ ___ • **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L21)* +*Defined in [mocked-types/index.ts:29](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L29)* ___ @@ -48,7 +48,7 @@ ___ • **stateNode**: *`Component`* -*Defined in [mocked-types/index.ts:26](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L26)* +*Defined in [mocked-types/index.ts:34](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L34)* ___ @@ -56,4 +56,4 @@ ___ • **type**: *`ComponentClass`* -*Defined in [mocked-types/index.ts:24](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L24)* \ No newline at end of file +*Defined in [mocked-types/index.ts:32](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L32)* \ No newline at end of file diff --git a/docs/interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md b/docs/interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md index e881ea2..915b218 100644 --- a/docs/interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md +++ b/docs/interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md @@ -24,7 +24,7 @@ • **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:10](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L10)* +*Defined in [mocked-types/index.ts:18](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L18)* ___ @@ -32,7 +32,7 @@ ___ • **elementType**: *`FunctionComponent`* -*Defined in [mocked-types/index.ts:13](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L13)* +*Defined in [mocked-types/index.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L21)* ___ @@ -40,7 +40,7 @@ ___ • **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:11](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L11)* +*Defined in [mocked-types/index.ts:19](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L19)* ___ @@ -48,7 +48,7 @@ ___ • **stateNode**: *null* -*Defined in [mocked-types/index.ts:16](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L16)* +*Defined in [mocked-types/index.ts:24](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L24)* ___ @@ -56,4 +56,4 @@ ___ • **type**: *`FunctionComponent`* -*Defined in [mocked-types/index.ts:14](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L14)* \ No newline at end of file +*Defined in [mocked-types/index.ts:22](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L22)* \ No newline at end of file diff --git a/docs/interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md b/docs/interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md index 4b3c436..7507a2e 100644 --- a/docs/interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md +++ b/docs/interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md @@ -24,9 +24,9 @@ • **child**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:30](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L30)* +*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:40](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L40)* +*Defined in [mocked-types/index.ts:48](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L48)* ___ @@ -34,9 +34,9 @@ ___ • **elementType**: *keyof IntrinsicElements* -*Defined in [mocked-types/index.ts:33](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L33)* +*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:43](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L43)* +*Defined in [mocked-types/index.ts:51](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L51)* ___ @@ -44,9 +44,9 @@ ___ • **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:31](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L31)* +*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:41](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L41)* +*Defined in [mocked-types/index.ts:49](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L49)* ___ @@ -54,9 +54,9 @@ ___ • **stateNode**: *`HTMLElement`* -*Defined in [mocked-types/index.ts:36](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L36)* +*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:46](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L46)* +*Defined in [mocked-types/index.ts:54](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L54)* ___ @@ -64,6 +64,6 @@ ___ • **type**: *keyof IntrinsicElements* -*Defined in [mocked-types/index.ts:34](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L34)* +*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:44](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L44)* \ No newline at end of file +*Defined in [mocked-types/index.ts:52](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L52)* \ No newline at end of file diff --git a/docs/interfaces/_mocked_types_index_.fibernodefortextnode.md b/docs/interfaces/_mocked_types_index_.fibernodefortextnode.md index b64a358..d78df4d 100644 --- a/docs/interfaces/_mocked_types_index_.fibernodefortextnode.md +++ b/docs/interfaces/_mocked_types_index_.fibernodefortextnode.md @@ -24,7 +24,7 @@ • **child**: *null* -*Defined in [mocked-types/index.ts:50](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L50)* +*Defined in [mocked-types/index.ts:58](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L58)* ___ @@ -32,7 +32,7 @@ ___ • **elementType**: *null* -*Defined in [mocked-types/index.ts:53](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L53)* +*Defined in [mocked-types/index.ts:61](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L61)* ___ @@ -40,7 +40,7 @@ ___ • **sibling**: *[FiberNode](../modules/_mocked_types_index_.md#fibernode) | null* -*Defined in [mocked-types/index.ts:51](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L51)* +*Defined in [mocked-types/index.ts:59](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L59)* ___ @@ -48,7 +48,7 @@ ___ • **stateNode**: *`Text`* -*Defined in [mocked-types/index.ts:56](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L56)* +*Defined in [mocked-types/index.ts:64](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L64)* ___ @@ -56,4 +56,4 @@ ___ • **type**: *null* -*Defined in [mocked-types/index.ts:54](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L54)* \ No newline at end of file +*Defined in [mocked-types/index.ts:62](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L62)* \ No newline at end of file diff --git a/docs/modules/_findnode_.md b/docs/modules/_findnode_.md index 5fe172b..48b2dfb 100644 --- a/docs/modules/_findnode_.md +++ b/docs/modules/_findnode_.md @@ -18,7 +18,7 @@ ▸ **findNodeByComponent**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedClassOrFunction`: `React.ComponentType`): *[FiberNode](_mocked_types_index_.md#fibernode) | null* -*Defined in [findNode.ts:32](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/findNode.ts#L32)* +*Defined in [findNode.ts:32](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/findNode.ts#L32)* **Parameters:** @@ -35,7 +35,7 @@ ___ ▸ **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/c9d7fd7/src/findNode.ts#L4)* +*Defined in [findNode.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/findNode.ts#L4)* **Parameters:** @@ -52,7 +52,7 @@ ___ ▸ **findNodeByComponentRef**(`node`: [FiberNode](_mocked_types_index_.md#fibernode) | null, `expectedClassInstance`: `Component`): *[FiberNode](_mocked_types_index_.md#fibernode) | null* -*Defined in [findNode.ts:63](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/findNode.ts#L63)* +*Defined in [findNode.ts:63](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/findNode.ts#L63)* **Parameters:** diff --git a/docs/modules/_mocked_types_index_.md b/docs/modules/_mocked_types_index_.md index 2a1be8d..a2fee36 100644 --- a/docs/modules/_mocked_types_index_.md +++ b/docs/modules/_mocked_types_index_.md @@ -8,6 +8,7 @@ ### Interfaces +* [FiberNodeDOMContainer](../interfaces/_mocked_types_index_.fibernodedomcontainer.md) * [FiberNodeForComponentClass](../interfaces/_mocked_types_index_.fibernodeforcomponentclass.md) * [FiberNodeForFunctionComponent](../interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md) * [FiberNodeForInstrinsicElement](../interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md) @@ -24,7 +25,7 @@ Ƭ **FiberNode**: *[FiberNodeForComponentClass](../interfaces/_mocked_types_index_.fibernodeforcomponentclass.md) | [FiberNodeForFunctionComponent](../interfaces/_mocked_types_index_.fibernodeforfunctioncomponent.md) | [FiberNodeForInstrinsicElement](../interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md) | [FiberNodeForTextNode](../interfaces/_mocked_types_index_.fibernodefortextnode.md)* -*Defined in [mocked-types/index.ts:3](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L3)* +*Defined in [mocked-types/index.ts:11](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L11)* ___ @@ -32,4 +33,4 @@ ___ Ƭ **FiberNodeisHTMLLike**: *[FiberNodeForInstrinsicElement](../interfaces/_mocked_types_index_.fibernodeforinstrinsicelement.md) | [FiberNodeForTextNode](../interfaces/_mocked_types_index_.fibernodefortextnode.md)* -*Defined in [mocked-types/index.ts:59](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/mocked-types/index.ts#L59)* \ No newline at end of file +*Defined in [mocked-types/index.ts:67](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/mocked-types/index.ts#L67)* \ No newline at end of file diff --git a/docs/modules/_traverse_.md b/docs/modules/_traverse_.md index 32c0c86..bad4902 100644 --- a/docs/modules/_traverse_.md +++ b/docs/modules/_traverse_.md @@ -17,7 +17,7 @@ ▸ **traverse**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `fn`: function): *void* -*Defined in [traverse.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/traverse.ts#L4)* +*Defined in [traverse.ts:4](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/traverse.ts#L4)* **Parameters:** @@ -41,7 +41,7 @@ ___ ▸ **traverseGenerator**(`node`: [FiberNode](_mocked_types_index_.md#fibernode), `__namedParameters`: object): *`IterableIterator`* -*Defined in [traverse.ts:15](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/traverse.ts#L15)* +*Defined in [traverse.ts:15](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/traverse.ts#L15)* **Parameters:** diff --git a/docs/modules/_utils_.md b/docs/modules/_utils_.md index ce5e4d1..3df8475 100644 --- a/docs/modules/_utils_.md +++ b/docs/modules/_utils_.md @@ -8,6 +8,8 @@ ### Functions +* [doesElementContainRootFiberNode](_utils_.md#doeselementcontainrootfibernode) +* [getRootFiberNodeFromDOM](_utils_.md#getrootfibernodefromdom) * [isConstructorComponentClass](_utils_.md#isconstructorcomponentclass) * [isConstructorFunctionComponent](_utils_.md#isconstructorfunctioncomponent) * [isConstructorHtmlLike](_utils_.md#isconstructorhtmllike) @@ -18,17 +20,52 @@ ## Functions -### isConstructorComponentClass +### doesElementContainRootFiberNode -▸ **isConstructorComponentClass**(`ctr`: `React.ElementType`): *boolean* +▸ **doesElementContainRootFiberNode**(`element`: `Element`): *boolean* -*Defined in [utils.ts:40](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L40)* +*Defined in [utils.ts:65](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L65)* **Parameters:** Name | Type | ------ | ------ | -`ctr` | `React.ElementType` | +`element` | `Element` | + +**Returns:** *boolean* + +___ + +### getRootFiberNodeFromDOM + +▸ **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)* + +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](../interfaces/_mocked_types_index_.fibernodedomcontainer.md#element) | Starting DOM element to seach from. If not found, it checks inside its child nodes. Defaults to document.body | + +**Returns:** *[FiberNode](_mocked_types_index_.md#fibernode) | null* + +___ + +### isConstructorComponentClass + +▸ **isConstructorComponentClass**(`ctr`: `React.ElementType` | null): *boolean* + +*Defined in [utils.ts:42](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L42)* + +**Parameters:** + +Name | Type | +------ | ------ | +`ctr` | `React.ElementType` \| null | **Returns:** *boolean* @@ -36,15 +73,15 @@ ___ ### isConstructorFunctionComponent -▸ **isConstructorFunctionComponent**(`ctr`: `React.ElementType`): *boolean* +▸ **isConstructorFunctionComponent**(`ctr`: `React.ElementType` | null): *boolean* -*Defined in [utils.ts:57](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L57)* +*Defined in [utils.ts:59](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L59)* **Parameters:** Name | Type | ------ | ------ | -`ctr` | `React.ElementType` | +`ctr` | `React.ElementType` \| null | **Returns:** *boolean* @@ -52,15 +89,15 @@ ___ ### isConstructorHtmlLike -▸ **isConstructorHtmlLike**(`ctr`: `React.ElementType`): *boolean* +▸ **isConstructorHtmlLike**(`ctr`: `React.ElementType` | null): *boolean* -*Defined in [utils.ts:31](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L31)* +*Defined in [utils.ts:33](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L33)* **Parameters:** Name | Type | ------ | ------ | -`ctr` | `React.ElementType` | +`ctr` | `React.ElementType` \| null | **Returns:** *boolean* @@ -70,7 +107,7 @@ ___ ▸ **isNodeComponentClass**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean* -*Defined in [utils.ts:25](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L25)* +*Defined in [utils.ts:27](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L27)* **Parameters:** @@ -86,7 +123,7 @@ ___ ▸ **isNodeFunctionComponent**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean* -*Defined in [utils.ts:19](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L19)* +*Defined in [utils.ts:21](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L21)* **Parameters:** @@ -102,7 +139,7 @@ ___ ▸ **isNodeHtmlLike**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean* -*Defined in [utils.ts:9](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L9)* +*Defined in [utils.ts:11](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L11)* **Parameters:** @@ -118,7 +155,7 @@ ___ ▸ **isNodeNotHtmlLike**(`node`: [FiberNode](_mocked_types_index_.md#fibernode)): *boolean* -*Defined in [utils.ts:13](https://github.com/bendtherules/react-fiber-traverse/blob/c9d7fd7/src/utils.ts#L13)* +*Defined in [utils.ts:15](https://github.com/bendtherules/react-fiber-traverse/blob/18ea2e7/src/utils.ts#L15)* **Parameters:** diff --git a/package-lock.json b/package-lock.json index 7441931..b40358e 100644 --- a/package-lock.json +++ b/package-lock.json @@ -1,6 +1,6 @@ { "name": "react-fiber-traverse", - "version": "0.0.6", + "version": "0.0.7", "lockfileVersion": 1, "requires": true, "dependencies": { diff --git a/package.json b/package.json index d2fed5f..81edaee 100644 --- a/package.json +++ b/package.json @@ -1,6 +1,6 @@ { "name": "react-fiber-traverse", - "version": "0.0.6", + "version": "0.0.7", "description": "Traverse and other utils on top of React fiber tree", "main": "dist/index.js", "module": "dist/react-fiber-traverse.esm.js", @@ -38,7 +38,7 @@ "test:umd": "jest --config ./scripts/jest/config.umd.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", - "version": "run-s test authors && git add ." + "version": "run-s test authors docs && git add ." }, "husky": { "hooks": {