reactjs / reactjs/react-docgen
TS forwardRef support
Open
Nobody has claimed this yet.
new feature
typescript
- Dominant language
- TypeScript
- Stars
- 3.8k
- Forks
- 316
- Avg merge
- 5h 7m
- Merged PRs (30d)
- 4
Description
The following input:
import React, { forwardRef } from 'react';
interface ButtonProps {
variant?: 'small' | 'large';
disabled?: boolean;
children: React.ReactNode;
}
export const Button = forwardRef<HTMLButtonElement, ButtonProps>(function Button(
{ disabled = false, variant = 'small', children },
ref
) {
return (
<button type="button" disabled={disabled} ref={ref}>
{children} {variant}
</button>
);
});
Produces:
{}
It's come up several times in Storybook: https://github.com/storybookjs/storybook/issues/8894 and https://github.com/storybookjs/storybook/issues/9511
Filed from https://github.com/storybookjs/storybook/pull/24165
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Read the provided TypeScript/React forwardRef reproduction first and trace the parser entry point that turns it into {}. Compare the related Storybook reports for expected behavior; done means this input is recognized rather than producing {}, with a regression test covering the result.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- react, typescript
- Domain
- tooling
- Issue type
- Feature
- Difficulty
- 4/5
- Estimated time
- 3-5 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 35/100