Adds react-docgen-displayname-handler #205
Conversation
| Array of functions used to process the discovered components and generate documentation objects. Default behaviours include discovering component documentation blocks, prop types, and defaults. If setting this property, it is best to build from the default `react-docgen` handler list, such as in the example below. See the [react-docgen handler documentation](https://github.com/reactjs/react-docgen#handlers) for more information about handlers. | ||
|
|
||
| > NOTE: By default, `react-docgen-displayname-handler` is included which provides better support for Higher Order Components. If you'd like to add additional handlers, be sure to _add_ to the Array rather than replace entirely. |
There was a problem hiding this comment.
Now that I think about it, this isn't actually possible because we don't provide a "callback" per-say, we just take their config.handlers value.
Hm... any thoughts on how we should handle this?
There was a problem hiding this comment.
Not sure I even understand this part: “be sure to add to the Array rather than replace entirely”. You mean to copy default list and add your own stuff?
There was a problem hiding this comment.
copy default list and add your own stuff
Right, but I think there's no real way to copy the default list, right? I mean at runtime at least, sure you can look at the source and reproduce the list but that's an implementation detail that the user would have to worry about/figure out.
What do you suggest here?
There was a problem hiding this comment.
I’d suggest to give an example of overriding handlers array that will include react-docgen-displayname-handler so people could just copy it and change whatever they want. Instead of this note paragraph.
There was a problem hiding this comment.
Good idea! I've added that.
|
And I agree that making it default handler is a good idea. More flexibility for us, if we ever decide to add more default handlers, and for the users, who could customize handlers as they want. |
* master: Update react-docgen. Update lint. Fix lint warning. Fix regression: colors in props table. Refactoring: simplify PropsRenderer a bit (#206) # Conflicts: # package.json
|
Not sure why the build is failing, looks unrelated to code changes. 🤔 |
|
Have no idea. Looks like some issues with npm. |
|
Works fine with Webpack 1.13.3, please merge master into your branch. |
* master: Update Webpack.
|
@sapegin build seems to be passing now |
|
Cool, thanks! |
We still need react-docgen default handlers, not just displayName handler 🚑
|
I put the handlers code in my config and I'm now getting a |
Fixes #202
This adds
react-docgen-displayname-handlerto the defaulthandlers[]config. I wasn't sure whether to include it in the default config or forcibly add it where it's used inprops.loader.js. I opted to include it into the configuration to make it more extensible in userland. Feedback welcome!This also adds a
<WrappedButton />example which shows off HoC support.