Fix propTypes in addon-background #2279
Conversation
| @@ -118,7 +117,11 @@ BackgroundPanel.propTypes = { | |||
| getQueryParam: PropTypes.func, | |||
| setQueryParams: PropTypes.func, | |||
| }).isRequired, | |||
| channel: PropTypes.instanceOf(EventEmitter), | |||
| channel: PropTypes.shape({ | |||
| emit: PropTypes.func, | |||
There was a problem hiding this comment.
shouldn't all of these be required if the channel is supplied? should the channel be required as well?
There was a problem hiding this comment.
We have a defaultProp for channel, so it shouldn't be marked as required. As for particular shape, I basically just copypasted it from addons/knobs (and it's the same as in addons/events)
There was a problem hiding this comment.
Ideally, we should have this propTypes shape exported in @storybook/addons and use it elsewhere. There is a couple of places with this line, which can be replaced with the shape as well:
channel: PropTypes.object, // eslint-disable-line react/forbid-prop-types
You can open a PR with such a refactoring if you feel like it =)
Codecov Report
@@ Coverage Diff @@
## master #2279 +/- ##
=======================================
Coverage 22.14% 22.14%
=======================================
Files 268 268
Lines 5893 5893
Branches 703 703
=======================================
Hits 1305 1305
Misses 4068 4068
Partials 520 520
Continue to review full report at Codecov.
|
See #2220 (comment)