[Docs] Update docs around SFC instances in React 16 #1243
Conversation
docs/api/ShallowWrapper/instance.md
Outdated
| @@ -2,20 +2,62 @@ | |||
|
|
|||
| Gets the instance of the component being rendered as the root node passed into `shallow()`. | |||
|
|
|||
| NOTE: can only be called on a wrapper instance that is also the root instance. | |||
| NOTE: can only be called on a wrapper instance that is also the root instance. With React `16.x.x`, `instance()` returns `null` for stateless React component. See example. | |||
There was a problem hiding this comment.
s/stateless React component/stateless functional components, s/example./example:
docs/api/ShallowWrapper/instance.md
Outdated
|
|
||
| #### Returns (React 16.x.x) |
There was a problem hiding this comment.
I don't think we need the .x.x anywhere; 16.x should be sufficient (same throughout)
docs/api/ShallowWrapper/instance.md
Outdated
|
|
||
| - `ReactComponent`: The Statefull React component instance. |
|
@ljharb PR was updated. Please let me know in case of mismatches. |
docs/api/ShallowWrapper/instance.md
Outdated
|
|
||
| expect(instance).not.toBe(null); // This will fail, because instance is null |
There was a problem hiding this comment.
this seems to be jest matcher syntax; we use chai's expect. could you update it to be expect(instance).not.to.equal(null) instead? (same throughout)
There was a problem hiding this comment.
Will change.
docs/api/ShallowWrapper/instance.md
Outdated
| const wrapper = shallow(<Stateful />); | ||
| const instance = wrapper.instance(); | ||
|
|
||
| expect(instance).not.toBe(null); // This will pass |
There was a problem hiding this comment.
let's preserve the original assertion here too: expect(inst).to.be.instanceOf(MyComponent);
There was a problem hiding this comment.
From an original example it's not clear (as for me) what is <MyComponent />. I mean, is it stateful or stateless. And whole purpose of this update is to show this specific case.
There was a problem hiding this comment.
It's fine to show "null or not null"; I'm asking not to delete the "instance of MyComponent" checks.
There was a problem hiding this comment.
Sorry, I did not catch it.
|
@ljharb PR was updated. |
docs/api/ShallowWrapper/instance.md
Outdated
|
|
||
| expect(instance).not.to.equal(null); // This will pass |
There was a problem hiding this comment.
Please add here expect(instance).to.be.instanceOf(Stateful); as well
docs/api/ShallowWrapper/instance.md
Outdated
| const wrapper = shallow(<Stateless />); | ||
| const instance = wrapper.instance(); | ||
|
|
||
| expect(instance).not.to.equal(null); // This will pass |
There was a problem hiding this comment.
Please add here expect(instance).to.be.instanceOf(Stateless); as well
docs/api/ShallowWrapper/instance.md
Outdated
| const wrapper = shallow(<Stateful />); | ||
| const instance = wrapper.instance(); | ||
|
|
||
| expect(instance).not.to.equal(null); // This will pass |
There was a problem hiding this comment.
Please add here expect(instance).to.be.instanceOf(Stateful); as well
docs/api/ShallowWrapper/instance.md
Outdated
|
|
||
| expect(instance).not.to.equal(null); // This will fail, because instance is null |
There was a problem hiding this comment.
Please add here expect(instance).not.to.be.instanceOf(Stateless); as well
|
Is this something we can merge master into and get approved? Was quite helpful for me and was annoying to have to dig through PRs to find it. |
ljharb
changed the title
.instance() method
Related to #1232