Basic React Hooks support (useImperativeHandle only) #454
Conversation
Add detection of `useImperativeHandle()`-defined methods on components, including test cases and README documentation. Signed-off-by: Jared Reisinger <jaredreisinger@hotmail.com>
Signed-off-by: Jared Reisinger <jaredreisinger@hotmail.com>
|
@danez, has react-docgen gone into maintenance mode? I know that for the most part, there's not a lot to do since Javascript hasn't changed that much. That said, React added hooks in 16.8.0 (February 6, 2019), 19 months ago, so adding support for this isn't exactly "cutting edge" at this point. I've tried to make sure the proposed change is well documented and tested... is there anything else I can do to make it easier or less-risky to merge? |
|
|
||
| If you are using React Hooks, react-docgen will now also find component methods defined directly via the `useImperativeHandle()` hook. | ||
|
|
||
| > **Note**: react-docgen will not be able to grab the type definition if the type is imported or declared in a different file. |
There was a problem hiding this comment.
Do you think this could work with the work that has been done in #464?
There was a problem hiding this comment.
I don't know.... I'll take a look at #464 and try to understand what it's doing. At first blush, it seems like yes, this might exactly solve that problem, I'll just need to understand what changes I'll need to make to use the new functionality (or whether things have changed in such a way that I don't have to do anything, and just get the new behavior for free 🤞 ).
Add detection of
useImperativeHandle()-defined methods on components, including test cases and README documentation.Note that this does not address the desire to document custom hooks, nor does it find
useCallback()handlers as those aren't exposed in an imperative way and thus shouldn't be considered a part of a component's public API.