Skip to content

Commit

Permalink
Update Docs for .getNode and .getNodes #743
Browse files Browse the repository at this point in the history
  • Loading branch information
blackpost38 authored and ljharb committed Dec 23, 2016
1 parent 010e9f0 commit d42527e
Show file tree
Hide file tree
Showing 6 changed files with 157 additions and 0 deletions.
34 changes: 34 additions & 0 deletions docs/api/ReactWrapper/getNode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# `.getNode() => ReactElement`

Returns the wrapper's underlying node.


#### Returns

`ReactElement`: The retrieved node.



#### Examples

```jsx
class Test extends React.Component {
render() {
return (
<div>
<span />
<span />
</div>
);
}
}

const wrapper = mount(<Test />);
expect(wrapper.getNode()).to.be.an.instanceof(Test);
```



#### Related Methods

- [`.getNodes() => Array<ReactElement>`](getNodes.md)
34 changes: 34 additions & 0 deletions docs/api/ReactWrapper/getNodes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
# `.getNodes() => Array<ReactElement>`

Returns the wrapper's underlying nodes.


#### Returns

`Array<ReactElement>`: The retrieved nodes.



#### Examples

```jsx
class Test extends React.Component {
render() {
return (
<div>
<span />
<span />
</div>
);
}
}

const wrapper = mount(<Test />);
expect(wrapper.find('span').getNodes()).to.have.lengthOf(2);
```



#### Related Methods

- [`.getNode() => ReactElement`](getNode.md)
38 changes: 38 additions & 0 deletions docs/api/ShallowWrapper/getNode.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,38 @@
# `.getNode() => ReactElement`

Returns the wrapper's underlying node.

If the current wrapper is wrapping the root component, returns the root component's latest render output.


#### Returns

`ReactElement`: The retrieved node.



#### Examples

```jsx
const element = (
<div>
<span />
<span />
</div>
);

class MyComponent extends React.Component {
render() {
return element;
}
}

const wrapper = shallow(<MyComponent />);
expect(wrapper.getNode()).to.equal(element);
```



#### Related Methods

- [`.getNodes() => Array<ReactElement>`](getNodes.md)
39 changes: 39 additions & 0 deletions docs/api/ShallowWrapper/getNodes.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,39 @@
# `.getNodes() => Array<ReactElement>`

Returns the wrapper's underlying nodes.

If the current wrapper is wrapping the root component, returns the root component's latest render output wrapped in an array.


#### Returns

`Array<ReactElement>`: The retrieved nodes.



#### Examples

```jsx
const one = <span />;
const two = <span />;

class Test extends React.Component {
render() {
return (
<div>
{ one }
{ two }
</div>
);
}
}

const wrapper = shallow(<Test />);
expect(wrapper.find('span').getNodes()).to.deep.equal([one, two]);
```



#### Related Methods

- [`.getNode() => ReactElement`](getNode.md)
6 changes: 6 additions & 0 deletions docs/api/mount.md
Original file line number Diff line number Diff line change
Expand Up @@ -125,6 +125,12 @@ Returns a static HTML rendering of the current node.
#### [`.get(index) => ReactElement`](ReactWrapper/get.md)
Returns the node at the provided index of the current wrapper.

#### [`.getNode() => ReactElement`](ReactWrapper/getNode.md)
Returns the wrapper's underlying node.

#### [`.getNodes() => Array<ReactElement>`](ReactWrapper/getNodes.md)
Returns the wrapper's underlying nodes.

#### [`.getDOMNode() => DOMComponent`](ReactWrapper/getDOMNode.md)
Returns the outer most DOMComponent of the current wrapper.

Expand Down
6 changes: 6 additions & 0 deletions docs/api/shallow.md
Original file line number Diff line number Diff line change
Expand Up @@ -133,6 +133,12 @@ Returns a static HTML rendering of the current node.
#### [`.get(index) => ReactElement`](ShallowWrapper/get.md)
Returns the node at the provided index of the current wrapper.

#### [`.getNode() => ReactElement`](ShallowWrapper/getNode.md)
Returns the wrapper's underlying node.

#### [`.getNodes() => Array<ReactElement>`](ShallowWrapper/getNodes.md)
Returns the wrapper's underlying nodes.

#### [`.at(index) => ShallowWrapper`](ShallowWrapper/at.md)
Returns a wrapper of the node at the provided index of the current wrapper.

Expand Down

0 comments on commit d42527e

Please sign in to comment.