[Docs] mount: ref: Update docs to be consistent with v3

enzymejs · Oct 9, 2017 · 4553bb7 · 4553bb7
1 parent 5be7999
commit 4553bb7
Show file tree

Hide file tree

Showing 2 changed files with 7 additions and 8 deletions.
diff --git a/docs/api/ReactWrapper/ref.md b/docs/api/ReactWrapper/ref.md
@@ -1,6 +1,6 @@
-# `.ref(refName) => ReactWrapper`
+# `.ref(refName) => ReactComponent | HTMLElement`
 
-Returns a wrapper of the node that matches the provided reference name.
+Returns the node that matches the provided reference name.
 
 
 NOTE: can only be called on a wrapper instance that is also the root instance.
@@ -12,7 +12,7 @@ NOTE: can only be called on a wrapper instance that is also the root instance.
 
 #### Returns
 
-`ReactWrapper`: A wrapper of the node that matches the provided reference name.
+`ReactComponent | HTMLElement`: The node that matches the provided reference name. This can be a react component instance, or an HTML element instance.
 
 
 
@@ -35,8 +35,7 @@ class Foo extends React.Component {
 
 ```jsx
 const wrapper = mount(<Foo />);
-expect(wrapper.ref('secondRef').prop('amount')).to.equal(4);
-expect(wrapper.ref('secondRef').text()).to.equal('Second');
+expect(wrapper.ref('secondRef').innerText).to.equal('Second');
 ```
 
 

diff --git a/packages/enzyme/src/ReactWrapper.js b/packages/enzyme/src/ReactWrapper.js
@@ -176,13 +176,13 @@ class ReactWrapper {
   }
 
   /**
-   * If the root component contained a ref, you can access it here
-   * and get a wrapper around it.
+   * If the root component contained a ref, you can access it here and get the relevant
+   * react component instance or HTML element instance.
    *
    * NOTE: can only be called on a wrapper instance that is also the root instance.
    *
    * @param {String} refname
-   * @returns {ReactWrapper}
+   * @returns {ReactComponent | HTMLElement}
    */
   ref(refname) {
     if (this[ROOT] !== this) {