[Docs] shallow/mount: fix examples, and make them consistent

enzymejs · Sep 20, 2020 · bdb618e · bdb618e
1 parent a3705cf
commit bdb618e
Show file tree

Hide file tree

Showing 13 changed files with 27 additions and 19 deletions.
diff --git a/docs/api/ReactWrapper/equals.md b/docs/api/ReactWrapper/equals.md
@@ -21,7 +21,11 @@ like the one passed in.
 
 
 ```jsx
-const wrapper = mount(<MyComponent />);
+function MyComponent() {
+  return <div className="foo bar" />;
+}
+
+const wrapper = mount(<MyComponent />).childAt(0);
 expect(wrapper.equals(<div className="foo bar" />)).to.equal(true);
 ```
 

diff --git a/docs/api/ReactWrapper/every.md b/docs/api/ReactWrapper/every.md
@@ -33,5 +33,4 @@ expect(wrapper.find('.foo').every('.bar')).to.equal(false);
 #### Related Methods
 
 - [`.someWhere(predicate) => Boolean`](someWhere.md)
-- [`.every(selector) => Boolean`](every.md)
 - [`.everyWhere(predicate) => Boolean`](everyWhere.md)
diff --git a/docs/api/ReactWrapper/everyWhere.md b/docs/api/ReactWrapper/everyWhere.md
@@ -35,4 +35,4 @@ expect(wrapper.find('.foo').everyWhere((n) => n.hasClass('bar'))).to.equal(false
 
 - [`.some(selector) => Boolean`](some.md)
 - [`.every(selector) => Boolean`](every.md)
-- [`.everyWhere(predicate) => Boolean`](everyWhere.md)
+
diff --git a/docs/api/ReactWrapper/first.md b/docs/api/ReactWrapper/first.md
@@ -18,5 +18,5 @@ expect(wrapper.find(Foo).first().props().foo).to.equal('bar');
 
 #### Related Methods
 
-- [`.at(index) => ReactWrapper`](at.md) - retrieve any wrapper node
+- [`.at(index) => ReactWrapper`](at.md) - retrieve a wrapper node at given index
 - [`.last() => ReactWrapper`](last.md)
diff --git a/docs/api/ReactWrapper/instance.md b/docs/api/ReactWrapper/instance.md
@@ -27,14 +27,14 @@ class Stateful extends React.Component {
 
 #### React 16.x
 ```jsx
-test('shallow wrapper instance should be null', () => {
+test('mount wrapper instance should be null', () => {
   const wrapper = mount(<Stateless />);
   const instance = wrapper.instance();
 
   expect(instance).to.equal(null);
 });
 
-test('shallow wrapper instance should not be null', () => {
+test('mount wrapper instance should not be null', () => {
   const wrapper = mount(<Stateful />);
   const instance = wrapper.instance();
 
@@ -44,14 +44,14 @@ test('shallow wrapper instance should not be null', () => {
 
 #### React 15.x
 ```jsx
-test('shallow wrapper instance should not be null', () => {
+test('mount wrapper instance should not be null', () => {
   const wrapper = mount(<Stateless />);
   const instance = wrapper.instance();
 
   expect(instance).to.be.instanceOf(Stateless);
 });
 
-test('shallow wrapper instance should not be null', () => {
+test('mount wrapper instance should not be null', () => {
   const wrapper = mount(<Stateful />);
   const instance = wrapper.instance();
 

diff --git a/docs/api/ReactWrapper/matchesElement.md b/docs/api/ReactWrapper/matchesElement.md
@@ -40,7 +40,7 @@ class MyComponent extends React.Component {
   }
 }
 
-const wrapper = mount(<MyComponent />);
+const wrapper = mount(<MyComponent />).childAt(0);
 expect(wrapper.matchesElement(<button>Hello</button>)).to.equal(true);
 expect(wrapper.matchesElement(<button className="foo bar">Hello</button>)).to.equal(true);
 ```

diff --git a/docs/api/ReactWrapper/render.md b/docs/api/ReactWrapper/render.md
@@ -29,5 +29,6 @@ function Bar() {
 
 ```jsx
 const wrapper = mount(<Bar />);
-expect(wrapper.find(Foo).render().find('.in-foo')).to.have.lengthOf(1);
+expect(wrapper.find('.in-foo')).to.have.lengthOf(1);
+expect(wrapper.render().find('.in-foo')).to.have.lengthOf(1);
 ```
diff --git a/docs/api/ReactWrapper/simulate.md b/docs/api/ReactWrapper/simulate.md
@@ -71,12 +71,12 @@ const wrapper = mount((
   />
 ));
 
-expect(wrapper.find('input').at(0).prop('value')).toEqual(10);
-expect(wrapper.find('input').at(1).prop('value')).toEqual(20);
+expect(wrapper.find('input').at(0).props().value).to.equal(10);
+expect(wrapper.find('input').at(1).props().value).to.equal(20);
 wrapper.find('input').at(0).simulate('change', { target: { name: 'width', value: 50 } });
 wrapper.find('input').at(1).simulate('change', { target: { name: 'height', value: 70 } });
-expect(testState.width).toEqual(50);
-expect(testState.height).toEqual(70);
+expect(testState.width).to.equal(50);
+expect(testState.height).to.equal(70);
 ```
 
 #### Common Gotchas

diff --git a/docs/api/ReactWrapper/type.md b/docs/api/ReactWrapper/type.md
@@ -17,7 +17,7 @@ If it's `null`, it will be `null`. It must be a single-node wrapper.
 function Foo() {
   return <div />;
 }
-const wrapper = mount(<Foo />);
+const wrapper = mount(<Foo />).childAt(0);
 expect(wrapper.type()).to.equal('div');
 ```
 
@@ -38,7 +38,8 @@ function Foo() {
   return <Bar />;
 }
 const wrapper = mount(<Foo />);
-expect(wrapper.type()).to.equal(Bar);
+expect(wrapper.type()).to.equal(Foo);
+expect(wrapper.childAt(0).type()).to.equal(Bar);
 ```
 
 ```jsx

diff --git a/docs/api/ShallowWrapper/equals.md b/docs/api/ShallowWrapper/equals.md
@@ -21,6 +21,10 @@ like the one passed in.
 
 
 ```jsx
+function MyComponent() {
+  return <div className="foo bar" />;
+}
+
 const wrapper = shallow(<MyComponent />);
 expect(wrapper.equals(<div className="foo bar" />)).to.equal(true);
 ```

diff --git a/docs/api/ShallowWrapper/every.md b/docs/api/ShallowWrapper/every.md
@@ -33,5 +33,4 @@ expect(wrapper.find('.foo').every('.bar')).to.equal(false);
 #### Related Methods
 
 - [`.someWhere(predicate) => Boolean`](someWhere.md)
-- [`.every(selector) => Boolean`](every.md)
 - [`.everyWhere(predicate) => Boolean`](everyWhere.md)
diff --git a/docs/api/ShallowWrapper/first.md b/docs/api/ShallowWrapper/first.md
@@ -18,5 +18,5 @@ expect(wrapper.find(Foo).first().props().foo).to.equal('bar');
 
 #### Related Methods
 
-- [`.at(index) => ShallowWrapper`](at.md) - retrieve any wrapper node
+- [`.at(index) => ShallowWrapper`](at.md) - retrieve a wrapper node at given index
 - [`.last() => ShallowWrapper`](last.md)
diff --git a/docs/api/ShallowWrapper/render.md b/docs/api/ShallowWrapper/render.md
@@ -30,5 +30,5 @@ function Bar() {
 ```jsx
 const wrapper = shallow(<Bar />);
 expect(wrapper.find('.in-foo')).to.have.lengthOf(0);
-expect(wrapper.find(Foo).render().find('.in-foo')).to.have.lengthOf(1);
+expect(wrapper.render().find('.in-foo')).to.have.lengthOf(1);
 ```