Does not work with forwardRef

[LankyLou]

When using React.forwardRef, the proptypes are not generated.

[milesj]

@LankyLou Are you doing something like this?

const Comp = React.forwardRef();

Comp.propTypes = {};

[milesj]

@LankyLou Bump.

[vdh]

I'm doing something like this:

const Comp = forwardRef((props, ref) => { /* … */ });
Comp.displayName = "Comp";
Comp.defaultProps = { /* … */ };
export default Comp;

[milesj]

I'm not sure how to support this properly since half the time there isn't any type information for the props, for example.

const RefComp = React.forwardRef((props, ref) => <OtherComp ref={ref} {...props} />);

The types are usually defined on OtherComp, which can be located anywhere. This seems like a feature that'll require the type checker.

[vdh]

@milesj Is there a way to hint the proper type for the props so that the plugin can manually generate prop types for situations like this? Something like:

type CompProps = { foo: string };
const Comp = forwardRef<HTMLDivElement, CompProps>((props, ref) => { /* … */ });
/* babel-plugin-typescript-to-proptypes ["Comp", "CompProps"] */
Comp.displayName = "Comp";
Comp.defaultProps = { /* … */ };
export default Comp;

So the plugin can skip attempts at finding the Comp component and CompProps type, and just output something like Comp.propTypes = { foo: PropTypes.string };?

[vdh]

P.S. Sorry I forgot to write that earlier example as Typescript

[milesj]

@vdh Yeah, that's about the only solution at the moment.

[milesj]

This should work now.

[LankyLou]

@milesj Thanks for this, it works great for me now

[sageknives]

@milesj Is there a way to hint the proper type for the props so that the plugin can manually generate prop types for situations like this? Something like:

type CompProps = { foo: string };
const Comp = forwardRef<HTMLDivElement, CompProps>((props, ref) => { /* … */ });
/* babel-plugin-typescript-to-proptypes ["Comp", "CompProps"] */
Comp.displayName = "Comp";
Comp.defaultProps = { /* … */ };
export default Comp;

So the plugin can skip attempts at finding the Comp component and CompProps type, and just output something like Comp.propTypes = { foo: PropTypes.string };?

I can't seem to get this to work with forwardRef. Is there a specific line i need to add? I noticed in your tests you named the type RefProps, which didn't seem to work. /* babel-plugin-typescript-to-proptypes ["Comp", "CompProps"] */ is this needed? are defaultProps needed? Is there an example somewhere of how to write forwardRef with typescript to get the proptypes to work?

[milesj]

You type the generics like this: https://github.com/milesj/babel-plugin-typescript-to-proptypes/blob/master/tests/fixtures/memo-ref-components.tsx#L12

Your types must be in the same file.

[sageknives]

Thanks, that helped!