Skip to content

Commit 5f0d7ca

Browse files
Added .ref(refName) documentation
1 parent eecf68c commit 5f0d7ca

File tree

2 files changed

+32
-0
lines changed

2 files changed

+32
-0
lines changed

docs/README.md

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,7 @@
8282
* [someWhere(predicate)](/docs/api/ReactWrapper/someWhere.md)
8383
* [every(selector)](/docs/api/ReactWrapper/every.md)
8484
* [everyWhere(selector)](/docs/api/ReactWrapper/everyWhere.md)
85+
* [ref(refName)](/docs/api/ReactWrapper/ref.md)
8586
* [Static Rendering](/docs/api/render.md)
8687
* [Selectors](/docs/api/selector.md)
8788
* [Change Log](/CHANGELOG.md)

docs/api/ReactWrapper/ref.md

Lines changed: 31 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,31 @@
1+
# `.ref(refName) => Any`
2+
3+
Returns a wrapper of the node that matches the provided reference name.
4+
5+
6+
NOTE: can only be called on a wrapper instance that is also the root instance.
7+
8+
#### Arguments
9+
10+
1. `refName` (`String`): The ref attribute of the node
11+
12+
13+
#### Returns
14+
15+
`ReactWrapper`: A wrapper of the node that matches the provided reference name.
16+
17+
18+
19+
#### Example
20+
21+
22+
```jsx
23+
const wrapper = mount(<MyComponent foo={10} />);
24+
expect(wrapper.prop('foo')).to.equal(10);
25+
```
26+
27+
28+
#### Related Methods
29+
30+
- [`.props() => Object`](props.md)
31+
- [`.state([key]) => Any`](state.md)

0 commit comments

Comments
 (0)